YAML ellipses rule

redhat-documentation · Sep 22, 2024 · 8391f59 · 8391f59
1 parent 1653816
commit 8391f59
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 0 deletions.
diff --git a/.vale/fixtures/RedHat/YamlEllipses/.vale.ini b/.vale/fixtures/RedHat/YamlEllipses/.vale.ini
@@ -0,0 +1,5 @@
+; Vale configuration file to test the `YamlEllipses` rule
+StylesPath = ../../../styles
+MinAlertLevel = error
+[*.adoc]
+RedHat.YamlEllipses = YES
diff --git a/.vale/fixtures/RedHat/YamlEllipses/testinvalid.adoc b/.vale/fixtures/RedHat/YamlEllipses/testinvalid.adoc
@@ -0,0 +1,2 @@
+...
+  ...
diff --git a/.vale/fixtures/RedHat/YamlEllipses/testvalid.adoc b/.vale/fixtures/RedHat/YamlEllipses/testvalid.adoc
@@ -0,0 +1,2 @@
+# ...
+echo -n "Creating NAT Gateway..."
diff --git a/.vale/styles/RedHat/YamlEllipses.yml b/.vale/styles/RedHat/YamlEllipses.yml
@@ -0,0 +1,10 @@
+---
+extends: existence
+scope: code
+level: suggestion
+link: https://yaml.org/spec/1.2.2/#22-structures
+message: "Use '%s' rather than '%s' as ellipsis in YAML code blocks."
+action:
+  name: replace
+swap:
+  "(?<!# )...": # ...