Skip to content

Feature: Suggest dictionaries when dictionaries aren't available

Josh Soref edited this page May 4, 2023 · 3 revisions

Suggest dictionaries when dictionaries aren't available

Background

When check-spelling upgrades, it occasionally changes its cspell alias to use a new set of dictionaries. When this happens, some dictionaries may no longer be available. Configured dictionaries as of v0.0.21 must be available, otherwise it will quit with a fatal error.

Prerelease flow

In prerelease, check-spelling at least includes a GitHub Job Summary which leads to the Events page with enough information for how users can recover from this.

Improved flow

It's possible for check-spelling to reset its cspell alias, its extra_dictionaries and check_extra_dictionaries and raise the extra_dictionary_limit and then run based on that.

When it's done, it can suggest removing the unavailable dictionaries and users can select from the suggested dictionaries.

Clone this wiki locally