Add ObviousTerms rule

redhat-documentation · Oct 7, 2024 · 66b5987 · 66b5987
1 parent 800a614
commit 66b5987
Show file tree

Hide file tree

Showing 4 changed files with 23 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,2 @@
+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
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 not documenting %s because it is self-explanatory."
+scope: sentence
+# source:
+action:
+  name: remove
+tokens:
+  - 'User field'
+  - 'Username field'
+  - 'Password field'
+  - 'Mail field'
+  - 'Description field'
+  - 'Name field'