docs: add how-to guides for extra dictionaries and pre-commit setup - #808
Merged
Conversation
Copilot created this pull request from a session on behalf of
Jason3S
June 16, 2026 06:10
View session
Contributor
|
Would you review the result? Suggestions are welcome. I'll read it a bit later today. |
There was a problem hiding this comment.
Pull request overview
This PR restructures cspell-cli documentation by moving configuration examples out of README.md into dedicated docs/ how-to guides, and adds new guides for using extra dictionaries (including cspell-dicts) and pre-commit setups.
Changes:
- Replace the README’s inline custom-dictionary instructions with a “How-To Guides and Configuration Examples” index.
- Add new docs covering: custom dictionaries, importing language dictionaries from
cspell-dicts, override-based dictionary activation, and a Frenchpre-commitexample. - Update examples to reference
cspell-cliv10.0.1.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Replaces inline custom dictionary content with links to new docs pages. |
| docs/use-a-custom-dictionary.md | Moves custom dictionary setup guidance into standalone doc. |
| docs/use-dictionaries-from-cspell-dicts.md | Documents adding non-default language dictionaries via additional_dependencies + import. |
| docs/file-or-folder-based-overrides.md | Shows enabling dictionaries by glob/folder using overrides (and an inline directive alternative). |
| docs/pre-commit-example-setup-for-french.md | Provides an end-to-end French dictionary example for pre-commit and cspell config. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
I've only had a few moments for a quick skim, but it is looking good. |
- Restore correct "CSpell" capitalization in the VS Code command palette reference (a prior commit on this branch had inverted it to "cSpell"). - Fix additional_dependency -> additional_dependencies (the actual pre-commit config key) in the cspell-dicts how-to. - Wrap the pinned `rev: v10.0.1` example blocks in the French and cspell-dicts how-tos with the same x-release-please markers used in README.md, and add both files to release-please-config.json's extra-files list, so the version stays in sync on future releases instead of going stale.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR #207 (by @danielfdickinson) stalled without merging. This duplicates and updates it with all review feedback applied and versions bumped to v10.0.1.
Changes
README.mdNew
docs/pagesuse-a-custom-dictionary.md— content moved verbatim from READMEuse-dictionaries-from-cspell-dicts.md— adding language dicts viaadditional_dependencies+importfile-or-folder-based-overrides.md— enabling a dictionary per file glob usingoverridespre-commit-example-setup-for-french.md— end-to-end French locale exampleReview feedback from #207 applied
shellscriptfiles), then shows the fix<!--- cspell:dictionaries bash --->documented as a single-file shortcutpre-commitparity noted inline rather than duplicating a full invocation section