shellcheck source= directive is processed differently than shellcheck

[jakub-bochenski]

Shellcheck resolves source directive relative to the working directory that it was executed, no relative to the file, e.g.

src/
  - sourcing.sh
  - source.sh

If you run shellcheck from project root it expects the sourcing.sh file to have

  # shellcheck source=src/source.sh

BashSupport-Pro resolves the directive relative to the file it's in, so it expects:

  # shellcheck source=../src/source.sh

So either the directive will fail for CLI shellcheck or for the plugin.

I think it's reasonable for the plugin to assume that shellcheck would be run from project root.
An additional setting to override this might be useful.

$ shellcheck --version 
ShellCheck - shell script analysis tool
version: 0.9.0
license: GNU General Public License, version 3
website: https://www.shellcheck.net

[jansorg]

Thanks for reporting!

I agree that this isn't ideal.

Unfortunately, a project is ambiguous in the IntelliJ SDK, i.e. there's no guarantee that there's a single, unique content root path for a source file or project. ShellCheck is executed by the plugin with the working directory set to the script's parent directory.

ShellCheck supports # shellcheck source-path=SCRIPTDIR, https://github.com/koalaman/shellcheck/wiki/Directive#source-path

For now, this should for both CLI and BashSupport Pro:

# shellcheck source-path=SCRIPTDIR

 # shellcheck source=../src/source.sh
source "$MY_ROOT/source.sh"

To improve this, I'll probably have to

• support go to definition, completion, etc. for # shellcheck source=SCRIPTDIR/script.sh
• look first at the path defined by # shellcheck source-path=...
• with a new inspection, tell the user about a missing # shellcheck source-path=SCRIPTDIR.

But I'll still have to think more about this. BashSupport Pro should integrate with existing setups and not enforce changes.

Perhaps I should let the user override the working dir for ShellCheck for a project?

What do you think would be best for your setup?

[jakub-bochenski]

Oh, I missed that there is the SCRIPTDIR option.

It seems you can also add it to .shellcheckrc to get consistent behavior across files.

Using source-path=SCRIPTDIR in .shellcheckrc is perfectly fine for me.

Maybe as a quick-fix of sorts BashSupport-Pro could suggest creating/adding this line to .shellcheckrc?