Skip to content

v5.17.0

Compare
Choose a tag to compare
@github-actions github-actions released this 26 Jan 20:45
· 2478 commits to main since this release

Changes

Features

feat: Support REPL style reading from stdin (#2342)

feat: Support REPL style reading from stdin (#2342)

Related to #2294


feat: add `--fail-fast` cli option (#2338)

feat: add --fail-fast cli option (#2338)

Related to #2294


feat: Add `failFast` config option to exit as soon as an issue encountered (#2307)

feat: Add failFast config option to exit as soon as an issue encountered (#2307)

Closes #2294

This is my first contribution, not sure if I placed this config option in the right place, and also not sure if that's the most optimal way to test this, but I guess it works. Any feedback is appreciated.


feat: Support using `stdin` for trace. (#2300)

feat: Support using stdin for trace. (#2300)


feat: Add cli command to show suggestions. (#2299)

feat: Add cli command to show suggestions. (#2299)

New command:

Usage: cspell suggestions|sug [options] [words...]

Spelling Suggestions for words.

Options:
  -c, --config <cspell.json>            Configuration file to use.  By default
                                        cspell looks for cspell.json in the
                                        current directory.
  --locale <locale>                     Set language locales. i.e. "en,fr" for
                                        English and French, or "en-GB" for
                                        British English.
  --language-id <language>              Use programming language. i.e. "php" or
                                        "scala".
  -s, --no-strict                       Ignore case and accents when searching
                                        for words.
  --ignore-case                         Alias of --no-strict.
  --num-changes <number>                Number of changes allowed to a word
                                        (default: 4)
  --num-suggestions <number>            Number of suggestions (default: 8)
  --no-include-ties                     Force the number of suggested to be
                                        limited, by not including suggestions
                                        that have the same edit cost.
  --stdin                               Use stdin for input.
  -v, --verbose                         Show detailed output. (default: 0)
  -d, --dictionary <dictionary name>    Use dictionary.
  --dictionaries <dictionary names...>  Use dictionaries
  --no-color                            Turn off color.
  --color                               Force color
  -h, --help                            display help for command

Fixes

fix: do not depend upon @types/glob in exports. (#2346)

fix: do not depend upon @types/glob in exports. (#2346)


fix: Update tsconfig.json (#2344)

fix: Update tsconfig.json (#2344)

Related to #2341


fix: Explicitly import `types` (#2343)

fix: Explicitly import types (#2343)

fix: #2341


fix: add `--fail-fast` to cspell README.md (#2340)

fix: add --fail-fast to cspell README.md (#2340)


dev: Prepare to support Hunspell AFF to improve suggestions. (#2332)

dev: Prepare to support Hunspell AFF to improve suggestions. (#2332)


fix: (cspell-glob) Make sure `cwd` can be set. (#2316)

fix: (cspell-glob) Make sure cwd can be set. (#2316)


fix: Make sure `${cwd}/` works in globs. (#2315)

fix: Make sure ${cwd}/ works in globs. (#2315)


refactor: Clean up cspell-lib types (#2310)

refactor: Clean up cspell-lib types (#2310)


fix: (cspell) Mark forbidden and no suggest words (#2302)

fix: (cspell) Mark forbidden and no suggest words (#2302)

  • When making suggestions mark forbidden and no suggest words

fix: Move `suggestionEditCosts` into `dictionaryInformation` (#2296)

fix: Move suggestionEditCosts into dictionaryInformation (#2296)


doc: Fix example typo and update support (#2295)

doc: Fix example typo and update support (#2295)


Documentation

ci: Add workflow to build docs from cspell-types (#2313)

ci: Add workflow to build docs from cspell-types (#2313)


docs: Add some more detail on getting started. (#2306)

docs: Add some more detail on getting started. (#2306)


doc: Fix example typo and update support (#2295)

doc: Fix example typo and update support (#2295)


Maintenance

ci: Add workflow to build docs from cspell-types (#2313)

ci: Add workflow to build docs from cspell-types (#2313)


ci: Update cspell-cli.yml (#2303)

ci: Update cspell-cli.yml (#2303)


ci: clean up cspell-cli workflow (#2298)

ci: clean up cspell-cli workflow (#2298)


ci: Cache cspell results. (#2297)

ci: Cache cspell results. (#2297)