shellcheck

mirror of https://github.com/koalaman/shellcheck.git synced 2024-11-03 04:00:16 -08:00

Table of Contents

Installation

The default path for libraries extending Phabricator and Arcanist is at the same level as Phabricator or Arcanist folders:

$ cd /path/to/arcanist
$ cd ..
$ git clone https://github.com/dereckson/shellcheck-linter.git

When you need to use this plugin in a project, in your .arcconfig file, add a load block, for example:

{
	"phabricator.uri": "https://devcentral.nasqueron.org/",
	"repository.callsign": "OPS",
	"load": [
		"shellcheck-linter"
	]
}

The load array is a collection of strings, and each string match a folder name to load.

Provide a block with the "shellcheck" linter type and the patterns you wish to lint.

For example to lint all .sh files:

{
	"linters": {
		"shell": {
			"type": "shellcheck",
			"include": [
				"(\\.sh$)"
			]
		}
	}
}

Each individual ShellCheck warning has its own wiki page like SC1000. Use GitHub Wiki's "Pages" feature above to find a specific one, or see Checks.