@double-great/double-check NPM

@double-great/double-check

Double check your writing uses inclusive language and correct spelling.

!Note \ A fork of https://github.com/get-alex/alex

This tool also uses:

Install

npm install @double-great/double-check -g

Use it

You can run double-check from your terminal and point it at a folder of files or a specific file:

double-check pages/

The command will return warnings for any rules your writing may have encountered. The rule might make sense or be totally wrong for your context. You can decide to:

Fix the warning.
For retext-spell, if it's a known word to your writing, create a dictionary and add the word(s) to it.
If a rule doesn't make sense for your writing, disable it.
For files you don't want to double check, ignore them.

Create a dictionary

Create your own dictionary to define words that are meaningful to your writing. These words will automatically be skipped by retext-spell.

Disable rules

You can disable a rule either for a single page or an entire repository.

This does not work for warnings found by retext-spell, use a dictionary instead!

For a single page

You can ignore a rule inline with an HTML comment:

<!--double-check ignore just-->
Just double check it.

You can disable a single rule for full blocks of text:

<!--double-check disable just-->
Just double check it.
<!--double-check enable just-->

A message for just this sentence will appear.

To ignore many rules for a page:

<!--double-check ignore however clear indicate-->
However, it was clear that you did not indicate you wanted the last donut.

For an entire repository

In .doublecheckrc, you can specify a list of rules to disable if you have no better alternative. The allow field is expected to be an array of rule identifier strings.

{
  "allow": ["info", "appropriate"]
}

Ignore specific files

If the are files that you do not want to double check, create a .doublecheckignore file in your repository's root that defines these file paths (kind of like .gitignore).