Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow for task descriptions #146

Open
martinpeck opened this issue Aug 11, 2016 · 3 comments
Open

Allow for task descriptions #146

martinpeck opened this issue Aug 11, 2016 · 3 comments

Comments

@martinpeck
Copy link

In a similar way to how rake allows desc statements to describe tasks, it would be great if flightplan supported some way to give description text when printing the results of fly --T.

This would allow task names to remain terse enough to be typed, while providing more information to those who are inspecting the list of tasks provided by a flightplan.js.

@pstadler
Copy link
Owner

Pull requests are welcome.

@martinpeck
Copy link
Author

Sure,. will take a look....do you have any pointers as to ways this might be integrated (or approaches to avoid)?

@martinpeck
Copy link
Author

Do you think that the description should be defined as another param passed to .local or .remote...

plan.local("task", "description of task", function(local) {
  /* noop */
});

... or, do you think that using a dictionary if you want to specify a name and a description is better...

plan.local({ name : "task", description : "description of task" }, function(local) {
    /* noop */
});

The dictionary would be easier to implement, and makes back compatibility easier. The code would inspect the first parameter, as it does today, but it would additionally compare it to a dictionary.

Thoughts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants