generated from nhcarrigan/template
deps: update cspell to 9.6.0 #27
Open
minori
wants to merge 4 commits from
dependencies/update-cspell into main
pull from: dependencies/update-cspell
merge into: nhcarrigan:main
nhcarrigan:main
nhcarrigan:dependencies/update-mermaid
nhcarrigan:dependencies/update--astrojs-starlight
nhcarrigan:dependencies/update-astro
nhcarrigan:dependencies/update-vitest
nhcarrigan:dependencies/update-astro-mermaid
nhcarrigan:fix/remove-forum-references
nhcarrigan:chore/audit-contributing-docs
No Reviewers
Labels
Clear labels
aspect
code
Concerns the software code in the repository
aspect
dx
Concerns developers' experience with the codebase
aspect
interface
Concerns end-users' experience with the software
aspect
text
Concerns the documentation material in the repository
contribute
good first issue
A great opportunity for a team member to learn a new codebase
contribute
help wanted
Open for anyone on our team to grab.
contribute
staff only
Restricted to our executive leadership.
goal
addition
Addition of new feature
goal
fix
Bug fix
goal
improvement
Improvement to an existing feature
points
1
Very simple issue requiring minimal effort and complexity.
points
13
Extremely complex issue representing major undertakings. Should be broken down into smaller pieces.
points
2
Simple issue that requires a bit more thought or investigation.
points
3
Moderate complexity issue requiring more substantial work.
points
5
Complex issue requiring significant effort and expertise.
points
8
Very complex issue requiring extensive work and deep expertise.
priority
critical
1
Must be fixed ASAP
priority
high
2
Stalls work on the project or its dependents
priority
low
4
Low priority and doesn't need to be rushed
priority
medium
3
Not blocking but should be fixed soon
priority
none
5
No priority, should only be performed when a developer is available
status
awaiting triage
Has not been triaged & therefore, not ready for work
status
blocked
Blocked and therefore not ready for work
status
discarded
Will not be worked on
status
discontinued
Not suitable for work as repo is in maintenance
status
label work required
Needs proper labelling before it can be worked on
status
ready for dev
Ready for work
status
ticket work required
Needs more details before it can be worked on
talk
discussion
Open for discussions and feedback
talk
question
Can be resolved with an answer
time
1 day
Approximately one full day of development work.
time
1-2 weeks
One to two weeks of focused development effort.
time
2-3 days
Two to three days of development effort.
time
4-5 days
Approximately one week of development work.
time
<1 day
Less than one day of focused work. Quick fixes or simple tasks.
time
>2 weeks
More than two weeks of development work. Must be broken down into smaller pieces.
No Label
Milestone
No items
No Milestone
Assignees
gurkirat
hanna (Hanna Rose)
hikari (Hikari)
minori (Minori)
naomi (Naomi Carrigan)
rain
teklu
tim
Clear assignees
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: nhcarrigan/docs#27
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Delete Branch "dependencies/update-cspell"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Dependency Update
Updates cspell from
9.4.0to9.6.0.Type
devDependencies
Changelog
Changelog
v9.6.0
Features
feat: ESLint-plugin -- Distinguish between Forbidden, Misspelled, and Unknown words. (#8337)
feat: ESLint-plugin -- Distinguish between Forbidden, Misspelled, and Unknown words. (#8337)
Pull request overview
This PR updates the eslint-plugin to report different types of spelling issues with improved categorization and messaging. The changes include upgrading ESLint from v8 to v9, introducing new issue severity levels (Forbidden, Misspelled, Unknown, Hint), and adding a
reportoption to control the level of reporting.Changes:
reportoption ('all', 'simple', 'typos', 'flagged') to control which types of issues are reportedfeat: ESLint-plugin -- Add `report` option to be able to control the reporting level (matching the CLI): "all", "simple", "typos", "flagged". (#8273)
feat: ESLint-plugin -- Add
reportoption to be able to control the reporting level (matching the CLI): "all", "simple", "typos", "flagged". (#8273)Pull request overview
This PR adds support for unknown word reporting options to the cspell ESLint plugin, allowing users to control which types of spelling issues are reported (all unknown words, simple typos, common typos, or only flagged words).
Changes:
reportoption to the ESLint plugin configuration with values: 'all', 'simple', 'typos', and 'flagged'reportoption to CSpell'sunknownWordssettingThis
PRcontains the changes required to resolvecspell ESLint plugin: support typos-only reporting (CLI --report typos / unknownWords report-common-typos) #8261feat: support storing suggestions in trie (#8228)
feat: support storing suggestions in trie (#8228)
Pull request overview
This PR adds support for storing word suggestions directly in trie data structures, enabling dictionaries to provide preferred spelling suggestions for words. The implementation introduces a new
suggestionPrefixfield (default:) toTrieInfoand ahasPreferredSuggestionscharacteristic flag.Key Changes:
suggestionPrefixfieldisCaseAwarefield fromTrieInfo(minor breaking change since it was no longer used)word:suggestionandword->suggestionDetails
Add support to have suggestion in normal word lists:
Note:
:or->separators can be used in the word list.Examples:
You can add more than one suggestion, but auto-fix won't be possible since
the spell checker cannot determine which one you want.
feat: Add Support reading / writing bTrie files (#8204)
feat: Add Support reading / writing bTrie files (#8204)
Pull request overview
This pull request adds support for reading and writing binary Trie (bTrie) files, which is a more efficient binary format for storing trie data structures. The changes make the cspell-trie-lib package more platform-neutral by replacing Node.js-specific APIs (like
Bufferandos.endianness()) with Web standard APIs (Uint8Array,TextEncoder/TextDecoder, and a custom endianness detection function).Changes:
btrieto cspell-tools for generating bTrie filesFixes
refactor: extract processFile from lint.ts (#8344)
refactor: extract processFile from lint.ts (#8344)
fix: Improve word lookup performance when not found (#8330)
fix: Improve word lookup performance when not found (#8330)
Pull request overview
This PR improves word lookup performance when words are not found by optimizing how the spell checker generates different word forms for dictionary lookups. The key optimization is to avoid expensive Unicode normalization and replacement mapping operations when they're not needed.
Changes:
mapWordfrom required to optional on SpellingDictionary interface, usingundefinedfor dictionaries that don't need word mappingWhen a word is not found, the spell checker tries many different forms to find the word. This can be expensive if a lot of words are not found.
fix: Improve loading time of dictionaries (#8318)
fix: Improve loading time of dictionaries (#8318)
Pull request overview
This pull request aims to improve the loading time of dictionaries by optimizing the internal data structures and sorting algorithms used in the trie builder. The changes focus on:
fix: Reduce loading time of dictionaries. (#8316)
fix: Reduce loading time of dictionaries. (#8316)
fix: Support loading btrie dictionaries in cspell-lib (#8311)
fix: Support loading btrie dictionaries in cspell-lib (#8311)
Pull request overview
This PR adds support for loading btrie (binary trie) dictionaries in cspell-lib, enabling more efficient dictionary storage and loading. The changes also include enhancements to the table utility for better formatting and a refactoring of performance measurement tracking to use a hierarchical structure.
fix: Improve loading performance a bit. (#8309)
fix: Improve loading performance a bit. (#8309)
fix: Prepare tools to generate btrie files. (#8298)
fix: Prepare tools to generate btrie files. (#8298)
fix: Optimize btrie files when building (#8285)
fix: Optimize btrie files when building (#8285)
Have CSpell Tools optimize the Trie while building. We are trying to reduce the size of the file.
fix: Add `btrie` path to dictionary definition (#8284)
fix: Add
btriepath to dictionary definition (#8284)Make it possible for a dictionary to specify a btrie path in addition to the normal
path.fix: Work towards support prefixes when walking ITrie (#8276)
fix: Work towards support prefixes when walking ITrie (#8276)
fix: Fix CStyleHexValue to handle BigInt values. (#8282)
fix: Fix CStyleHexValue to handle BigInt values. (#8282)
Example:
0xffff_ffff_ffffnrefactor: Remove FastTrieBlob (#8267)
refactor: Remove FastTrieBlob (#8267)
fix: Make endian required when encoding a StringTable (#8265)
fix: Make endian required when encoding a StringTable (#8265)
refactor: Removed FastTrieBlob part 1 (#8266)
refactor: Removed FastTrieBlob part 1 (#8266)
FastTrieBlob served it purpose. It is now time for it to be retired since it is too difficult to maintain in parallel with TrieBlob.
fix: Support string prefixes when walking nodes (#8259)
fix: Support string prefixes when walking nodes (#8259)
refactor: Document TrieBlob format (#8256)
refactor: Document TrieBlob format (#8256)
fix: adjust error message (#8249)
fix: adjust error message (#8249)
fix: Add StringTable and refactor BinaryFormat (#8243)
fix: Add StringTable and refactor BinaryFormat (#8243)
refactor: Rename private methods in TrieBuilder (#8240)
refactor: Rename private methods in TrieBuilder (#8240)
refactor: A bit of refactoring of utf8 naming (#8239)
refactor: A bit of refactoring of utf8 naming (#8239)
refactor: Add GTrie class for later (#8238)
refactor: Add GTrie class for later (#8238)
refactor: import using .ts when the package is bundled. (#8224)
refactor: import using .ts when the package is bundled. (#8224)
fix: Add cspell-tools config option to gen btrie (#8221)
fix: Add cspell-tools config option to gen btrie (#8221)
Add an option to tell the cspell-tools compiler to build btrie files.
feat: auto load btrie files if available (#8218)
feat: auto load btrie files if available (#8218)
Pull request overview
This pull request adds automatic loading of btrie (binary trie) files as a performance optimization when loading dictionaries from node_modules. The feature checks for .btrie or .btrie.gz files before falling back to .txt or .trie files, potentially improving dictionary loading performance with the more efficient binary format.
Changes:
When loading dictionaries from
node_modules, try to loadbtriefiles before loading a.txtor.triefile.fix: Minor perf boost to TrieBlob.#findNode (#8213)
fix: Minor perf boost to TrieBlob.#findNode (#8213)
fix: deprecated legacy trie.has (#8196)
fix: deprecated legacy trie.has (#8196)
fix: Improve speed of dictionary lookup (#8193)
fix: Improve speed of dictionary lookup (#8193)
fix: Run perf tests on trie-lib (#8188)
fix: Run perf tests on trie-lib (#8188)
fix: Force consistent type imports (#8187)
fix: Force consistent type imports (#8187)
fix: Support adding separators when tracing compound words (#8176)
fix: Support adding separators when tracing compound words (#8176)
Pull request overview
This pull request adds support for compound word separation when tracing words in cspell. When a compound word is found, it can now be displayed with a custom separator (e.g., "type•script•config" instead of "typescriptconfig").
Changes:
compoundSeparatoroption to trace and find APIs across multiple layersDictionary Updates
fix: Workflow Bot -- Update Dictionaries (main) (#8326)
fix: Workflow Bot -- Update Dictionaries (main) (#8326)
Update Dictionaries (main)
Summary
fix: Workflow Bot -- Update Dictionaries (main) (#8277)
fix: Workflow Bot -- Update Dictionaries (main) (#8277)
Update Dictionaries (main)
Summary
fix: Workflow Bot -- Update Dictionaries (main) (#8192)
fix: Workflow Bot -- Update Dictionaries (main) (#8192)
Update Dictionaries (main)
Summary
fix: Workflow Bot -- Update Dictionaries (main) (#8186)
fix: Workflow Bot -- Update Dictionaries (main) (#8186)
Update Dictionaries (main)
Summary
fix: Workflow Bot -- Update Dictionaries (main) (#8182)
fix: Workflow Bot -- Update Dictionaries (main) (#8182)
Update Dictionaries (main)
Summary
Documentation
refactor: landing page update (#8211)
refactor: landing page update (#8211)
Description
This PR introduces a new landing page for the
cspellpackage, leveraging the ability to write customReactcomponents in Docosaurus. The PR introduces new colour variants and a few newmdpages for sections that were removed from the previous home page structure.Video
https://github.com/user-attachments/assets/0773b4b5-2e4a-418e-aa6c-5a6e4209798c
https://github.com/user-attachments/assets/7e846066-fdac-44ae-b731-c206eadd822e
Thank you!
v9.5.0
Features
feat: Report errors with nested config files (#8155)
feat: Report errors with nested config files (#8155)
fixes: #7837
Errors in nested configuration files were ignored. This lead to unexpected behavior.
Note: this is a fix, but since it can impact existing installs, it is marked as a feature change.
fix: Enable cts config support (#8152)
fix: Enable cts config support (#8152)
Add support for
.ctsconfig files.Update docs with
ts,mts, andctsconfig.Fixes
fix: Add cspell-tools option keepUncompressed (#8163)
fix: Add cspell-tools option keepUncompressed (#8163)
fix: Improve CSpell Tools (#8160)
fix: Improve CSpell Tools (#8160)
Generate both compressed and non-compressed files when
compress: true. This allows cspell-dicts to keep track of changes and have compressed files at the same time.fix: Make sure `cspell` exports `defineConfig ` for CommonJS (#8156)
fix: Make sure
cspellexportsdefineConfigfor CommonJS (#8156)Dictionary Updates
fix: Workflow Bot -- Update Dictionaries (main) (#8149)
fix: Workflow Bot -- Update Dictionaries (main) (#8149)
Update Dictionaries (main)
Summary
✨ This PR was created by Minori, your friendly dependency updater! 🌸
View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.