package.json `allow` case sensitivity

[SheetJSDev]

In context, the README is describing an option WTF, which is an offensive word according to alex. The natural approach would put the offensive word within the allow block, but it seems to be case sensitive:

$ alex --version
5.0.0
$ jq '.alex' package.json 
{
  "allow": [
    "WTF"
  ]
}
$ echo "WTF is this" >> t.md
$ alex t.md 
t.md
  1:1-1:4  warning  Don’t use “WTF”, it’s profane  wtf  retext-profanities
⚠ 1 warning

When the exemption is written in lowercase, everything works:

$ jq '.alex' package.json 
{
  "allow": [
    "wtf"
  ]
}
$ cat t.md 
WTF is this
$ alex t.md 
t.md: no issues found

IMHO the exemptions should be case insensitive, especially for cases like WTF where the offending string is usually written in uppercase.

[wooorm]

The stuff you need to add to allow is this:

1:1-1:4 warning Don’t use “WTF”, it’s profane wtf retext-profanities.

So if you see a warning, add that part (the rule identifier) to allow. Due to technicalities, it’s not easy to allow any value in there, but I’m definitely for better docs! Do you have a suggestion what to add where?

[SheetJSDev]

• The README and documentation should be refreshed to reflect the current output format. The rule is included as the penultimate column in the current version but I guess it wasn't presented when the docs were last updated.

Following the example from https://github.com/wooorm/alex#command-line , the README currently claims the output for the example.md is:

example.md
  1:5-1:14   warning  `boogeyman` may be insensitive, use `boogey` instead                       boogeyman-boogeywoman
  1:42-1:48  warning  `master` / `slaves` may be insensitive, use `primary` / `replica` instead  master-slave
  2:52-2:54  warning  `he` may be insensitive, use `they`, `it` instead                          he-she
  2:61-2:68  warning  `cripple` may be insensitive, use `person with a limp` instead             cripple

⚠ 4 warnings

Running against the current version, I see:

$ alex example.md 
example.md
   1:5-1:14  warning  `boogeyman` may be insensitive, use `boogey` 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             cripple                retext-equality

⚠ 5 warnings

• Would it be possible to add column labels to the output? For the example, something like:

$ alex example.md 
example.md
   name               message                                                                    source                 rule id 
   1:5-1:14  warning  `boogeyman` may be insensitive, use `boogey` 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             cripple                retext-equality

⚠ 5 warnings

(related question: is there any way to elicit an error? If not, maybe the whole warning column should be removed)

• I haven't looked into the code , but what technical challenges are presented by optionally testing actual rather than ruleId? For example, with WTF:

> require('alex').text('WTF').messages[0]
{ [1:1-1:4: Don’t use “WTF”, it’s profane]
  message: 'Don’t use “WTF”, it’s profane',
  name: '1:1-1:4',
  file: '',
  reason: 'Don’t use “WTF”, it’s profane',
  line: 1,
  column: 1,
  location: 
   { start: { line: 1, column: 1, offset: 0 },
     end: { line: 1, column: 4, offset: 3 } },
  ruleId: 'wtf', // <-- this is the rule 
  source: 'retext-profanities',
  fatal: false,
  profanitySeverity: 2,
  actual: 'WTF', // <-- the actual text is avaiable
  expected: null }

Would it be possible to make exemptions that checked the actual value rather than ruleId? For example, the exemption !WTF would match the actual text WTF