You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I love that this project includes many tests and linters meaning that any broken links, invalid HTML or CSS/JavaScript bugs are caught before a PR can be made.
I think it'd be helpful to add a docs-spellcheck linter so that any spelling errors are caught before being merged. I propose to use the popular cSpell project as it is customizable, easy to use, has useful built-in dictionaries and has a VS Code extension, GitHub Action and CLI options.
There are some Bootstrap terms/words in the docs which show as false positives so we can add a custom dictionary which is automatically read if file is called .cspell.json (cspell.json also works but having a . at the beginning keeps all the configs together). That file would look something like this:
We can install cSpell CLI by adding "cspell": "^5.9.0", to devDependencies and then in the scripts in package.json we can add something like: "docs-spellcheck": "cspell \"site/**/*.md\"",
(I set it to scan just markdown files and not the examples HTMLs so the Arabic/RTL files are ignored).
I love that this project includes many tests and linters meaning that any broken links, invalid HTML or CSS/JavaScript bugs are caught before a PR can be made.
I think it'd be helpful to add a docs-spellcheck linter so that any spelling errors are caught before being merged. I propose to use the popular cSpell project as it is customizable, easy to use, has useful built-in dictionaries and has a VS Code extension, GitHub Action and CLI options.
There are some Bootstrap terms/words in the docs which show as false positives so we can add a custom dictionary which is automatically read if file is called
.cspell.json
(cspell.json
also works but having a . at the beginning keeps all the configs together). That file would look something like this:We can install cSpell CLI by adding
"cspell": "^5.9.0"
, to devDependencies and then in the scripts inpackage.json
we can add something like:"docs-spellcheck": "cspell \"site/**/*.md\"",
(I set it to scan just markdown files and not the examples HTMLs so the Arabic/RTL files are ignored).
Alternatively the spellcheck could just be done via GitHub Action - or just ask everyone contributing to install this extension for real-time spellcheck in VS Code. :-)
https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
The text was updated successfully, but these errors were encountered: