Test vale lint (#4166)

* Test vale lint Signed-off-by: Ian Maddaus <[email protected]> * Add something that should fail. Signed-off-by: Ian Maddaus <[email protected]> * Set file directories Signed-off-by: Ian Maddaus <[email protected]> * Remove offending text Signed-off-by: Ian Maddaus <[email protected]> * Test a vale warning Signed-off-by: Ian Maddaus <[email protected]> * More testing Signed-off-by: Ian Maddaus <[email protected]> * More testing Signed-off-by: Ian Maddaus <[email protected]> * More testing Signed-off-by: Ian Maddaus <[email protected]> * Revert some testing Signed-off-by: Ian Maddaus <[email protected]> * Remove test example Signed-off-by: Ian Maddaus <[email protected]> * Cleanup config files Signed-off-by: Ian Maddaus <[email protected]> * Additional note Signed-off-by: Ian Maddaus <[email protected]> * That space will bug me. Signed-off-by: Ian Maddaus <[email protected]> --------- Signed-off-by: Ian Maddaus <[email protected]>
chef · Aug 25, 2023 · 973a9fe · 973a9fe
1 parent e41d870
commit 973a9fe
Show file tree

Hide file tree

Showing 11 changed files with 29 additions and 73 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -56,4 +56,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: errata-ai/vale-action@reviewdog
         with:
+          files: '["archetypes", "assets", "content", "data", "layouts", "static", "themes"]'
+          vale_flags: "--config=tools/vale/.vale-github-action.ini"
           filter_mode: diff_context
+          fail_on_error: true
diff --git a/.vale.ini b/.vale.ini
@@ -1,15 +1,18 @@
 # Vale configuration file.
 #
+# This config file configures Vale when it's run locally.
+# The tools/vale/.vale-github-action.ini file configures Vale when it's run by GitHub Actions.
+#
 # For more information, see https://vale.sh/docs/.
 
 StylesPath = tools/vale/
-MinAlertLevel = warning
+MinAlertLevel = suggestion
 SkippedScopes = code
-Packages = Microsoft, write-good, Readability, Hugo
+Packages = Microsoft, write-good, Hugo
 Vocab = Chef
 
-[*.md]
-BasedOnStyles = chef, Microsoft, Readability, vale, write-good
+[*.{md,yaml,yml}]
+BasedOnStyles = chef, Microsoft, vale, write-good
 
 # Ignore SVG markup
 TokenIgnores = (\*\*\{\w*\}\*\*)
diff --git a/tools/vale/.vale-github-action.ini b/tools/vale/.vale-github-action.ini
@@ -0,0 +1,19 @@
+# Vale configuration file.
+#
+# This config file is for Vale lints run by GitHub Actions.
+# See the .github/workflows/lint.yml file.
+# See the .vale.ini file in the project root for lints run on a local workstation.
+#
+# For more information, see https://vale.sh/docs/.
+
+StylesPath = ../vale/
+MinAlertLevel = error
+SkippedScopes = code
+Packages = Microsoft, write-good, Hugo
+Vocab = Chef
+
+[*.{md,yaml,yml}]
+BasedOnStyles = chef, Microsoft, vale, write-good
+
+# Ignore SVG markup
+TokenIgnores = (\*\*\{\w*\}\*\*)
diff --git a/tools/vale/Readability/AutomatedReadability.yml b/tools/vale/Readability/AutomatedReadability.yml
diff --git a/tools/vale/Readability/ColemanLiau.yml b/tools/vale/Readability/ColemanLiau.yml
diff --git a/tools/vale/Readability/FleschKincaid.yml b/tools/vale/Readability/FleschKincaid.yml
diff --git a/tools/vale/Readability/FleschReadingEase.yml b/tools/vale/Readability/FleschReadingEase.yml
diff --git a/tools/vale/Readability/GunningFog.yml b/tools/vale/Readability/GunningFog.yml
diff --git a/tools/vale/Readability/LIX.yml b/tools/vale/Readability/LIX.yml
diff --git a/tools/vale/Readability/SMOG.yml b/tools/vale/Readability/SMOG.yml
diff --git a/tools/vale/Readability/meta.json b/tools/vale/Readability/meta.json