markdownlint VS alex

markdownlint is a node.js markdown linter that is easy to install and easy to customize. It is based on an earlier Ruby tool, also called markdownlint. Both are great, but the Node.js tool is easy to install and easy to customize.

An example of where this can be convenient is when you want to use an external program or project that uses a language that isn't supported by your project. For example, the build process for this blog's content uses Node.js, but consider the case where I wanted to use a Markdown linter defined in Ruby, such as Markdownlint. One option is to add a Ruby installation directly to the definition of the build environment, but this has a few disadvantages:

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

Catch insensitive, inconsiderate writing with tools like alex

This story has been a motivating principle behind my life for a long time, and therefore, whenever I've worked on docs, I've thought about how I could ensure that exclusionary words, even unintentionally, did not make their way into the final copy. During my time at Nexmo, a communications API company, I introduced Alex, an NPM package that helps you identify potentially exclusionary language in your writing, into the CI/CD pipeline for the documentation.

As a philosophy student: Zotero for reference management, the Better BibTeX plugin to auto-generate a .bib file, and two language servers for diagnostics: LTeX for grammar- and spellchecking, and alex for style and sensitivity checking.

When using it as a lib you can pass a markdown string (https://github.com/get-alex/alex#markdownvalue-config) or raw text string (https://github.com/get-alex/alex#textvalue-config). This will return an object that should contain everything you need to perform a naive replacement.

alex is a lovely command-line tool that takes in text or markdown files and, using retext-equality and retext-profanities, highlights suggestions for improvement. alex checks for gendered work titles, gendered proverbs, ableist language, condescending or intolerant language, profanities, and much more.

Heck, he could even go so far and start using GitHub's automation system (Actions) to run some check on his writing. (Maybe something like alexjs)

I've been a part of several code clean-ups where giant code bases needed to be changed to considerate language. I've never once encountered a bad actor when the actual work got underway. Part of being a programmer is to question the reasoning behind large changes but any programmer worth their salt understands the big picture if you can clearly explain it. I wouldn't read too much into the actions of a few people in any programming subreddit who are opposed to pronouns. Those people will always exist. I'm certain that the vast majority of programmers in those subs are either strongly in favour of gendered pronouns or are apathetic toward it. To drive home the point, the fight for considerate language has been driven by developers themselves. All these wonderful tools such as alex.js or even org level changes inside big companies are part of it.

alex