7x31/shellcheck
1
0
Fork 0
mirror of https://github.com/koalaman/shellcheck.git synced 2025-10-03 19:29:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

Highlight code-blocks and display literal names in monospace

John Gardner
2021-12-22 16:12:42 +11:00
parent b41ead76cc
commit 5dd53489e0
1 changed files with 32 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
Phabricator.md

@@ -2,14 +2,17 @@
The default path for libraries extending Phabricator and Arcanist is at the same level as Phabricator or Arcanist folders: The default path for libraries extending Phabricator and Arcanist is at the same level as Phabricator or Arcanist folders:
```console
$ cd /path/to/arcanist $ cd /path/to/arcanist
$ cd .. $ cd ..
$ git clone https://github.com/dereckson/shellcheck-linter.git $ 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:
```json
{ {
"phabricator.uri": "https://devcentral.nasqueron.org/", "phabricator.uri": "https://devcentral.nasqueron.org/",
"repository.callsign": "OPS", "repository.callsign": "OPS",
@@ -17,15 +20,17 @@ When you need to use this plugin in a project, in your .arcconfig file, add a lo
"shellcheck-linter" "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:
```json
{ {
"linters": { "linters": {
"shell": { "shell": {
@@ -33,6 +38,7 @@ For example to lint all .sh files:
"include": [ "include": [
"(\\.sh$)" "(\\.sh$)"
] ]
},
} }
} }
}
```