Config file location

[pa-0]

Hi, I'm looking for clarification after consulting shellcheck's man:

1. Will shellcheck find a config file if it's located at $XDG_CONFIG_HOME/shellcheck/shellcheckrc?
2. Are the paths that are searched hardcoded? In other words, will it use the value assigned to XDG_CONFIG_HOME if set?

Thanks

[brother]

The man states

Unless --norc is used, ShellCheck will look for a file .shellcheckrc
or shellcheckrc in the script's directory and each parent directory.
...
If no .shellcheckrc is found in any of the parent directories, ShellCheck
will look in ~/.shellcheckrc followed by the XDG config directory
(usually ~/.config/shellcheckrc) on Unix, or %APPDATA%/shellcheckrc on
Windows. Only the first file found will be used.

To answer the questions then:

1. Will shellcheck find a config file if it's located at $XDG_CONFIG_HOME/shellcheck/shellcheckrc?

No it will not find that file. If you can place it in $XDG_CONFIG_HOME/.shellcheckrc it should work, but that does not seem to be the case... see below.

(Please also note the special care needed by people using snaps and docker and such, it's in the man file as well.)

brother /tmp$ cat $XDG_CONFIG_HOME/shellcheck/shellcheckrc
enable=require-double-brackets
brother /tmp$ shellcheck test.sh

In test.sh line 3:
if [ $1 ]; then
     ^-- SC2086 (info): Double quote to prevent globbing and word splitting.

Did you mean: 
if [ "$1" ]; then

For more information:
  https://www.shellcheck.net/wiki/SC2086 -- Double quote to prevent globbing ...
brother /tmp$ mv $XDG_CONFIG_HOME/shellcheck/shellcheckrc $XDG_CONFIG_HOME/.shellcheckrc
brother /tmp$ shellcheck test.sh

In test.sh line 3:
if [ $1 ]; then
     ^-- SC2086 (info): Double quote to prevent globbing and word splitting.

Did you mean: 
if [ "$1" ]; then

For more information:
  https://www.shellcheck.net/wiki/SC2086 -- Double quote to prevent globbing ...
brother /tmp$ shellcheck --rcfile=$XDG_CONFIG_HOME/.shellcheckrc test.sh 

In test.sh line 3:
if [ $1 ]; then
   ^----^ SC2292 (style): Prefer [[ ]] over [ ] for tests in Bash/Ksh.
     ^-- SC2086 (info): Double quote to prevent globbing and word splitting.

Did you mean: 
if [[ "$1" ]]; then

For more information:
  https://www.shellcheck.net/wiki/SC2086 -- Double quote to prevent globbing ...
  https://www.shellcheck.net/wiki/SC2292 -- Prefer [[ ]] over [ ] for tests i...

If no mistakes can be pointed out here I think this should be treated as a bug, at least between documentation and behavior =)

2. Are the paths that are searched hardcoded? In other words, will it use the value assigned to XDG_CONFIG_HOME if set?

It is supposed to respect the environment set.