[feature] Shell completion
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7k
- Forks
- 687
- Avg merge
- 4h 56m
- Merged PRs (30d)
- 2
Description
Is it possible that isort provide a tab completion for common shells like:
❯ isort -<TAB>
option
-a ADD_IMPORTS, --add-import ADD_IMPORTS
--ac Ensures the output doesn't save if the resulting file contains syntax errors.
--af Forces import adds even if the original file is empty.
--allow-root Tells isort not to treat / specially, allowing it to be run against the root dir.
--append Only adds the imports specified in --add-import if the file contains existing imports.
--append-only Only adds the imports specified in --add-import if the file contains existing imports.
--atomic Ensures the output doesn't save if the resulting file contains syntax errors.
...
Maybe shtab can be a possible solution?
- https://github.com/google/vimdoc/blob/823e3bbc1944d0377408b602ec10ba0c39a8bf8e/setup.py#L36
- https://github.com/andreafrancia/trash-cli/blob/b913bf30b277cecc04f27858d275802684ecac13/setup.cfg#L31-L33
- https://github.com/inducer/pudb/blob/1dea19a3a14ba2398e5b7909eb86cad0c0152b3d/setup.py#L24
- https://github.com/piccolomo/plotext/blob/f760510cc6957de82c57502c07e4d0c0e4762302/setup.py#L25
- https://github.com/wookayin/gpustat/blob/56a9dcf3c99f29065f1215afcff372d01da9f256/setup.py#L116
TIA!
Contributor guide
No contributing guide indexed for this repository
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 by reviewing isort's CLI entry point and the linked shtab examples to understand how completion scripts could be generated for common shells. Confirm which shells and packaging or installation path are in scope, then verify that pressing Tab after isort - exposes the available options.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, shell
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100