Skip to content

proselint

GitHub stars GitHub release (latest SemVer) GitHub last commit GitHub commit activity GitHub contributors

a linter for prose

proselint documentation

proselint - GitHub

Configuration in MegaLinter

Variable Description Default value
SPELL_PROSELINT_ARGUMENTS User custom arguments to add in linter CLI call
Ex: -s --foo "bar"
SPELL_PROSELINT_FILTER_REGEX_INCLUDE Custom regex including filter
Ex: (src\|lib)
Include every file
SPELL_PROSELINT_FILTER_REGEX_EXCLUDE Custom regex excluding filter
Ex: (test\|examples)
Exclude no file
SPELL_PROSELINT_CLI_LINT_MODE Override default CLI lint mode
- file: Calls the linter for each file
- list_of_files: Call the linter with the list of files as argument
- project: Call the linter from the root of the project
list_of_files
SPELL_PROSELINT_FILE_EXTENSIONS Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files
Ex: [".py", ""]
[".md", ".txt"]
SPELL_PROSELINT_FILE_NAMES_REGEX File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: ["Dockerfile(-.+)?", "Jenkinsfile"]
Include every file
SPELL_PROSELINT_PRE_COMMANDS List of bash commands to run before the linter None
SPELL_PROSELINT_POST_COMMANDS List of bash commands to run after the linter None
SPELL_PROSELINT_UNSECURED_ENV_VARIABLES List of env variables explicitly not filtered before calling SPELL_PROSELINT and its pre/post commands None
SPELL_PROSELINT_CONFIG_FILE proselint configuration file nameUse LINTER_DEFAULT to let the linter find it .proselintrc
SPELL_PROSELINT_RULES_PATH Path where to find linter configuration file Workspace folder, then MegaLinter default rules
SPELL_PROSELINT_DISABLE_ERRORS Run linter but consider errors as warnings false
SPELL_PROSELINT_DISABLE_ERRORS_IF_LESS_THAN Maximum number of errors allowed 0
SPELL_PROSELINT_CLI_EXECUTABLE Override CLI executable ['proselint']

IDE Integration

Use proselint in your favorite IDE to catch errors before MegaLinter !

IDE Extension Name Install
Atom linter-proselint Visit Web Site
IDEA Proselint
Sublime Text SublimeLinter-contrib-proselint Visit Web Site
Visual Studio Code VSCode Proselint Install in VSCode

MegaLinter Flavours

This linter is available in the following flavours

Flavor Description Embedded linters Info
all Default MegaLinter Flavor 117 Docker Image Size (tag) Docker Pulls
cupcake MegaLinter for the most commonly used languages 85 Docker Image Size (tag) Docker Pulls
documentation MegaLinter for documentation projects 51 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 63 Docker Image Size (tag) Docker Pulls
dotnetweb Optimized for C, C++, C# or VB based projects with JS/TS 72 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 53 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 55 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 60 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 54 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 62 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 51 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 51 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 54 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 51 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 55 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • Activated only if one of these files is found: .proselintrc, proselint/config.json
  • File extensions: .md, .txt

How the linting is performed

  • proselint is called once with the list of files as arguments (list_of_files CLI lint mode)

Example calls

proselint --config .proselintrc myfile.md myfile2.txt myfile3.rst

Help content

Usage: proselint [OPTIONS] [PATHS]...

  Create the CLI for proselint, a linter for prose.

Options:
  -v, --version          Show the version and exit.
  --config PATH          Path to configuration file.
  -d, --debug            Give verbose output.
  -c, --clean            Clear the cache.
  -j, --json             Output as JSON.
  -t, --time             Time on a corpus.
  --demo                 Run over demo file.
  --compact              Shorten output.
  --dump-config          Prints current config.
  --dump-default-config  Prints default config.
  -h, --help             Show this message and exit.

Installation on mega-linter Docker image