Confusing help text for `-g`/`--ignore-globs` option
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 1k
- Forks
- 131
- Avg merge
- 1m
- Merged PRs (30d)
- 1
Description
Describe the bug
Running devskim analyze --help produces this line:
-g, --ignore-globs (Default: /.git/ /bin/) Comma-separated Globs for files to skip analyzing
Notice, the text says "Comma-separated", but the default value is space-separated. So, which is it?
To Reproduce
Steps to reproduce the behavior:
- Run
devskim analyze --help - Scan the output for the line mentioned above.
Expected behavior
Displayed defaults/examples should be consistent with description text.
Screenshots
Versions(please complete the following information):
- OS: Windows 10 22H2 / 19045.3086
- Devskim Version 1.0.11+87ad45b866
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 by running devskim analyze --help and locate the help-text definition for -g/--ignore-globs. Check how the default globs and separator description are produced, make them consistent, and rerun the help command to verify the displayed line.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- cli, security
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100