Skip to content

Expand the default block-list #19

@JakeSummers

Description

@JakeSummers

Good Morning!

This is a pretty nifty package. I would be interested in starting to use it.

One current limitation of this tool is that the default block-list is pretty limited:

parser.add_argument('--blocklist', help='Comma separated list of words '
'to lint in any context, with possibly special '
'characters between, case insensitive; '
'DEFAULT to master,slave,whitelist,blacklist')

This tool would be significantly more useful if it came packaged with a more extensive block-list. Right now, I need to make the block-list and get it code-reviewed (which I anticipate will be difficult).

In the readme, this alexjs is cited as inspiration:

This project is inspired by [Alex.js](https://alexjs.com).

I did a quick look and it seems like alexjs comes with a very comprehensive block-list via the retext-equality npm package. The full block-list is here: https://github.com/retextjs/retext-equality/tree/main/data/en

They also provide acceptable alternatives (with sources :) ) so that you can create output like this:

example.md
   1:5-1:14  warning  `boogeyman` may be insensitive, use `boogeymonster` instead                boogeyman-boogeywoman  retext-equality
  1:42-1:48  warning  `master` / `slaves` may be insensitive, use `primary` / `replica` instead  master-slave           retext-equality
  1:69-1:75  warning  Don’t use `slaves`, it’s profane                                           slaves                 retext-profanities
  2:52-2:54  warning  `he` may be insensitive, use `they`, `it` instead                          he-she                 retext-equality
  2:61-2:68  warning  `cripple` may be insensitive, use `person with a limp` instead             gimp                   retext-equality

⚠ 5 warnings

Source

It would be awesome if we could do the following:

  1. Copy the data from https://github.com/retextjs/retext-equality/tree/main/data/en into this repo
  2. Use that as the default block-list
  3. Add support for suggesting alternatives.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions