Skip to content

Show the script of a task in help dialog #52

@agilgur5

Description

@agilgur5

Some tasks are self-explanatory if you looked at their script and need no description. I also think knowing what script the task actually runs can be helpful context if only reading from the help dialog and not the maidfile itself.

For instance, I have a clean task that just runs rm -rf build/. If the help dialog outputted this, I wouldn't need to add a description, but since it doesn't I have to add the redundant description of "Cleans the build/ folder".
Tasks without a description also say "No description" instead of not showing anything (potentially a separate issue/PR to address)

nps's help dialog does output the actual script of the task. When no description is given, it will only show the script (never says "No description").

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions