Ali nazari

Posted on Jul 9

Practicing politeness in JavaScript code 🤬

#javascript #node #tutorial #learning

Imagine that you published a big open source project and many people are currently changing your code or updating the project documents.

what if someone accidently write something race related , gender favoring , polarizing and etc... 👀

we have a tool called alex !

According to what is written in the documentation of this tool:

Whether your own or someone else’s writing, alex helps you find gender favoring, polarizing, race related, or other unequal phrasing in text.

Set up Alex in our project

in order to use alex inside our project , first we need to install its package.

it will be a good practice if you install alex as a dev-dependency
or you can just install it globally in your system.

npm i -D alex

Alex reads plain text, HTML, MDX, or markdown as input.

One of its uses is to scan all project documents for any literary issues.

Let’s assume that all our documents are written in Markdown format, so we instruct Alex to check all files with a .md extension

In our package.json file, we can create a script like:

{
  "scripts": {
      "test-doc" : "npx alex *.md"
}

After that, I create a file called policy.md as an example document:

## the boogeyman walked to class

if you run the test-doc command, you will probably get this result:

> test-doc
> npx alex *.md

policy.md
  1:8-1:17  warning  `boogeyman` may be insensitive, use `boogeymonster` instead  boogeyman-boogeywoman  retext-equality

‼ 1 warning

You can use this command together with tools such as Husky ** and **lint-staged to run the process of checking your files automatically. 🤖

What are your thoughts on this tool, and how crucial is compliance with this matter for software projects? 🧐🤗

Top comments (34)

Jon Randy 🎖️ • Jul 10

warning  `boogeyman` may be insensitive, use `boogeymonster` instead  boogeyman-boogeywoman  retext-equality

I have no words. This is completely ridiculous

Ali nazari • Jul 10

true 🤣🤌🏻

Jon Randy 🎖️ • Jul 10 • Edited

Also, this kind of thing (whether a document is not 'inclusive', or is 'offensive') should be determined/resolved by the normal process of PRs and review/discussion - not arbitrary decision making by a dumb model that has no idea or understanding about context, sarcasm, intent, etc.

This really feels like a solution looking for a problem.

Samuel Boczek • Jul 12

Might be useful for checking and refactoring old documents, but I agree that you should not just treat the this tools as an end all solution.

Ali nazari • Jul 12

thank you for your feedback 🤗

Đăng Tú • Jul 12

What is this abormination?!!! Why would anyone spending their time to create such a tasteless tool like this? What a waste of time!

Ali nazari • Jul 12

🙁

Best Codes • Jul 13

People don't understand. 😕
I can understand, though. 🙂

Paul Canning • Jul 13

Is this a late April Fools?

Ali nazari • Jul 13

Maybe, who knows! 😏👀

click2install • Jul 13

Humanity is doomed.

Ali nazari • Jul 13

However, it can still be viewed as a fun tool. 😏

João Almeida • Jul 13

Lol good luck writing "merged changes to 'master'"

Ali nazari • Jul 13

🫡

Kat • Jul 9

Seems like a great little tool! Thank you for bringing it to my attention :)

Ali nazari • Jul 10

Thank you for your positive feedback! 🤗

Edwin Teisman • Jul 15

Nice little joke you got there. Probably some conservative who wants promote the anti woke movement. They'll follow up with a post against wokeness on Twitter or Reddit

ScaryLerie • Jul 28

Unnecessary.

Ali nazari • Jul 29

thank you for your feedback sir 🫡👑

simonoop • Jul 17

What the hell has happened to the freaking world? What's next? Enforcing git branch names?!?!! Oh wait ..

Eli Vargas • Jul 15

I feel offended by this tool 🤣
Wow the levels that we are reaching now. We are doomed 😔

Ali nazari • Jul 16

I am slowly thinking that it would have been better if I had not used the example in the documentation of this tool 😵😷
The situation is getting worse 🤣🤣