Skip to content

Releases: streetsidesoftware/cspell

v5.15.2

11 Jan 16:08
Compare
Choose a tag to compare

Changes

Fixes

fix: Fix issue with `maxDuplicateProblems` setting (#2237)

fix: Fix issue with maxDuplicateProblems setting (#2237)

Discussion #2231


fix: Fix backwards compatibility for Reporters (#2229)

fix: Fix backwards compatibility for Reporters (#2229)


v5.15.1

07 Jan 15:46
Compare
Choose a tag to compare

Changes

doc: Update cspell-types docs (#2190)

doc: Update cspell-types docs (#2190)


Fixes

fix: Fix type for some older TypeScript parsers. (#2191)

fix: Fix type for some older TypeScript parsers. (#2191)


Maintenance

ci: Integration - remove repo-by-repo updates (#2227)

ci: Integration - remove repo-by-repo updates (#2227)


v5.15.0

07 Jan 14:01
Compare
Choose a tag to compare

Changes

docs: Update Types in docs (#2156)

docs: Update Types in docs (#2156)


docs: Update README.md (#2155)

docs: Update README.md (#2155)


Features

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

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)

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)

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


Fixes

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

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

This fixes issues with ignorePaths and overrides.


fix: Update dictionaries (#2173)

fix: Update dictionaries (#2173)


Maintenance

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

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


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

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

  • add shoelace
  • update apollo

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

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


chore: Update cspell-action (#2181)

chore: Update cspell-action (#2181)

Use Major version


ci: clean up word list (#2159)

ci: clean up word list (#2159)


ci: Add integration with `bootstrap` (#2157)

ci: Add integration with bootstrap (#2157)


Minor Breakage

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

v5.14.0

29 Dec 11:58
Compare
Choose a tag to compare

Changes

docs: Update `cspell` README (#2147)

docs: Update cspell README (#2147)

Related to #1850

  • Include --file-list option in README.

style(schema, types): fix few typos and add full stops at the end of all descriptions (#2123)

style(schema, types): fix few typos and add full stops at the end of all descriptions (#2123)

While setting up cspell for one project, I noticed few typos in JSON schema.

Fixed those quickly, but then I saw that some descriptions end with a full stop and some do not. Just couldn’t leave it.

At first this minor inconsistency did not look important, but the result makes the schema look somewhat nicer.


Features

feat: Support `--file-list` cli option (#2130)

feat: Support --file-list cli option (#2130)

Related to #1850


Fixes

fix: Make sure help is not shown if the file list is empty. (#2150)

fix: Make sure help is not shown if the file list is empty. (#2150)


fix: Upgrade HTML dictionary (#2131)

fix: Upgrade HTML dictionary (#2131)


dev: Add gitpod config (#2126)

dev: Add gitpod config (#2126)


fix: #2077 (#2114)

fix: #2077 (#2114)


Maintenance

ci: clean up snapshot workflow (#2149)

ci: clean up snapshot workflow (#2149)


ci: add a workflow to keep the snapshots up-to-date (#2148)

ci: add a workflow to keep the snapshots up-to-date (#2148)


v5.13.4

18 Dec 14:03
Compare
Choose a tag to compare

Changes

feat: report error and fail for unsupported NodeJS versions (#1984) (#2111)

feat: report error and fail for unsupported NodeJS versions (#1984) (#2111)

Change addressing #1984.

@Jason3S, is this how you'd like it handled?


Fixes

fix: hunspell - honor minimum compound word length (#2091)

fix: hunspell - honor minimum compound word length (#2091)


Maintenance

ci: cspell4 - Update update-dependencies-cspell4.yml (#2105)

ci: cspell4 - Update update-dependencies-cspell4.yml (#2105)


ci: Use `npm-check-updates` to update dependencies (#2094)

ci: Use npm-check-updates to update dependencies (#2094)


v5.13.3

11 Dec 17:36
Compare
Choose a tag to compare

Changes

Fixes

dev: Add awareness of Monkey C (#2089)

dev: Add awareness of Monkey C (#2089)


fix: Hunspell make sure COMPOUNDFLAG is supported (#2088)

fix: Hunspell make sure COMPOUNDFLAG is supported (#2088)


fix: cspell-tools - limit memory usage when build dictionaries (#2087)

fix: cspell-tools - limit memory usage when build dictionaries (#2087)

When compiling Estonian, it would cause node to run out of keys due to caching highly repetitive suffixes.


v5.13.2

07 Dec 09:44
Compare
Choose a tag to compare

Changes

fix: jest/expect-expect warning (#2062)

fix: jest/expect-expect warning (#2062)

Inlined the code since it couldn't understand the double redirection


chore: add setup-node caching to remaining jobs (#2043)

chore: add setup-node caching to remaining jobs (#2043)

It was already setup for some of the jobs, this extends it to the rest


fix: Update TypeScript extensions (#2051)

fix: Update TypeScript extensions (#2051)


Fixes

fix: make cspell aware of PureScript and Dhall (#2067)

fix: make cspell aware of PureScript and Dhall (#2067)


Maintenance

ci: Remove eslint-plugin-promise (#2076)

ci: Remove eslint-plugin-promise (#2076)

Add it back when Support ESLint 8.x · Issue #218 · xjamundx/eslint-plugin-promise is resolved.


ci: Update eslint (#2075)

ci: Update eslint (#2075)


ci: always use the same version of npm. (#2068)

ci: always use the same version of npm. (#2068)


v5.13.1

24 Nov 20:18
Compare
Choose a tag to compare

Changes

Fixes

fix: fix #2011 (#2013)

fix: fix #2011 (#2013)

Turn on exactOptionalPropertyTypes for types.


v5.13.0

17 Nov 07:55
Compare
Choose a tag to compare

Changes

docs: Add more glob examples (#1977)

docs: Add more glob examples (#1977)


docs: Update generated docs (#1958)

docs: Update generated docs (#1958)


Features

feat: Support `--dot` command line option. (#1985)

feat: Support --dot command line option. (#1985)

fix: #1980


Fixes

dev: Catch forbidden whole words (#2000)

dev: Catch forbidden whole words (#2000)

Fix #1953


dev: Refactor cache files (#1986)

dev: Refactor cache files (#1986)

  • Remove any circular import references.
  • Move interfaces next to the supporting code.

dev: Update workflow for cspell4 (#1965)

dev: Update workflow for cspell4 (#1965)


fix: Update schema generator (#1957)

fix: Update schema generator (#1957)

The JSON schema will now include the deprecated flag.


fix: integration - turn off case sensitivity for German (#1952)

fix: integration - turn off case sensitivity for German (#1952)


fix: Add `enableCaseSensitive`/`disableCaseSensitive` (#1951)

fix: Add enableCaseSensitive/disableCaseSensitive (#1951)

Support enableCaseSensitive/disableCaseSensitive in document settings.


Maintenance

ci: Add integration pagekit (#1956)

ci: Add integration pagekit (#1956)


v5.12.6

04 Nov 13:29
Compare
Choose a tag to compare

Changes

doc: Update docs for CSpell types (#1949)

doc: Update docs for CSpell types (#1949)


Fixes

dev: Update C# dictionary (#1947)

dev: Update C# dictionary (#1947)


fix: Include configuration for VUE and Swift by default. (#1946)

fix: Include configuration for VUE and Swift by default. (#1946)