Skip to content
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.

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

Adds AlexJS rules file #148

Merged
merged 2 commits into from
May 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .alexignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# The CODE_OF_CONDUCT.md contains some language with implicit meanings
CODE_OF_CONDUCT.md

# The rules files need to contain the terms to test for
cisco-rules.yaml

# The README has examples for how to run the scripts with biased terms
README.md
4 changes: 4 additions & 0 deletions .alexrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
exports.allow = [
"cisco-rules" // name of the rule you want to allow
];
exports.noBinary = true;
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ venv/
*.csv
*.xlsx
*.log
Pipfile.lock
Pipfile.lock
node_modules/
package-lock.json
116 changes: 116 additions & 0 deletions alex-race-rules.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
# ************* Cisco Inclusive Language Policy for AlexJS Linter Rules YAML *******
# Terminology defined based on:
# https://www.cisco.com/c/en/us/about/social-justice/inclusive-language-policy.html
# ************* *************** *************** *************** *************** **

- type: basic
note: Avoid using the term `master`; these suggestions are for the computer term, but there are better alternatives for other cases too
considerate:
- primary
- lead
- hub
- reference
inconsiderate:
- master
- type: basic
note: Avoid using the term `master`; these suggestions are for the computer term, but there are better alternatives for other cases too
considerate:
- primaries
- hubs
- references
inconsiderate:
- masters
- type: basic
note: Avoid using the term `slave`; these suggestions are for the computer term, but there are better alternatives for other cases too
considerate:
- secondary
- worker
- replica
- node
inconsiderate:
- slave
- type: basic
note: Avoid using the term `slave`; these suggestions are for the computer term, but there are better alternatives for other cases too
considerate:
- secondaries
- workers
- replicas
- nodes
inconsiderate:
- slaves
- type: basic
considerate:
- unethical hacker
- malicious actor
inconsiderate:
- blackhat
- type: basic
considerate:
- ethical hacker
- security researcher
inconsiderate:
- whitehat
- type: basic
considerate:
- person of color
- people of color
inconsiderate:
- nonwhite
- non white
- type: basic
note: Replace racially-charged language with more accurate and inclusive words
considerate:
- blocklist
- wronglist
- banlist
- deny list
inconsiderate:
- blacklist
- black list
- type: basic
note: Replace racially-charged language with more accurate and inclusive words
considerate:
- blocklisted
- wronglisted
- banlisted
- deny-listed
inconsiderate:
- blacklisted
- type: basic
note: Replace racially-charged language with more accurate and inclusive words
considerate:
- blocklisting
- wronglisting
- banlisting
- deny-listing
inconsiderate:
- blacklisting
- type: basic
note: Replace racially-charged language with more accurate and inclusive words
considerate:
- passlist
- alrightlist
- safelist
- allow list
inconsiderate:
- whitelist
- white list
- type: basic
note: Replace racially-charged language with more accurate and inclusive words
considerate:
- passlisted
- alrightlisted
- safelisted
- allow-listed
inconsiderate:
- whitelisted
- type: basic
note: Replace racially-charged language with more accurate and inclusive words
considerate:
- passlisting
- alrightlisting
- safelisting
- allow-listing
inconsiderate:
- whitelisting

8 changes: 8 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"devDependencies": {
"alex": "^11.0.1"
},
"scripts": {
"lint-language": "alex"
}
}