This linter plugin for Linter provides an interface to shellcheck. It will be used with files that have the "Shell" syntax.
Linter package must be installed in order to use this plugin. If Linter is not installed, please follow the instructions here.
shellcheck
installationBefore using this plugin, you must ensure that shellcheck
is installed on
your system. To install shellcheck
, follow the guide on
shellcheck github
apm install linter-shellcheck
You can configure linter-shellcheck through Atom's Settings menu. If you
instead prefer editing the configuration by hand you can get to that by editing
~/.atom/config.cson
(choose Open Your Config in Atom menu). The settings
available are:
shellcheckExecutablePath
: The full path to the shellcheck
executable.
Run which shellcheck
to find where it is installed on your system.
userParameters
: Any additional executable parameters to pass to
shellcheck
when linting your files.
enableNotice
: Include lesser-importance ShellCheck messages
(default: false).
useProjectCwd
: Controls whether the paths used by ShellCheck's
source=
directive are relative to the project root or the file (default: false, for
file-relative)
If true, ShellCheck's working directory
will be the project's root directory. Any source=
directives will be
interpreted relative to the project root.
Otherwise, ShellCheck will run relative to the file's directory,
making source=
directives file-relative.
Good catch. Let us know what about this package looks wrong to you, and we'll investigate right away.