gruntwork-io / gruntwork-io/pre-commit

Documentation for shellcheck should include that it is configurable with a .shellcheckrc

Open
#79 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Shell
Stars
547
Forks
168
PR merge metrics
No merged PRs in 30d

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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.