chore(infra/cspell): add cspell spell checking

[SoonIter]

Summary

• Add cspell configuration (cspell.config.cjs) modeled after the rspress repository
• Add custom dictionary (scripts/dictionary.txt) with project-specific terms (rstack ecosystem, debugging tools, etc.)
• Add cspell and cspell-ban-words as dev dependencies
• Integrate check-spell into the lint script so CI automatically checks spelling
• Fix typo in rsdoctor built script (Descripton → Description)

Test plan

• pnpm cspell passes with 0 issues across 35 files
• CI lint workflow passes with spell checking included

[gemini-code-assist]

Summary of Changes

Hello @SoonIter, I'm Gemini Code Assist¹! 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 significantly improves the project's code quality and consistency by implementing cspell for comprehensive spell checking. It establishes a robust configuration, including a tailored dictionary for unique project terminology, and seamlessly integrates this new check into the existing linting workflow. This proactive measure aims to reduce textual errors, clarify documentation, and maintain a high standard of readability across all contributions.

Highlights

• Spell Checking Integration: Introduced cspell for automated spell checking across the codebase to enhance written accuracy.
• Custom Dictionary: Configured cspell with a custom dictionary (scripts/dictionary.txt) to include project-specific terms, preventing false positives.
• CI Workflow Enhancement: Integrated the spell checking process into the lint script, ensuring automatic checks are performed in continuous integration.
• Typo Correction: Fixed a minor typo (Descripton to Description) in the rsdoctor script.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• cspell.config.cjs
  • Added a new configuration file for cspell, defining the scope of files to check, ignore patterns, and custom dictionary paths.
• package.json
  • Added cspell and cspell-ban-words as development dependencies.
  • Introduced a new check-spell script to execute cspell.
  • Modified the lint script to include pnpm run check-spell, integrating spell checks into the main linting process.
• pnpm-lock.yaml
  • Updated the lockfile to include the newly added cspell and its transitive dependencies.
• scripts/dictionary.txt
  • Added a new custom dictionary file containing project-specific terms (e.g., rstack, rspress, rsdoctor) to be recognized by cspell.
• skills/rsdoctor-analysis/scripts/rsdoctor.js
  • Corrected a typo from extraDescripton to extraDescription within a script.

Activity

• No specific human activity (comments, reviews) has been recorded for this pull request yet.

Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request is a great addition, introducing automated spell checking with cspell which immediately found and fixed a typo. The configuration for cspell is well-structured.

However, there is a significant concern with how the typo was fixed. The change was made directly in a bundled JavaScript file, which is a build artifact. This is not a sustainable practice as the change will be lost the next time the project is built. My review includes a comment with a recommendation on how to address this properly, either by fixing the source file or by patching the dependency if the error is external.