From 808ca1950e66cdfe4449359ef88028cd64b57e15 Mon Sep 17 00:00:00 2001 From: Jason Dent Date: Sun, 15 Aug 2021 20:47:07 +0200 Subject: [PATCH 1/2] Update README.md --- packages/cspell/README.md | 87 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 84 insertions(+), 3 deletions(-) diff --git a/packages/cspell/README.md b/packages/cspell/README.md index 662b61b4810..e30ff45c61f 100644 --- a/packages/cspell/README.md +++ b/packages/cspell/README.md @@ -38,21 +38,94 @@ The maintainers of cspell and thousands of other packages are working with Tidel npm install -g cspell ``` -## Usage +## Basic Usage Example: recursively spell check all JavaScript files in `src` +**JavaScript files** + ```sh cspell "src/**/*.js" +# or +cspell lint "src/**/*.js" ``` +**Check everything** + +```sh +cspell "**" +``` + +## Command: `lint` -- Spell Checking + +The `lint` command is used for spell checking files. + ### Help ```sh -cspell --help +cspell lint --help ``` -### Quick check +### Options + +```text +Usage: cspell lint [options] [files...] + +Check spelling + +Options: + -c, --config Configuration file to use. By default cspell + looks for cspell.json in the current directory. + + -v, --verbose display more information about the files being + checked and the configuration + + --locale Set language locales. i.e. "en,fr" for English + and French, or "en-GB" for British English. + + --language-id Force programming language for unknown + extensions. i.e. "php" or "scala" + + --wordsOnly Only output the words not found in the + dictionaries. + + -u, --unique Only output the first instance of a word not + found in the dictionaries. + + --debug Output information useful for debugging + cspell.json files. + + -e, --exclude Exclude files matching the glob pattern. This + option can be used multiple times to add multiple + globs. + + --no-issues Do not show the spelling errors. + --no-progress Turn off progress messages + --no-summary Turn off summary message in console + -s, --silent Silent mode, suppress error messages + -r, --root Root directory, defaults to current directory. + --relative Issues are displayed relative to root. + --show-context Show the surrounding text around an issue. + --show-suggestions Show spelling suggestions. + --must-find-files Error if no files are found (default: true) + --no-must-find-files Do not error is no files are found + --no-color Turn off color. + --color Force color + -h, --help display help for command + + +Examples: + cspell "*.js" Check all .js files in the current directory + cspell "**/*.js" Check all .js files from the current directory + cspell "src/**/*.js" Only check .js under src + cspell "**/*.txt" "**/*.js" Check both .js and .txt files. + cspell "**/*.{txt,js,md}" Check .txt, .js, and .md files. + cat LICENSE | cspell stdin Check stdin +``` + +## Command: `check` - Quick Visual Check + +Do a quick visual check of a file. This is a great way to see which text is included in the check. ```sh cspell check @@ -69,6 +142,14 @@ To get color in less, use `--color` and `less -r` cspell check --color | less -r ``` +## Command: `trace` - See which dictionaries contain a word + +Trace shows a the list of known dictionaries and a `*` next to the ones that contain the word. + +A `!` will appear next to the one where the word is forbidden. + +![image](https://user-images.githubusercontent.com/3740137/129488961-b99dbd2f-7daa-4462-96cd-568e0d4c3c6e.png) + ## CI/CD Continuous Integration support ### Mega-Linter From 50f89af90dfe04269ae84f4da80831bacd16affd Mon Sep 17 00:00:00 2001 From: Jason Dent Date: Mon, 16 Aug 2021 08:59:44 +0200 Subject: [PATCH 2/2] Update README.md --- packages/cspell/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/cspell/README.md b/packages/cspell/README.md index e30ff45c61f..fede401443c 100644 --- a/packages/cspell/README.md +++ b/packages/cspell/README.md @@ -146,7 +146,7 @@ cspell check --color | less -r Trace shows a the list of known dictionaries and a `*` next to the ones that contain the word. -A `!` will appear next to the one where the word is forbidden. +A `!` will appear next to the ones where the word is forbidden. ![image](https://user-images.githubusercontent.com/3740137/129488961-b99dbd2f-7daa-4462-96cd-568e0d4c3c6e.png)