Skip to content

Better spellcheck and markdown linting

Lars Bilke requested to merge bilke/ogs:linting into master

Quite large MR, review commit-wise (if you want to review at all...).

Implements two new checks:

  • markdownlint-cli as a pre-commit check
  • spell-check with vale also as a pre-commit check, uses American and British dictionary, can be reduced to British dictionary later on ...

Vale errors are output in the pre-commit check, e.g.:

Lint prose

 web/content/docs/devguide/getting-started/prerequisites/index.md
 27:29  error  'the' is repeated!  Vale.Repetition

Vale warnings and suggestions are added to the code quality issue list (similar to cppcheck issues).

Vale currently checks web/content-only. Documentation and source code may be added later.

Outlook: Vale is super-configurable so we can add more specific checks in the future. See e.g. checks in GitLabs repo.

Fixes #3293 (closed), #3015 (closed).

  1. Feature description was added to the changelog
  2. Tests covering your feature were added?
Edited by Lars Bilke

Merge request reports