Add codespell support (config, workflow to detect/not fix) and make it fix some typos #7864
Conversation
|
|
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughIntroduces Codespell configuration and a CI workflow to run it on preview branches. Across API, frontend, editor, and docs files, fixes spelling in comments and user-facing messages without altering logic, control flow, or public interfaces. Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant GH as GitHub
participant WF as Codespell Workflow
participant CS as Codespell Action
Dev->>GH: Push/PR to preview
GH-->>WF: Trigger workflow
WF->>WF: Checkout repository
WF->>WF: Add codespell problem matcher
WF->>CS: Run Codespell with .codespellrc
CS-->>WF: Report spelling findings (annotations)
WF-->>GH: Job status (pass/fail)
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✨ Finishing touches
🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (9)
✅ Files skipped from review due to trivial changes (2)
🚧 Files skipped from review as they are similar to previous changes (5)
🔇 Additional comments (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull Request Overview
This PR introduces codespell support to detect and fix spelling errors across the codebase. The implementation includes configuration files and a CI workflow to automatically check for typos without automatically fixing them.
- Added codespell configuration and CI workflow for spell checking
- Fixed multiple spelling errors across TypeScript, Python, and documentation files
- Set up read-only permissions for the CI workflow to ensure safety
Reviewed Changes
Copilot reviewed 19 out of 24 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/codespell.yml |
Adds CI workflow to run codespell on push/PR to preview branch |
.codespellrc |
Configuration file defining codespell behavior and exclusions |
packages/editor/src/core/plugins/markdown-clipboard.ts |
Fixes typo in property name from openEnd to opened |
packages/editor/src/core/plugins/drag-handle.ts |
Fixes typo in property name from openEnd to opened |
packages/editor/src/core/extensions/custom-link/helpers/autolink.ts |
Fixes "seperator" to "separator" in comment |
packages/editor/src/core/extensions/code/lowlight-plugin.ts |
Fixes "encapsulte" to "encapsulate" in comment |
deployments/cli/community/README.md |
Fixes "sevices" to "services" in multiple locations |
apps/web/helpers/authentication.helper.tsx |
Fixes "passowrd" to "password" in comment |
apps/web/core/store/user/index.ts |
Fixes "prjects" to "projects" in comment |
apps/web/core/store/issue/helpers/base-issues.store.ts |
Fixes "adn" to "and" in comment |
apps/web/core/components/issues/issue-layouts/list/base-list-root.tsx |
Fixes "becuase" to "because" in comment |
apps/web/ce/store/timeline/base-timeline.store.ts |
Fixes "wile" to "while" in comment |
apps/space/helpers/authentication.helper.tsx |
Fixes "passowrd" to "password" in comment |
apps/api/plane/db/management/commands/update_bucket.py |
Fixes "Coudn't" to "Couldn't" in error message |
apps/api/plane/db/management/commands/reset_password.py |
Fixes "succesfully" to "successfully" in success message |
apps/api/plane/db/management/commands/activate_user.py |
Fixes "succesfully" to "successfully" in success message |
apps/api/plane/authentication/adapter/error.py |
Fixes "passowrd" to "password" in comment |
apps/api/plane/app/views/cycle/base.py |
Fixes "isssue" to "issue" in comment |
apps/api/plane/api/serializers/intake.py |
Fixes "improts" to "imports" in comment |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| const markdownSerializer = editor.storage.markdown.serializer; | ||
| const isTableRow = slice.content.firstChild?.type?.name === CORE_EXTENSIONS.TABLE_ROW; | ||
| const nodeSelect = slice.openStart === 0 && slice.openEnd === 0; | ||
| const nodeSelect = slice.openStart === 0 && slice.opened === 0; |
There was a problem hiding this comment.
The property slice.opened doesn't exist on ProseMirror's Slice type. This should likely be slice.openEnd to maintain the original logic. This change appears to be an incorrect 'fix' by codespell that breaks the code functionality.
| const nodeSelect = slice.openStart === 0 && slice.opened === 0; | |
| const nodeSelect = slice.openStart === 0 && slice.openEnd === 0; |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (24)
.codespellrc(1 hunks).github/workflows/codespell.yml(1 hunks)apps/api/plane/api/serializers/intake.py(1 hunks)apps/api/plane/app/views/cycle/base.py(1 hunks)apps/api/plane/app/views/project/member.py(1 hunks)apps/api/plane/authentication/adapter/error.py(1 hunks)apps/api/plane/db/management/commands/activate_user.py(1 hunks)apps/api/plane/db/management/commands/reset_password.py(1 hunks)apps/api/plane/db/management/commands/update_bucket.py(1 hunks)apps/space/helpers/authentication.helper.tsx(1 hunks)apps/web/ce/store/timeline/base-timeline.store.ts(1 hunks)apps/web/core/components/issues/issue-layouts/list/base-list-root.tsx(1 hunks)apps/web/core/lib/polyfills/requestIdleCallback.ts(1 hunks)apps/web/core/local-db/worker/wa-sqlite/src/types/index.d.ts(7 hunks)apps/web/core/store/issue/helpers/base-issues.store.ts(1 hunks)apps/web/core/store/state.store.ts(1 hunks)apps/web/core/store/user/index.ts(1 hunks)apps/web/helpers/authentication.helper.tsx(1 hunks)deployments/cli/community/README.md(4 hunks)packages/editor/src/core/extensions/code/lowlight-plugin.ts(1 hunks)packages/editor/src/core/extensions/custom-link/helpers/autolink.ts(1 hunks)packages/editor/src/core/plugins/drag-handle.ts(1 hunks)packages/editor/src/core/plugins/markdown-clipboard.ts(1 hunks)packages/types/src/analytics.ts(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cursor Bugbot
🔇 Additional comments (16)
apps/web/core/lib/polyfills/requestIdleCallback.ts (1)
2-2: Comment wording fix looks good.Nice catch on the spelling fix; no further action needed.
apps/web/ce/store/timeline/base-timeline.store.ts (1)
316-316: Typo correction looks good.Comment now reads clearly with the fixed wording.
packages/types/src/analytics.ts (1)
76-76: Thanks for tidying up the comment typo.Appreciate the quick cleanup here.
packages/editor/src/core/extensions/code/lowlight-plugin.ts (1)
117-119: Comment typo fix looks good.Thanks for correcting the spelling here.
apps/web/core/components/issues/issue-layouts/list/base-list-root.tsx (1)
135-135: Typo fix confirmedCorrecting “because” improves the comment clarity; nothing else needed.
apps/web/core/store/issue/helpers/base-issues.store.ts (1)
1676-1681: Appreciate the typo fix.Thanks for cleaning up the doc comment; keeps the helpers readable.
apps/api/plane/db/management/commands/update_bucket.py (1)
75-78: Spelling fix looks good.The corrected error message reads cleanly and keeps behavior unchanged.
apps/web/core/local-db/worker/wa-sqlite/src/types/index.d.ts (1)
113-116: Spelling cleanups look greatThanks for tightening up the docs—“accommodate,” the repeated “statement” references, and “overridden” are now spelled correctly, which keeps the public typings tidy.
Also applies to: 333-415, 1193-1199
apps/api/plane/api/serializers/intake.py (1)
1-1: Header typo fix looks good.Line 1 now reads correctly; no further action needed.
apps/api/plane/authentication/adapter/error.py (1)
51-51: Comment spelling corrected appropriately.Line 51 now spells “password” correctly; change is sound.
apps/space/helpers/authentication.helper.tsx (1)
69-69: Thanks for tightening the comment.Line 69 now reflects the intended wording; no other adjustments needed.
apps/web/helpers/authentication.helper.tsx (1)
81-81: Comment spelling update confirmed.Line 81 now correctly documents the “set password” codes.
apps/api/plane/db/management/commands/activate_user.py (1)
34-34: Typo fix looks goodThanks for correcting the success message; nothing else to point out here.
apps/api/plane/app/views/cycle/base.py (1)
1289-1289: Docstring tweak is on pointGood catch on the typo in this explanatory comment.
apps/api/plane/app/views/project/member.py (1)
51-51: Validation message reads well nowAppreciate the grammar fix here.
apps/api/plane/db/management/commands/reset_password.py (1)
62-62: Success message typo resolvedThanks for cleaning up this message; no other changes needed.
| Lets again run the `./setup.sh` command. You will again be prompted with the below options. This time select `2` to start the services | ||
|
|
There was a problem hiding this comment.
Still a typo: use “Let’s”
These sentences still read “Lets again run…”. To keep the README polished (and in the spirit of this PR), they should be “Let’s again run…”.
- Lets again run the `./setup.sh` command. You will again be prompted with the below options. This time select `2` to start the services
+ Let's again run the `./setup.sh` command. You will again be prompted with the below options. This time select `2` to start the services
...
- Lets again run the `./setup.sh` command. You will again be prompted with the below options. This time select `3` to stop the services
+ Let's again run the `./setup.sh` command. You will again be prompted with the below options. This time select `3` to stop the services
...
- Lets again run the `./setup.sh` command. You will again be prompted with the below options. This time select `2` to stop the services
+ Let's again run the `./setup.sh` command. You will again be prompted with the below options. This time select `2` to stop the services
...
- Lets again run the `./setup.sh` command. You will again be prompted with the below options. This time select `4` to restart the services
+ Let's again run the `./setup.sh` command. You will again be prompted with the below options. This time select `4` to restart the servicesAlso applies to: 194-195, 216-217, 239-240
🤖 Prompt for AI Agents
In deployments/cli/community/README.md around lines 159-160 (and similarly at
194-195, 216-217, 239-240), the text uses the incorrect contraction “Lets”
instead of “Let’s”; update each occurrence to “Let’s” (replace plain Lets with
Let’s) to fix the typo and ensure proper punctuation and grammar in those README
sentences.
yarikoptic
force-pushed
the
enh-codespell
branch
from
de06c2f to
3362cd3
Compare
…nteractively
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w -i 3 -C 4 ./apps/web/core/components/workspace/delete-workspace-form.tsx ./deployments/cli/community/README.md",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
…os automagically
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
yarikoptic
force-pushed
the
enh-codespell
branch
from
3362cd3 to
a8dafa5
Compare
|
sorry for the "noise" -- I rebased on top of |
|
Can you please sign the CLA? |
|
done. |
3 participants
More about codespell: https://github.com/codespell-project/codespell .
I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.
CI workflow has 'permissions' set only to 'read' so also should be safe.
Note
Introduce Codespell CI with config and correct assorted typos/messages across backend, web, editor, and docs.
.codespellrc) and GitHub Action (.github/workflows/codespell.yml).apps/api/...(e.g., "At least one member is required", "successfully").apps/web/...,apps/space/...).core/lib/polyfills/requestIdleCallback.ts.packages/editor/...).packages/types/src/analytics.ts.deployments/cli/community/README.md.Written by Cursor Bugbot for commit a8dafa5. This will update automatically on new commits. Configure here.
Summary by CodeRabbit
Bug Fixes
Documentation
Chores