Skip to content
This repository was archived by the owner on Aug 7, 2023. It is now read-only.

Commit 5b30302

Browse files
author
Ted Behling
committed
Update README to document additional config settings
1 parent 6bff3b8 commit 5b30302

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,17 @@ Run `which shellcheck` to find where it is installed on your system.
3434
* `userParameters`: Any additional executable parameters to pass to
3535
`shellcheck` when linting your files.
3636

37+
* `enableNotice`: Include lesser-importance ShellCheck messages
38+
(default: false).
39+
40+
* `useProjectCwd`: Controls whether the paths used by ShellCheck's
41+
[`source=`](https://github.com/koalaman/shellcheck/wiki/Directive#source)
42+
directive are relative to the project root or the file (default: false, for file-relative)
43+
* If true, ShellCheck's working directory
44+
will be the project's root directory. Any `source=` directives will be
45+
interpreted relative to the project root.
46+
* Otherwise, ShellCheck will run relative to the file's directory,
47+
making `source=` directives file-relative.
48+
3749
[linter]: https://github.com/atom-community/linter "Linter"
3850
[shellcheck]: https://github.com/koalaman/shellcheck "ShellCheck"

0 commit comments

Comments
 (0)