docs: Add configuration for integration with Arcanist

adrienverge · Oct 24, 2020 · 0f9dffd · 0f9dffd
1 parent cef0b48
commit 0f9dffd
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/docs/integration.rst b/docs/integration.rst
@@ -51,3 +51,22 @@ An example workflow using GitHub Actions:
 
          - name: Lint YAML files
            run: yamllint .
+
+Integration with Arcanist
+-------------------------
+
+You can configure yamllint to run on ``arc lint``. Here is an example
+``.arclint`` file that makes use of this configuration.
+
+.. code:: json
+
+  {
+    "linters": {
+      "yamllint": {
+        "type": "script-and-regex",
+        "script-and-regex.script": "yamllint",
+        "script-and-regex.regex": "/^(?P<line>\\d+):(?P<offset>\\d+) +(?P<severity>warning|error) +(?P<message>.*) +\\((?P<name>.*)\\)$/m",
+        "include": "(\\.(yml|yaml)$)"
+      }
+    }
+  }