diff --git a/Phabricator.md b/Phabricator.md new file mode 100644 index 0000000..a83f0ca --- /dev/null +++ b/Phabricator.md @@ -0,0 +1,38 @@ +## 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 + +## Configuration to load the linter + +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. + +## Configuration for .arclint + +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$)" + ] + }, + } + } \ No newline at end of file