/vscode-alex

A Visual Studio Code extension to find unequal phrasing in your text with alex

Primary LanguageTypeScript

vscode-alex

Dependency Status devDependency Status

A Visual Studio Code extension to find unequal phrasing in your text with alex:

Catch insensitive, inconsiderate writing.

screencast

Installation

See the extension installation guide for details.

Usage

The extension should be enabled by default, you can verify this in the VS Code settings.

It automatically checks plain text, markdown, tex or other text based files. The extension offers quick-fixes to easily replace words with suggestions from alex.

If you encounter any issues, feel free to open a ticket on github.

Extension Settings

Parameter Description Default
alex-linter.strategy Run the linter on save (onSave), on type (onType) or on user initiation (user) onSave
alex-linter.noBinary Check if pairs like 'he or she' or 'garbageman or garbagewoman' are considered errors false
alex-linter.profanitySureness Set the level of profanity check. Possible values are 'likely', 'maybe' and 'unlikely'. If set to 'maybe' words like 'addict' and 'asshat' are considered profanity. If set to 'likely' the word 'addict is not marked with a warning. maybe

Future features

  • Quick-Fix extension
    • Implement a 'change all occurrences' and 'change in all files' feature
    • Implement an 'ignore this'/'ignore all' functionality
  • Extend the filetypes to check

License

Copyright (c) 2015 Shinnosuke Watanabe

Copyright (c) 2020 Tobias Lahmann

Licensed under the MIT License.