osl-incubator / makim

Make Improved
https://osl-incubator.github.io/makim/
BSD 3-Clause "New" or "Revised" License
8 stars 10 forks source link

feat(help): Organize tasks by groups inside the help menu #109

Closed xmnlab closed 1 month ago

xmnlab commented 1 month ago

Pull Request description

How to test these changes

Pull Request checklists

This PR is a:

About this PR:

Author's checklist:

Additional information

Reviewer's checklist

Copy and paste this template for your review's note:

## Reviewer's Checklist

- [ ] I managed to reproduce the problem locally from the `main` branch
- [ ] I managed to test the new changes locally
- [ ] I confirm that the issues mentioned were fixed/resolved .
xmnlab commented 1 month ago

output example:

Makim file: .makim.yaml

 Usage: makim [OPTIONS] COMMAND [ARGS]...                                       

 Makim is a tool that helps you to organize and simplify your helper commands.  

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --version             -v            Show the version and exit                │
│ --file                        TEXT  Makim config file [default: .makim.yaml] │
│ --dry-run                           Execute the command in dry mode          │
│ --verbose                           Execute the command in verbose mode      │
│ --install-completion                Install completion for the current       │
│                                     shell.                                   │
│ --show-completion                   Show completion for the current shell,   │
│                                     to copy it or customize the              │
│                                     installation.                            │
│ --help                              Show this message and exit.              │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ global-scope ───────────────────────────────────────────────────────────────╮
│ global-scope.test-var-env        Test env variable defined in the global     │
│                                  scope in `env` section                      │
│ global-scope.test-var-env-file   Test env variable defined in the global     │
│                                  scope from env-file                         │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ group-scope ────────────────────────────────────────────────────────────────╮
│ group-scope.test-var-env         Test env variable defined in the global     │
│                                  scope in `env` section                      │
│ group-scope.test-var-env-file    Test env variable defined in the global     │
│                                  scope from env-file                         │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ rerender-env ───────────────────────────────────────────────────────────────╮
│ rerender-env.dep                 dummy dep                                   │
│ rerender-env.from-global         Test a rerender from the global scope       │
│ rerender-env.from-group          Test a rerender from the group scope        │
│ rerender-env.from-task           Test a rerender from the group scope        │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ task-scope ─────────────────────────────────────────────────────────────────╮
│ task-scope.test-var-env          Test env variable defined in the global     │
│                                  scope in `env` section                      │
│ task-scope.test-var-env-file     Test env variable defined in the global     │
│                                  scope from env-file                         │
╰──────────────────────────────────────────────────────────────────────────────╯
github-actions[bot] commented 1 month ago

:tada: This issue has been resolved in version 1.16.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: