Skip to content

Release 0.0.21 Alpha 1

Pre-release
Pre-release
Compare
Choose a tag to compare
@jsoref jsoref released this 25 Nov 20:35
· 432 commits to prerelease since this release

⏩ Upgrading

  • 🏷️ You can just change your workflow tags/references to this release, but some features require updates to the workflow (including sarif output and binary file detection); please consider applying the workflow from check-spelling/spell-check-this@prerelease. (The link will change shortly after this release is made.)
    • You will want to copy over the with: elements you're using (into each place that uses: check-spelling/check-spelling).

🐣 Breaking Changes

🗜️ Smaller cspell dictionaries

Background

There are 3 related configuration items:

  • dictionary_source_prefixes
    • In v0.0.20, this had: "cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220427/dictionaries/"
    • In v0.0.21, it has: "cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/"
  • extra_dictionaries
  • check_extra_dictionaries
    • The list has changed between v0.0.20 and v0.0.21, a bunch have moved, some have split, and a bunch have been added.

Migrating

You can migrate in a couple of ways:

  • Assuming you haven't set dictionary_source_prefixes, you can temporarily clear extra_dictionaries and check_extra_dictionaries and then use one run to get a new set of recommended extra_dictionaries and then set check_extra_dictionaries (typically to '').
  • If you want to keep your current cspell extra_dictionaries, rename cspell to cspell_old (or anything that isn't cspell) and set dictionary_source_prefixes to something like this: {"cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/", "cspell_old": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220427/dictionaries/"}.

Note that the main branch for check-spelling/cspell-dicts will move (roughly at the time of the v0.0.21 release and again for future releases).

💔 act

Act is broken in v0.0.21-alpha1. It should work better in v0.0.21-alpha2.

✨ New features

🔧 Tuning

💅 Minor polish


Note that there are nearly 100 commits in this release, the above is not a complete list of features. I'll try to improve the list for the official release.

Full Changelog: v0.0.20...v0.0.21-alpha1