Skip to content

Commit

Permalink
docs: Add better instructions on how to run cspell locally (#2782)
Browse files Browse the repository at this point in the history
Add better instructions on how to run cspell locally
  • Loading branch information
luanpotter authored Oct 1, 2023
1 parent 0fb53ef commit d33bb4a
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,26 @@ command once.

> You do not need to run `flutter pub get` once bootstrap has been completed.

#### CSpell

If you want to run the spellchecker locally, you will have to install
[cspell](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell);
you can do so using npm or yarn:

```bash
npm install -g cspell
```

Then you can run it with the following arguments:

```bash
cspell --no-progress -c .github/cspell.json "**/*.{md,dart}"
```


#### Markdown Lint

If you want to lint the markdown files you have to install
[markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) and once that is installed you
can run `melos markdown-check` to check if the markdown follows the rules. Some markdown linting
Expand Down

0 comments on commit d33bb4a

Please sign in to comment.