Conform more to command line standards
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 8.3k
- Forks
- 836
- Avg merge
- 5d 3h
- Merged PRs (30d)
- 1
Description
Is your feature request related to a problem? Please describe.
A nicely written standard around command lines is available.. Bandit should strive to conform to these standards where possible.
For more info, see: https://clig.dev/
TODOs:
- Display help text when passed no options, the -h flag, or the --help flag. #814
- Display a concise help text by default.
- Provide a support path for feedback and issues. A website or GitHub link in the top-level help text is common.
- In help text, link to the web version of the documentation.
- In help, Lead with examples.
- Display the most common flags and commands at the start of the help text.
- Use formatting in your help text.
- If the user did something wrong and you can guess what they meant, suggest it.
- Display output as formatted JSON if --json is passed.
- Disable color if your program is not in a terminal or the user requested it. The NO_COLOR environment variable is set, the TERM environment variable has the value dumb, the user passes the option --no-color. #813
- Use a pager (e.g. less) if you are outputting a lot of text.
- Make it effortless to submit bug reports.
- Use standard names for flags, if there is a standard.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at Bandit’s command-line entry point and inspect the existing help, output, and flag handling against the linked clig.dev guidance. Choose one unchecked TODO with a defined scope, then verify that the corresponding CLI behavior and help text meet that item.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100