Merge pull request rohennes#54 from aireilly/unclosed-id-rule

New AsciiDoc rules - catch unclosed attr blocks, catch unclosed id quotes
aireilly · Apr 28, 2023 · dc75bbf · dc75bbf
2 parents 4c53c2e + 093e41b
commit dc75bbf
Show file tree

Hide file tree

Showing 8 changed files with 54 additions and 0 deletions.
diff --git a/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/.vale.ini b/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/.vale.ini
@@ -0,0 +1,5 @@
+; Vale configuration file to test the `ClosedAttributeBlocks` rule
+StylesPath = ../../../styles
+MinAlertLevel = error
+[*.adoc]
+AsciiDoc.ClosedAttributeBlocks = YES
diff --git a/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testinvalid.adoc
@@ -0,0 +1,9 @@
+//vale-fixture
+:_content-type: ASSEMBLY
+[id="rosa-getting-started
+= Comprehensive guide to getting started with {product-title}
+
+//vale-fixture
+:_content-type: ASSEMBLY
+[id="rosa-getting-started_{context}
+= Another guide to getting started
diff --git a/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testvalid.adoc b/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testvalid.adoc
@@ -0,0 +1,10 @@
+//vale-fixture
+:_content-type: ASSEMBLY
+[id="rosa-getting-started_{context}"]
+= Comprehensive guide to getting started with {product-title}
+
+.Example output
+[source,terminal]
+----
+{"status":"success","data":{"resultType":"vector","result":[{"metric":{"__name__":"up","endpoint":"web","instance":"10.129.0.46:8080","job":"prometheus-example-app","namespace":"ns1","pod":"prometheus-example-app-68d47c4fb6-jztp2","service":"prometheus-example-app"},"value":[1591881154.748,"1"]}]}}
+----
diff --git a/.vale/fixtures/AsciiDoc/ClosedIdQuotes/.vale.ini b/.vale/fixtures/AsciiDoc/ClosedIdQuotes/.vale.ini
@@ -0,0 +1,5 @@
+; Vale configuration file to test the `ClosedIdQuotes` rule
+StylesPath = ../../../styles
+MinAlertLevel = error
+[*.adoc]
+AsciiDoc.ClosedIdQuotes = YES
diff --git a/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testinvalid.adoc
@@ -0,0 +1,7 @@
+//vale-fixture
+[id="rosa-getting-started_{context}]
+= Comprehensive guide to getting started with {product-title}
+
+//vale-fixture
+[id="rosa-getting-started]
+= Another guide to getting started
diff --git a/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testvalid.adoc b/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testvalid.adoc
@@ -0,0 +1,4 @@
+//vale-fixture
+:_content-type: ASSEMBLY
+[id="rosa-getting-started_{context}"]
+= Comprehensive guide to getting started with {product-title}
diff --git a/.vale/styles/AsciiDoc/ClosedAttributeBlocks.yml b/.vale/styles/AsciiDoc/ClosedAttributeBlocks.yml
@@ -0,0 +1,7 @@
+---
+extends: existence
+scope: raw
+level: error
+message: "Attribute block is not closed."
+raw:
+  - '(?<!.)\[.*(?<!\])\n'
diff --git a/.vale/styles/AsciiDoc/ClosedIdQuotes.yml b/.vale/styles/AsciiDoc/ClosedIdQuotes.yml
@@ -0,0 +1,7 @@
+---
+extends: existence
+scope: raw
+level: error
+message: "Quoted ID value is not closed."
+raw:
+  - '(?<!.)\[id\=\".*(?<!\")\]'