Add ObviousTerms rule

redhat-documentation · Sep 30, 2024 · 79e6bed · 79e6bed
1 parent 800a614
commit 79e6bed
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 0 deletions.
diff --git a/.vale/fixtures/RedHat/ObviousTerms/.vale.ini b/.vale/fixtures/RedHat/ObviousTerms/.vale.ini
@@ -0,0 +1,5 @@
+; Vale configuration file to test the `ObviousTerms` rule
+StylesPath = ../../../styles
+MinAlertLevel = suggestion
+[*.adoc]
+RedHat.ObviousTerms = YES
diff --git a/.vale/fixtures/RedHat/ObviousTerms/testinvalid.adoc b/.vale/fixtures/RedHat/ObviousTerms/testinvalid.adoc
@@ -0,0 +1,3 @@
+//vale-fixture
+. Enter your user name in the *Username* field.
+. Enter your description in the *Description* field.
diff --git a/.vale/fixtures/RedHat/ObviousTerms/testvalid.adoc b/.vale/fixtures/RedHat/ObviousTerms/testvalid.adoc
@@ -0,0 +1 @@
+
diff --git a/.vale/styles/RedHat/ObviousTerms.yml b/.vale/styles/RedHat/ObviousTerms.yml
@@ -0,0 +1,16 @@
+---
+extends: existence
+level: suggestion
+# link:
+message: "Consider whether you need to document a self-explanatory term or field."
+scope: list
+# source:
+action:
+  name: remove
+tokens:
+  - User
+  - Username
+  - Password
+  - Mail
+  - Description
+  - Name