From ec6e27f865b9962ea2dbeb92093aebf47ec96cbe Mon Sep 17 00:00:00 2001 From: Joseph Kato Date: Fri, 22 Mar 2024 13:14:59 -0700 Subject: [PATCH] Combine `CompexWords` and `Wordiness` --- Microsoft/ComplexWords.yml | 14 -------------- Microsoft/Wordiness.yml | 12 +++++++++--- features/rules.feature | 8 ++++---- 3 files changed, 13 insertions(+), 21 deletions(-) delete mode 100644 Microsoft/ComplexWords.yml diff --git a/Microsoft/ComplexWords.yml b/Microsoft/ComplexWords.yml deleted file mode 100644 index e80553f..0000000 --- a/Microsoft/ComplexWords.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: suggestion -action: - name: replace -swap: - "(?:utilize|make use of)": use - "(?:extract|take away|eliminate)": remove - "(?:in order to|as a means to)": to - "(?:inform|let me know)": tell - in addition: also - establish connectivity: connect diff --git a/Microsoft/Wordiness.yml b/Microsoft/Wordiness.yml index 9facc10..c779cf2 100644 --- a/Microsoft/Wordiness.yml +++ b/Microsoft/Wordiness.yml @@ -2,20 +2,24 @@ extends: substitution message: "Consider using '%s' instead of '%s'." link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences ignorecase: true -level: warning +level: suggestion action: name: replace swap: + (?:extract|take away|eliminate): remove (?:give|gave) rise to: lead to + (?:in order to|as a means to): to + (?:inform|let me know): tell (?:previous|prior) to: before + (?:utilize|make use of): use a (?:large)? majority of: most a (?:large)? number of: many a myriad of: myriad adversely impact: hurt all across: across + all of (?!a sudden|these): all all of a sudden: suddenly all of these: these - all of (?!a sudden|these): all all-time record: record almost all: most almost never: seldom @@ -52,13 +56,14 @@ swap: continue on: continue despite the fact that: although disappear from sight: disappear + doomed to fail: doomed drag and drop: drag drag-and-drop: drag - doomed to fail: doomed due to the fact that: because during the period of: during during the time that: while emergency situation: emergency + establish connectivity: connect except when: unless excessive number: too many extend an invitation: invite @@ -74,6 +79,7 @@ swap: in a careful manner: carefully in a thoughtful manner: thoughtfully in a timely manner: timely + in addition: also in an effort to: to in between: between in lieu of: instead of diff --git a/features/rules.feature b/features/rules.feature index 93aedb8..49d4bff 100644 --- a/features/rules.feature +++ b/features/rules.feature @@ -44,7 +44,7 @@ Feature: Rules """ test.md:3:25:Microsoft.Avoid:Don't use 'abortion'. See the A-Z word list for details. test.md:5:9:Microsoft.Vocab:Verify your use of 'and/or' with the A-Z word list. - test.md:7:8:Microsoft.Adverbs:Consider removing 'very'. + test.md:7:8:Microsoft.Adverbs:Remove 'very' if it's not important to the meaning of the statement. test.md:9:1:Microsoft.FirstPerson:Use first person (such as 'I') sparingly. test.md:9:27:Microsoft.Wordiness:Consider using 'enough' instead of 'an adequate number of'. test.md:11:9:Microsoft.Vocab:Verify your use of 'ensure' with the A-Z word list. @@ -60,7 +60,7 @@ Feature: Rules test.md:33:21:Microsoft.We:Try to avoid using first-person plural like 'our'. test.md:35:1:Microsoft.We:Try to avoid using first-person plural like 'We'. test.md:37:1:Microsoft.FirstPerson:Use first person (such as 'I') sparingly. - test.md:37:21:Microsoft.ComplexWords:Consider using 'to' instead of 'as a means to'. + test.md:37:21:Microsoft.Wordiness:Consider using 'to' instead of 'as a means to'. """ # Scenario: Backend vs. Back-end @@ -170,8 +170,8 @@ Feature: Rules When I test "URL" Then the output should contain exactly: """ - test.md:1:11:Microsoft.URLFormat:Use 'URL of' instead of 'URL for'. - test.md:3:8:Microsoft.URLFormat:Use 'a URL' instead of 'an URL'. + test.md:1:11:Microsoft.URLFormat:Use 'of' (not 'for') to describe the relationship of the word URL to a resource. + test.md:3:11:Microsoft.URLFormat:Use 'of' (not 'for') to describe the relationship of the word URL to a resource. """ Scenario: Use of numbers