feat(pre-commit): add rst-lint

myii · Jul 1, 2021 · 25ce78a · 25ce78a
1 parent f00ec52
commit 25ce78a
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 2 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -52,3 +52,14 @@ repos:
       - id: rstcheck
         name: Check reST files using rstcheck
         exclude: 'docs/CHANGELOG.rst'
+  - repo: https://github.com/saltstack-formulas/mirrors-rst-lint
+    rev: v1.3.2
+    hooks:
+      - id: rst-lint
+        name: Check reST files using rst-lint
+        exclude: |
+            (?x)^(
+                docs/CHANGELOG.rst|
+                docs/TOFS_pattern.rst|
+            )$
+        additional_dependencies: [pygments==2.9.0]
diff --git a/ssf/defaults.yaml b/ssf/defaults.yaml
@@ -64,8 +64,8 @@ ssf_node_anchors:
             #       An alternative method could be to use:
             #       `git describe --abbrev=0 --tags`
             # yamllint disable rule:line-length rule:quoted-strings
-            title: "ci: enable Vagrant-based testing using GitHub Actions"
-            body: '* Automated using https://github.com/myii/ssf-formula/pull/334'
+            title: "ci(pre-commit): add '`'rst-lint'`' [skip ci]"
+            body: '* Automated using https://github.com/myii/ssf-formula/pull/335'
             # yamllint enable rule:line-length rule:quoted-strings
           github:
             owner: 'saltstack-formulas'

diff --git a/ssf/files/default/.pre-commit-config.yaml b/ssf/files/default/.pre-commit-config.yaml
@@ -54,3 +54,20 @@ repos:
       - id: rstcheck
         name: Check reST files using rstcheck
         exclude: 'docs/CHANGELOG.rst'
+  - repo: https://github.com/saltstack-formulas/mirrors-rst-lint
+    rev: v1.3.2
+    hooks:
+      - id: rst-lint
+        name: Check reST files using rst-lint
+        exclude: |
+            (?x)^(
+                docs/CHANGELOG.rst|
+                docs/TOFS_pattern.rst|
+                {#- Required until the Antora solution is finalised, which then allows
+                    the `readthedocs` site to be disbanded #}
+                {%- if semrel_formula == 'template' %}
+                docs/CONTRIBUTING_DOCS.rst|
+                docs/index.rst|
+                {%- endif  %}
+            )$
+        additional_dependencies: [pygments==2.9.0]