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

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

Merged
merged 1 commit into from
Jul 24, 2024

Conversation

xmnlab
Copy link
Member

@xmnlab xmnlab commented Jul 24, 2024

Pull Request description

How to test these changes

  • ...

Pull Request checklists

This PR is a:

  • bug-fix
  • new feature
  • maintenance

About this PR:

  • it includes tests.
  • the tests are executed on CI.
  • the tests generate log file(s) (path).
  • pre-commit hooks were executed locally.
  • this PR requires a project documentation update.

Author's checklist:

  • I have reviewed the changes and it contains no misspelling.
  • The code is well commented, especially in the parts that contain more
    complexity.
  • New and old tests passed locally.

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 xmnlab changed the title feat(help): Organize tasks by group inside the help menu feat(help): Organize tasks by groups inside the help menu Jul 24, 2024
@xmnlab
Copy link
Member Author

xmnlab commented Jul 24, 2024

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                         │
╰──────────────────────────────────────────────────────────────────────────────╯
                                                                                

@xmnlab xmnlab merged commit 2cd746c into osl-incubator:main Jul 24, 2024
14 checks passed
@xmnlab xmnlab deleted the improve-help-options branch July 24, 2024 02:12
Copy link

🎉 This issue has been resolved in version 1.16.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

1 participant