From 5dd53489e04a571ebec73a05d906ef98b879a1c1 Mon Sep 17 00:00:00 2001 From: John Gardner Date: Wed, 22 Dec 2021 16:12:42 +1100 Subject: [PATCH] Highlight code-blocks and display literal names in monospace --- Phabricator.md | 58 ++++++++++++++++++++++++++++---------------------- 1 file changed, 32 insertions(+), 26 deletions(-) diff --git a/Phabricator.md b/Phabricator.md index a83f0ca..8d28906 100644 --- a/Phabricator.md +++ b/Phabricator.md @@ -2,37 +2,43 @@ 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 +```console +$ cd /path/to/arcanist +$ cd .. +$ git clone https://github.com/dereckson/shellcheck-linter.git +``` -## Configuration to load the linter +### 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: +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" - ] - } +```json +{ + "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. +The `load` array is a collection of strings, and each string match a folder name to load. -## Configuration for .arclint +### Configuration for `.arclint` -Provide a block with the shellcheck linter type and the patterns you wish to lint. +Provide a block with the `"shellcheck"` linter type and the patterns you wish to lint. -For example to lint all .sh files: +For example to lint all `.sh` files: - { - "linters": { - "shell": { - "type": "shellcheck", - "include": [ - "(\\.sh$)" - ] - }, - } - } \ No newline at end of file +```json +{ + "linters": { + "shell": { + "type": "shellcheck", + "include": [ + "(\\.sh$)" + ] + } + } +} +```