Skip to content

Update documentation on default shellcheckrc paths #3528

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ralish wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update documentation on default shellcheckrc paths #3528

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions shellcheck.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,6 @@ not warn at all, as `ksh` supports decimals in arithmetic contexts.
read the list from standard input. This option is processed in addition to
any files specified on the command line.


# FORMATS

**tty**
Expand Down Expand Up @@ -191,7 +190,6 @@ not warn at all, as `ksh` supports decimals in arithmetic contexts.
&& echo -e 'Playlist $f contains a HQ file in mp3 format'
done


**json1**

: Json is a popular serialization format that is more suitable for web
Expand Down Expand Up @@ -222,7 +220,6 @@ not warn at all, as `ksh` supports decimals in arithmetic contexts.
: Suppress all normal output. Exit with zero if no issues are found,
otherwise exit with one. Stops processing after the first issue.


# DIRECTIVES

ShellCheck directives can be specified as comments in the shell script.
Expand Down Expand Up @@ -324,17 +321,21 @@ Here is an example `.shellcheckrc`:
disable=SC2236

If no `.shellcheckrc` is found in any of the parent directories, ShellCheck
will look in `~/.shellcheckrc` followed by the `$XDG_CONFIG_HOME`
(usually `~/.config/shellcheckrc`) on Unix, or `%APPDATA%/shellcheckrc` on
Windows. Only the first file found will be used.
checks the following additional paths and uses the first file found:

+ On Unix-like systems, checks for `~/.shellcheckrc` followed by
`$XDG_CONFIG_HOME/shellcheckrc` (no leading dot). If `$XDG_CONFIG_HOME` is
unset it defaults to `~/.config`.
+ On Windows systems, checks for `%APPDATA%\shellcheckrc` followed by
`%XDG_CONFIG_HOME%\shellcheckrc`. If `%XDG_CONFIG_HOME%` is unset it defaults
to `%APPDATA%`, making this path equal to the previous path and a no-op.

Note for Snap users: the Snap sandbox disallows access to hidden files.
Use `shellcheckrc` without the dot instead.

Note for Docker users: ShellCheck will only be able to look for files that
are mounted in the container, so `~/.shellcheckrc` will not be read.


# ENVIRONMENT VARIABLES

The environment variable `SHELLCHECK_OPTS` can be set with default flags:
Expand Down
Loading