Documentation for shellcheck should include that it is configurable with a .shellcheckrc
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- shell
- Domain
- documentation
Research direction
Update README.md where shellcheck configuration and the --enable flag are described. Clarify that a .shellcheckrc can configure additional entries, including disable entries, and verify the wording accurately reflects the supported configuration options.
Written by the indexing model from the issue text.
Description
Describe the solution you'd like
A simple README.md update is needed to clarify that in addition to the --enable flag, the .shellcheckrc can be used to configure additional entries.
Describe alternatives you've considered
Linking directly to the shellcheck documentation
Additional context
Allow for passing cli args directly through to shellcheck
Other shellcheck flags can not be passed through.
Which is true, but is misleading to those looking for an option to set disable entries.
- Dominant language
- Shell
- Stars
- 547
- Forks
- 168
- PR merge metrics
- No merged PRs in 30d
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.
More from gruntwork-io/pre-commit
-
enhancement
gruntwork-io/pre-commit#138 · 3 reactions · 1 assignee ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 38/100
gruntwork-io/pre-commit#121 ·
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 35/100
gruntwork-io/pre-commit#111 · 1 reaction ·
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 45/100
gruntwork-io/pre-commit#110 ·
-
OpenTofu Support Openenhancement
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
gruntwork-io/pre-commit#108 · 1 comment · 2 reactions ·
All issues in gruntwork-io/pre-commit
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
danielmiessler/LifeOS#2218 ·
-
docs(agents): strengthen the no-backslash-escaped-backticks rule with an issue-creation example Open
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
package-update
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
oSoWoSo/vOid_Community_repOsitory#148 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
chore
Difficulty 1/5 Under an hour Newbie friendliness 91/100
alunduil/alunduil-chezmoi#792 ·