cspell 5.15.0

v5.15.0

on Node.js NPM

docs: Update Types in docs (#2156)

docs: Update README.md (#2155)

feat: Add support for cache options in config files. (#2184)

A new config section has been added, cache.

As a rule, any options specified on the command line override options in the configuration files.

cspell.json

{
    cache?: CacheSettings;
}

CacheSettings:

{
    /**
     * Store the results of processed files in order to only operate on the changed ones.
     * @default false
     */
    useCache?: boolean;

    // cspell:word cspellcache
    /**
     * Path to the cache location. Can be a file or a directory.
     * If none specified `.cspellcache` will be used.
     * Relative paths are relative to the config file in which
     */
    cacheLocation?: FSPathResolvable;

    /**
     * Strategy to use for detecting changed files, default: metadata
     * @default 'metadata'
     */
    cacheStrategy?: CacheStrategy;
}

New CLI Option --no-cache

• --no-cache ensures that the cache is not used even if cspell.json has caching enabled.

feat: Remove 40 character limit on spell checking words (#2175)

Adjust Base64 Detection

The Base64 detection pattern was preventing words longer than 40 characters from being spell checked. It has been turned off by default. To turn it back on add Base64 to ignoreRegExpList in CSpell settings.

A few new patterns were added by default to pick up many of the common cases that Base64 was designed for:

• Base64SingleLine - a stricter version Base64 detection that only matches single lines.
• Base64MultiLine - a stricter version Base64 detection that only matches multiple line Base64 strings.
• Hashes - detects common hash patterns:
  Example: sha1-tdRU3CGZriJWmfNGfloH87lVuv0=
  Supported prefixes:
  • sha1, sha256, sha512, md5, base64, crypt, bcrypt, scrypt, security-token, assertion

Minor Breakage

Because Base64 prevented anything longer than 40 characters from being checked, some misspellings might show up that were previously ignored.

feat: Invalidate cache when config has changed (#2160)

Cached entries are invalidated if a dependency config or dictionary changes since the entry was made.

Fixes: #1852

fix: make config file version 0.2 by default. (#2186)

This fixes issues with ignorePaths and overrides.

fix: Update dictionaries (#2173)

ci: Update the list of integrations to be checked. (#2188)

ci: for integration tests, make ** the default (#2187)

• add shoelace
• update apollo

ci: Add integration test for apollo-server (#2185)

chore: Update cspell-action (#2181)

Use Major version

ci: clean up word list (#2159)

ci: Add integration with bootstrap (#2157)