Cwa-documentation: Feat: Integrate alex scanner for inconsiderate language

Created on 29 Jun 2020  路  3Comments  路  Source: corona-warn-app/cwa-documentation

Once documentation linter #215 is integrated we could add alex to further improve language.

bug documentation

All 3 comments

Out of curiosity I ran this against the documents and the output is something like this:


overview-security.md
      41:18-41:27  warning  Be careful with `hijacking`, it鈥檚 profane in some cases                                                                             hijacking         retext-profanities
      56:18-56:27  warning  Be careful with `hijacking`, it鈥檚 profane in some cases                                                                             hijacking         retext-profanities
      71:18-71:27  warning  Be careful with `hijacking`, it鈥檚 profane in some cases                                                                             hijacking         retext-profanities
      73:24-73:30  warning  Be careful with `attack`, it鈥檚 profane in some cases                                                                                attack            retext-profanities
      86:18-86:27  warning  Be careful with `hijacking`, it鈥檚 profane in some cases                                                                             hijacking         retext-profanities
     108:8-108:19  warning  Reconsider using `Penetration`, it may be profane                                                                                   penetration       retext-profanities
     118:8-118:19  warning  Reconsider using `Penetration`, it may be profane                                                                                   penetration       retext-profanities
     124:8-124:19  warning  Reconsider using `Penetration`, it may be profane                                                                                   penetration       retext-profanities
    126:55-126:64  warning  Be careful with `hijacking`, it鈥檚 profane in some cases                                                                             hijacking         retext-profanities
    136:70-136:76  warning  Be careful with `attack`, it鈥檚 profane in some cases                                                                                attack            retext-profanities
  310:187-310:190  warning  Be careful with `die`, it鈥檚 profane in some cases                                                                                   die               retext-profanities
    359:50-359:56  warning  Be careful with `attack`, it鈥檚 profane in some cases                                                                                attack            retext-profanities
    361:43-361:50  warning  Be careful with `attacks`, it鈥檚 profane in some cases                                                                               attacks           retext-profanities
     364:52-365:3  warning  Be careful with `attack`, it鈥檚 profane in some cases                                                                                attack            retext-profanities
     365:31-366:3  warning  Be careful with `attack`, it鈥檚 profane in some cases                                                                                attack            retext-profanities
  386:114-386:121  warning  `clearly` may be insensitive, try not to use it                                                                                     clearly           retext-equality
  386:338-386:347  warning  Be careful with `execution`, it鈥檚 profane in some cases                                                                             execution         retext-profanities
    395:48-395:57  warning  `blacklist` may be insensitive, use `blocklist`, `wronglist`, `banlist`, `deny list` instead                                        blacklist         retext-equality
    395:58-395:67  warning  `whitelist` may be insensitive, use `passlist`, `alrightlist`, `safelist`, `allow list` instead                                     whitelist         retext-equality

pruefsteine.md
        5:27-5:35  warning  Be careful with `European`, it鈥檚 profane in some cases                                                                              european          retext-profanities
      7:333-7:339  warning  Be careful with `German`, it鈥檚 profane in some cases                                                                                german            retext-profanities
    19:307-19:313  warning  Be careful with `period`, it鈥檚 profane in some cases                                                                                period            retext-profanities
      37:81-37:87  warning  Be careful with `period`, it鈥檚 profane in some cases                                                                                period            retext-profanities
    37:140-37:146  warning  Be careful with `period`, it鈥檚 profane in some cases                                                                                period            retext-profanities
       41:7-41:13  warning  Be careful with `remain`, it鈥檚 profane in some cases                                                                                remain            retext-profanities
    41:112-41:118  warning  Be careful with `remain`, it鈥檚 profane in some cases                                                                                remain            retext-profanities
    45:203-45:209  warning  Be careful with `attack`, it鈥檚 profane in some cases                                                                                attack            retext-profanities
    45:272-45:276  warning  `just` may be insensitive, try not to use it                                                                                        just              retext-equality
    49:127-49:131  warning  `just` may be insensitive, try not to use it                                                                                        just              retext-equality
    65:147-65:153  warning  Be careful with `period`, it鈥檚 profane in some cases                                                                                period            retext-profanities
    65:255-65:261  warning  Be careful with `period`, it鈥檚 profane in some cases                                                                                period            retext-profanities
    71:320-71:327  warning  Be careful with `attacks`, it鈥檚 profane in some cases                                                                               attacks           retext-profanities
    73:390-73:396  warning  Be careful with `attack`, it鈥檚 profane in some cases 

I believe this should be part of the linting pipeline just with warnings so people can adjust the language if needed, but not blocking a merge. We can alrightlist _German_ and other words since I hope they are not profane ;D

That looks like a worthwhile addition. Especially with many non-native speakers (like myself) writing the documents ;)

Its now part of the PR.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

oezguercelebi picture oezguercelebi  路  3Comments

kbobrowski picture kbobrowski  路  3Comments

TomTeeJay picture TomTeeJay  路  3Comments

proteusGIT picture proteusGIT  路  3Comments

AndiLeni picture AndiLeni  路  3Comments