-
Notifications
You must be signed in to change notification settings - Fork 29
chore: improve code spell checker #633
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Summary of ChangesHello @riscait, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request streamlines the project's code spell checking by unifying all CSpell configurations into a single Highlights
Ignored Files
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR improves the project's spell checking setup by migrating from a VS Code-specific cSpell configuration to a centralized, tool-agnostic .cspell.yaml configuration file. This enables automated spell checking via GitHub Actions workflow.
- Consolidates spell checker dictionaries from separate files into a single YAML configuration
- Adds GitHub Actions workflow for automated spell checking on PRs and main branch
- Removes obsolete template content from README files and an unused PlantUML diagram
- Fixes a typo in a function name (
suppelementTimestamp→supplementTimestamp)
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
.cspell.yaml |
New centralized spell checker configuration with consolidated word lists and ignore patterns |
.github/workflows/spell-check.yml |
New GitHub Actions workflow to run cspell on Dart and Markdown files |
.vscode/settings.json |
Removed VS Code-specific cSpell configuration |
.cspell/project-words.txt |
Removed (words migrated to .cspell.yaml) |
.cspell/framework-words.txt |
Removed (words migrated to .cspell.yaml) |
.cspell/organization-words.txt |
Removed (words migrated to .cspell.yaml) |
packages/util/README.md |
Replaced template content with minimal package title |
packages/themes/README.md |
Replaced template content with minimal package title |
packages/flutter_app/lib/util/json_converter/timestamp_supplementer.dart |
Fixed spelling of function name |
docs/reactive-sequence.pu |
Removed unused PlantUML diagram file |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request does a great job of consolidating the spell checker configuration into a single .cspell.yaml file, which improves maintainability. The typo fix and README cleanups are also good improvements.
I've left a comment on the new .cspell.yaml file with suggestions to sort the word list and remove a few redundant entries.
One thing that stands out is the removal of docs/reactive-sequence.pu. This file appears to contain useful architecture documentation (a PlantUML sequence diagram). If its removal is intentional, it would be helpful to add a note to the pull request description explaining why. If it was removed by mistake, it should be restored. I also noticed it contained a typo 'Rivderpod' which should be 'Riverpod'.
240d19e to
d6516fb
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - "**/linux" | ||
| - "**/macos" | ||
| - "**/Pods" | ||
| - "**/test" |
Copilot
AI
Dec 25, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Excluding all test directories from spell checking prevents catching typos in test code, test documentation, and test case names. Consider removing this exclusion or being more selective (e.g., only excluding test fixtures/snapshots).
| - "**/test" |
🙌 What's Done
Pre-launch Checklist