From b7a09a2efeb5aaeed39e48f6093ad097d0cb1674 Mon Sep 17 00:00:00 2001 From: Aidan Reilly Date: Tue, 18 Nov 2025 17:40:39 +0000 Subject: [PATCH 1/2] Improve Vale rules based on rhel-8-docs analysis Analyzed rhel-8-docs repository and identified false positives in RedHat Vale rules. This commit updates rules to reduce false positives while maintaining accuracy. Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude rh-pre-commit.version: 2.3.2 rh-pre-commit.check-secrets: ENABLED --- .vale/styles/RedHat/Abbreviations.yml | 2 ++ .vale/styles/RedHat/CaseSensitiveTerms.yml | 6 +++--- .vale/styles/RedHat/ConsciousLanguage.yml | 6 +++++- .vale/styles/RedHat/Definitions.yml | 4 ++++ .vale/styles/RedHat/DoNotUseTerms.yml | 4 ++-- .vale/styles/RedHat/GitLinks.yml | 4 ++-- .vale/styles/RedHat/HeadingPunctuation.yml | 2 +- .vale/styles/RedHat/ObviousTerms.yml | 2 +- .vale/styles/RedHat/PascalCamelCase.yml | 18 ++++++++++++++++++ .vale/styles/RedHat/RepeatedWords.yml | 1 + .vale/styles/RedHat/Slash.yml | 15 +++++++++++++++ .vale/styles/RedHat/Spacing.yml | 9 +++++++++ .vale/styles/RedHat/TermsErrors.yml | 7 +++---- .vale/styles/RedHat/TermsSuggestions.yml | 12 ++++++------ .vale/styles/RedHat/TermsWarnings.yml | 2 +- .vale/styles/RedHat/UserReplacedValues.yml | 2 ++ .vale/styles/RedHat/Using.yml | 1 + 17 files changed, 76 insertions(+), 21 deletions(-) diff --git a/.vale/styles/RedHat/Abbreviations.yml b/.vale/styles/RedHat/Abbreviations.yml index ba6c02120..09c9ad51e 100644 --- a/.vale/styles/RedHat/Abbreviations.yml +++ b/.vale/styles/RedHat/Abbreviations.yml @@ -7,3 +7,5 @@ nonword: true # source: "IBM - Periods with abbreviations, p. 5" tokens: - '\b(?:[A-Z]\.){3,5}' +exceptions: + - 'S\.M\.A\.R\.T\.' diff --git a/.vale/styles/RedHat/CaseSensitiveTerms.yml b/.vale/styles/RedHat/CaseSensitiveTerms.yml index 6c4f28197..026c4bdc0 100644 --- a/.vale/styles/RedHat/CaseSensitiveTerms.yml +++ b/.vale/styles/RedHat/CaseSensitiveTerms.yml @@ -21,7 +21,7 @@ swap: "[dD]ay-1|day 1": Day 1 "[dD]ay-2|day 2": Day 2 "BPMS|(?__' - '<[a-z_]+-[a-z_-]+>' \ No newline at end of file diff --git a/.vale/styles/RedHat/Using.yml b/.vale/styles/RedHat/Using.yml index 97f5700aa..8a1284203 100644 --- a/.vale/styles/RedHat/Using.yml +++ b/.vale/styles/RedHat/Using.yml @@ -3,6 +3,7 @@ extends: sequence message: "Use 'by using' instead of 'using' when it follows a noun for clarity and grammatical correctness." link: https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#using level: warning +scope: ~heading action: name: edit params: From 778cbb636c6563afd1d06546fbd9c07aae9ad1ad Mon Sep 17 00:00:00 2001 From: Aidan Reilly Date: Tue, 18 Nov 2025 23:00:41 +0000 Subject: [PATCH 2/2] Fixing incorrect Claude suggestions claude stuff fix fixtures Signed-off-by: Aidan Reilly Signed-off-by: Aidan Reilly rh-pre-commit.version: 2.3.2 rh-pre-commit.check-secrets: ENABLED --- .claude/settings.local.json | 9 +++++++++ .gitignore | 1 + .vale/fixtures/AsciiDoc/UnsetAttributes/testinvalid.adoc | 1 - .../fixtures/RedHat/CaseSensitiveTerms/testinvalid.adoc | 2 -- .vale/fixtures/RedHat/TermsErrors/testinvalid.adoc | 1 - .vale/styles/RedHat/Abbreviations.yml | 2 -- .vale/styles/RedHat/ConsciousLanguage.yml | 4 ---- .vale/styles/RedHat/DoNotUseTerms.yml | 2 +- .vale/styles/RedHat/HeadingPunctuation.yml | 2 +- .vale/styles/RedHat/ObviousTerms.yml | 2 +- .vale/styles/RedHat/RepeatedWords.yml | 1 - .vale/styles/RedHat/Slash.yml | 1 - .vale/styles/RedHat/Spacing.yml | 9 --------- .vale/styles/RedHat/TermsErrors.yml | 2 +- .vale/styles/RedHat/TermsSuggestions.yml | 4 ++-- .vale/styles/RedHat/TermsWarnings.yml | 2 +- .vale/styles/RedHat/UserReplacedValues.yml | 2 -- 17 files changed, 17 insertions(+), 30 deletions(-) create mode 100644 .claude/settings.local.json diff --git a/.claude/settings.local.json b/.claude/settings.local.json new file mode 100644 index 000000000..fccd125d4 --- /dev/null +++ b/.claude/settings.local.json @@ -0,0 +1,9 @@ +{ + "permissions": { + "allow": [ + "Bash(cat:*)" + ], + "deny": [], + "ask": [] + } +} diff --git a/.gitignore b/.gitignore index 02452619c..e3f265ed8 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ .DS_Store .vale/styles/RedHat.zip .vscode/settings.json +tmp/ /*.gem /*.html /.bundle diff --git a/.vale/fixtures/AsciiDoc/UnsetAttributes/testinvalid.adoc b/.vale/fixtures/AsciiDoc/UnsetAttributes/testinvalid.adoc index 7aec447cf..9d795c60d 100644 --- a/.vale/fixtures/AsciiDoc/UnsetAttributes/testinvalid.adoc +++ b/.vale/fixtures/AsciiDoc/UnsetAttributes/testinvalid.adoc @@ -17,4 +17,3 @@ Ignore multi-line comments //ignore comments //:!infra: -:!infra: diff --git a/.vale/fixtures/RedHat/CaseSensitiveTerms/testinvalid.adoc b/.vale/fixtures/RedHat/CaseSensitiveTerms/testinvalid.adoc index cd2740185..ece03274a 100644 --- a/.vale/fixtures/RedHat/CaseSensitiveTerms/testinvalid.adoc +++ b/.vale/fixtures/RedHat/CaseSensitiveTerms/testinvalid.adoc @@ -252,7 +252,6 @@ Kie Server kjar kJAR knowledge API -knowledge base knowledge session knowledgebase ksession @@ -498,7 +497,6 @@ UltraSparc ULTRASPARC unix Unix -UNIX-like uri url urn diff --git a/.vale/fixtures/RedHat/TermsErrors/testinvalid.adoc b/.vale/fixtures/RedHat/TermsErrors/testinvalid.adoc index 62ceb3b70..328003c38 100644 --- a/.vale/fixtures/RedHat/TermsErrors/testinvalid.adoc +++ b/.vale/fixtures/RedHat/TermsErrors/testinvalid.adoc @@ -405,7 +405,6 @@ switch off synch sysprep function system engineer -tablespace TCP/IP network teleprocessing line testcase diff --git a/.vale/styles/RedHat/Abbreviations.yml b/.vale/styles/RedHat/Abbreviations.yml index 09c9ad51e..ba6c02120 100644 --- a/.vale/styles/RedHat/Abbreviations.yml +++ b/.vale/styles/RedHat/Abbreviations.yml @@ -7,5 +7,3 @@ nonword: true # source: "IBM - Periods with abbreviations, p. 5" tokens: - '\b(?:[A-Z]\.){3,5}' -exceptions: - - 'S\.M\.A\.R\.T\.' diff --git a/.vale/styles/RedHat/ConsciousLanguage.yml b/.vale/styles/RedHat/ConsciousLanguage.yml index b49b1e0e3..01619aa50 100644 --- a/.vale/styles/RedHat/ConsciousLanguage.yml +++ b/.vale/styles/RedHat/ConsciousLanguage.yml @@ -6,12 +6,8 @@ link: https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.htm message: "Use %s rather than '%s'." action: name: replace -# Exclude files that document the terminology changes themselves -excludes: - - 'making-open-source-more-inclusive.*\.adoc' swap: blacklist: blocklist - # Exclude "Master Boot Record" (MBR) - industry standard technical term master(?! broker| boot record): primary|source|initiator|requester|controller|host|director|supplier slave(?! broker): secondary|replica|responder|device|worker|proxy|performer|consumer|child whitelist: allowlist diff --git a/.vale/styles/RedHat/DoNotUseTerms.yml b/.vale/styles/RedHat/DoNotUseTerms.yml index daead3264..5838e534d 100644 --- a/.vale/styles/RedHat/DoNotUseTerms.yml +++ b/.vale/styles/RedHat/DoNotUseTerms.yml @@ -14,7 +14,7 @@ swap: basically: 'Do not use "basically". "Basically" is another term for "in principle" or "fundamentally".' congratulations: 'Do not use "congratulations" in technical information."' debuggable: 'Do not use "debuggable". Rephrase the sentence to use the verb or noun debug. For example, change rebuild the debuggable version to rebuild the version that can be debugged.' - '(?__' - '<[a-z_]+-[a-z_-]+>' \ No newline at end of file