Skip to content

docs: add Vale rules suggesting alternatives to animal-derived idioms #21374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stuckvgn wants to merge 1 commit into
base: main
Choose a base branch
from
+47 −1
Open

docs: add Vale rules suggesting alternatives to animal-derived idioms #21374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/codeql/.vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ MinAlertLevel = suggestions
# Vale comes with three built-in styles: write-good, proselint, and Joblint.
# You could enable all rules in the "Microsoft" style guide as follows:
# BasedOnStyles = Microsoft
BasedOnStyles = Semmle
BasedOnStyles = Semmle, Speciesism

# Initially, we only want to run a few rules, so we'll specify them individually
# Style.Rule = {YES, NO} to enable or disable a specific rule
Expand Down
32 changes: 32 additions & 0 deletions docs/codeql/vale-styles/Speciesism/AnimalIdioms.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
extends: substitution
message: "Consider using '%s' instead of '%s'. This phrase normalizes violence toward animals."
link: https://doi.org/10.1007/s43681-023-00380-w
level: suggestion
ignorecase: true
swap:
'kill two birds with one stone': accomplish two things at once
'killing two birds with one stone': accomplishing two things at once
'killed two birds with one stone': accomplished two things at once
'beat a dead horse': belabor the point
'beating a dead horse': belaboring the point
'flog a dead horse': belabor the point
'flogging a dead horse': belaboring the point
'bring home the bacon': bring home the results
'bringing home the bacon': bringing home the results
'brought home the bacon': brought home the results
'more than one way to skin a cat': more than one way to solve this
'many ways to skin a cat': many ways to approach this
'let the cat out of the bag': reveal the secret
'letting the cat out of the bag': revealing the secret
'open a can of worms': create a complicated situation
'opening a can of worms': creating a complicated situation
'opened a can of worms': created a complicated situation
'wild goose chase': pointless pursuit
'take the bull by the horns': face the challenge head-on
'taking the bull by the horns': facing the challenge head-on
'took the bull by the horns': faced the challenge head-on
'like shooting fish in a barrel': extremely easy
'straight from the horse''s mouth': directly from the source
'from the horse''s mouth': from a reliable source
'whack-a-mole': recurring problem
'whack a mole': recurring problem
14 changes: 14 additions & 0 deletions docs/codeql/vale-styles/Speciesism/AnimalMetaphors.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
extends: substitution
message: "Consider using '%s' instead of '%s'. This term references animals as objects or tools."
link: https://doi.org/10.1007/s43681-023-00380-w
level: suggestion
ignorecase: true
swap:
'guinea pig': test subject
'sacred cow': unquestioned belief
'sacred cows': unquestioned beliefs
'scapegoat(?:ed|ing)?': wrongly blamed
'dog-eat-dog': ruthlessly competitive
'dog eat dog': ruthlessly competitive
'rat race': competitive grind
'red herring': false lead