streetsidesoftware/cspell v5.12.0-alpha.0

on GitHub

added SpellingDictionaryCollection to cspell-lib exports (#1815)

I'm trying to use cspell-lib in our application (we're building a spell-checker service in node - more details here: #1813).

I need to use the SpellingDictionaryCollection class to be able to add custom dictionaries, but this class is not exported from cspell-lib. The only way to import it is:

import { SpellingDictionaryCollection } from 'cspell-lib/dist/SpellingDictionary';

But this isn't a good solution as it causes Webpack builds to fail because of non-static require() calls.

This PR adds SpellingDictionaryCollection to packages/cspell-lib/src/index.ts exports, thanks to this it can be imported this way:

import { SpellingDictionaryCollection } from 'cspell-lib';

docs: Add example of patterns configuration (#1814)

I think it will be nice if there is an example to setup patterns setting is the docs.

It may help us understand the structure of the patterns from a quick glance.

PS. The patterns used in the example is from the test file of this feature (https://github.com/streetsidesoftware/cspell/blob/5375c73e47/packages/cspell-lib/src/Settings/patterns.test.ts#L7-L18)

ci: Workflow Bot -- Update ALL Dependencies (main) (#1835)

integration-tests/package-lock.json | 69 +++++++++--------
packages/cspell-bundled-dicts/package-lock.json | 36 ++++-----
packages/cspell-dynamic-loader/package-lock.json | 69 +++++++++--------
packages/cspell-gitignore/package-lock.json | 6 +-
packages/cspell-json-reporter/package-lock.json | 69 +++++++++--------
packages/cspell-tools/package-lock.json | 18 ++---
packages/cspell-trie/package-lock.json | 6 +-
packages/cspell/package-lock.json | 64 ++++++++--------
test-packages/cspell-cli/package-lock.json | 68 +++++++++--------
test-packages/test-cspell-glob/package-lock.json | 6 +-
test-packages/test-cspell-io/package-lock.json | 6 +-
.../test-cspell-lib-webpack/package-lock.json | 48 ++++++------
test-packages/test-cspell-lib/package-lock.json | 48 ++++++------
test-packages/test-cspell-tools/package-lock.json | 86 ++++++++++++----------
test-packages/test-cspell/package-lock.json | 68 +++++++++--------
15 files changed, 365 insertions(+), 302 deletions(-)

feat: Add support for .gitignore (#1823)

Fix: #1319

On the command line:

  --gitignore                  Ignore files matching glob patterns found in .gitignore files.
  --gitignore-root <path>      Prevent searching for .gitignore files past root.

Config:

cspell.json

    /**
     * Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found.
     * @default false
     */
    useGitignore?: boolean;

    /**
     * Tells the spell checker to searching for `.gitignore` files when it reaches a matching root.
     */
    gitignoreRoot?: FsPath | FsPath[];

fix: support --no-gitignore option (#1833)

fix: Update gitignore README and normalize roots (#1832)

• fix: Update cspell-gitignore README
• fix: normalize gitignoreRoots

dev: Add cspell-gitignore package (#1821)

fix: fix home page reference. (#1817)

dev: Example of spell checking some text (#1816)

test: improve code coverage (#1824)

ci: Adjust test workflow for more caching. (#1834)