search

pstadler / flightplan

Run sequences of shell commands against local and remote hosts.
https://www.npmjs.com/package/flightplan
MIT License
1.82k stars 117 forks source link

Allow for task descriptions #146

Open martinpeck opened 7 years ago

martinpeck commented 7 years ago

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 commented 7 years ago

Pull requests are welcome.

martinpeck commented 7 years ago

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

martinpeck commented 7 years ago

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?