chore: Misc typos (UI, docs, code...), Makefile PATH with spaces - #369
chore: Misc typos (UI, docs, code...), Makefile PATH with spaces#369brendan-kellam merged 5 commits into
Conversation
Sorry, something went wrong.
WalkthroughThis update consists of widespread corrections of typographical and spelling errors across documentation, code comments, variable names, function names, and user-facing strings. One function and one variable were renamed for correct spelling, and a typo configuration file was added to customize typo checking behavior. No logic or control flow changes were made. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant UI_Component
participant Utility_Function
User->>UI_Component: Interacts with UI (e.g., search bar, file tree)
UI_Component->>Utility_Function: Calls renamed/updated function or uses corrected variable
Utility_Function-->>UI_Component: Returns result (no logic changed)
UI_Component-->>User: Displays result with corrected text or labels
Possibly related PRs
Poem
📜 Recent review details Configuration used: CodeRabbit UI Reviewing files that changed from the base of the PR and between 7186929 and 88cc0fd. 📒 Files selected for processing (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. ❤️ Share 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (.coderabbit.yaml)
Documentation and Community
|
Sorry, something went wrong.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)packages/mcp/README.md (1)📜 Review detailspackages/shared/README.md (1)20-23: Adjust list indentation to satisfy markdown-lint
markdownlint-cli2 flags MD007 (unordered-list indentation) because this nested bullet is indented by four spaces instead of two. Align with two‐space indentation to silence CI and keep list rendering consistent.
- - _"Identify repositories that depend on this deprecated api"_ + - _"Identify repositories that depend on this deprecated api"_packages/web/src/features/fileTree/components/pureFileTreePanel.tsx (1)5-5: Sentence still reads awkwardly & misses a verb
Current text:“To deal with this, we these two index files export server code and client code, respectively.”
Suggested fix:
- To deal with this, we these two index files export server code and client code, respectively. + To deal with this, we rely on these two index files to export server-specific and client-specific code, respectively.This also avoids the dangling comma before “because”, which LanguageTool flagged.
packages/web/src/actions.ts (1)50-53: Comment still uses old spelling
Line 50 references “collapsible” but the explanatory comment retains “collapsable”.- // In that case, we need to rebuild the collapsable tree. + // In that case, we need to rebuild the collapsible tree.docs/docs/connections/local-repos.mdx (1)172-181: Consider hoisting getAuthorizationPrecedence or using an enum ordinal
Nice catch on the typo – the rename improves clarity.
Given this helper is recreated on every withOrgMembership call, consider extracting it to module scope or converting OrgRole values to numeric ordinals (e.g. via const roleWeight: Record<OrgRole, number> = …). This avoids re-allocating the switch on each invocation and makes the precedence policy easier to unit-test in isolation.8-9: Typo fixed; consider trimming wordiness
Nice catch switching “meaing” → “meaning”. While you’re here, you could tighten the phrase “a large number of repos already checked out” to “many repositories already checked out” for brevity.
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Reviewing files that changed from the base of the PR and between 8060ade and ed21810.
📒 Files selected for processing (24)- CONTRIBUTING.md (1 hunks)
- Makefile (1 hunks)
- docs/docs/connections/local-repos.mdx (2 hunks)
- docs/snippets/schemas/v2/index.schema.mdx (3 hunks)
- packages/backend/src/repoCompileUtils.ts (1 hunks)
- packages/backend/src/repoManager.ts (1 hunks)
- packages/mcp/README.md (1 hunks)
- packages/schemas/src/v2/index.schema.ts (4 hunks)
- packages/schemas/src/v2/index.type.ts (1 hunks)
- packages/shared/README.md (1 hunks)
- packages/web/src/actions.ts (3 hunks)
- packages/web/src/app/[domain]/browse/hooks/useBrowseParams.ts (1 hunks)
- packages/web/src/app/[domain]/components/searchBar/searchSuggestionsBox.test.tsx (2 hunks)
- packages/web/src/app/[domain]/components/searchBar/searchSuggestionsBox.tsx (2 hunks)
- packages/web/src/app/[domain]/components/searchBar/useSuggestionModeAndQuery.ts (1 hunks)
- packages/web/src/app/[domain]/components/syntaxReferenceGuide.tsx (1 hunks)
- packages/web/src/app/[domain]/settings/(general)/components/changeOrgNameCard.tsx (1 hunks)
- packages/web/src/app/components/syntaxReferenceGuide.tsx (1 hunks)
- packages/web/src/auth.ts (1 hunks)
- packages/web/src/ee/features/billing/actions.ts (1 hunks)
- packages/web/src/features/agents/review-agent/app.ts (1 hunks)
- packages/web/src/features/agents/review-agent/nodes/generateDiffReviewPrompt.ts (1 hunks)
- packages/web/src/features/fileTree/components/pureFileTreePanel.tsx (2 hunks)
- schemas/v2/index.json (1 hunks)
Learnt from: drew-u410 PR: sourcebot-dev/sourcebot#328 File: CONTRIBUTING.md:5-5 Timestamp: 2025-06-03T00:22:00.498Z Learning: In the sourcebot repository CONTRIBUTING.md file, the maintainer prefers using "NodeJS" spelling instead of the official "Node.js" branding, and prefers not to add alt text to favicon images in the installation instructions.
Learnt from: drew-u410 PR: sourcebot-dev/sourcebot#328 File: CONTRIBUTING.md:5-5 Timestamp: 2025-06-03T00:22:00.498Z Learning: In the sourcebot repository CONTRIBUTING.md file, the maintainer prefers using "NodeJS" spelling instead of the official "Node.js" branding, and prefers not to add alt text to favicon images in the installation instructions.
Learnt from: brendan-kellam
PR: sourcebot-dev/sourcebot#307
File: packages/backend/src/repoCompileUtils.ts:491-503
Timestamp: 2025-05-14T19:20:48.667Z
Learning: SSH/SCP-style Git URLs (like `git@github.com:org/repo.git`) throw errors when passed directly to JavaScript's `new URL()` constructor. A fix is to convert them using: `new URL(`ssh://${url.replace(':', '/')}`)` for non-HTTP URLs.
Learnt from: brendan-kellam
PR: sourcebot-dev/sourcebot#307
File: packages/backend/src/repoCompileUtils.ts:491-503
Timestamp: 2025-05-14T19:20:48.667Z
Learning: SSH/SCP-style Git URLs (like `git@github.com:org/repo.git`) throw errors when passed directly to JavaScript's `new URL()` constructor. A fix is to convert them using: `new URL(`ssh://${url.replace(':', '/')}`)` for non-HTTP URLs.
Learnt from: brendan-kellam
PR: sourcebot-dev/sourcebot#307
File: packages/backend/src/repoCompileUtils.ts:491-503
Timestamp: 2025-05-14T19:20:48.667Z
Learning: SSH/SCP-style Git URLs (like `git@github.com:org/repo.git`) throw errors when passed directly to JavaScript's `new URL()` constructor. A fix is to convert them using: `new URL(`ssh://${url.replace(':', '/')}`)` for non-HTTP URLs.
Learnt from: brendan-kellam
PR: sourcebot-dev/sourcebot#307
File: packages/backend/src/repoCompileUtils.ts:491-503
Timestamp: 2025-05-14T19:20:48.667Z
Learning: SSH/SCP-style Git URLs (like `git@github.com:org/repo.git`) throw errors when passed directly to JavaScript's `new URL()` constructor. A fix is to convert them using: `new URL(`ssh://${url.replace(':', '/')}`)` for non-HTTP URLs.
packages/web/src/features/fileTree/actions.ts (1)🪛 markdownlint-cli2 (0.17.2) packages/mcp/README.mdpackages/web/src/app/[domain]/browse/hooks/useBrowseNavigation.ts (1)
- FileTreeNode (20-22)
packages/web/src/app/[domain]/browse/hooks/useBrowseParams.ts (1)
- useBrowseNavigation (25-59)
packages/web/src/hooks/usePrefetchFileSource.ts (1)
- useBrowseParams (5-48)
- usePrefetchFileSource (14-34)
22-22: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
🪛 LanguageTool packages/shared/README.md[uncategorized] ~5-~5: The official spelling of this programming framework is “Node.js”.
Context: ...n this package that will only work in a Node.JS runtime (e.g., because it depends on th...
(NODE_JS)
[formatting] ~5-~5: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...ill only work in a Node.JS runtime (e.g., because it depends on the fs package. Entitle...
(COMMA_BEFORE_BECAUSE)
docs/docs/connections/local-repos.mdx[style] ~8-~8: To reduce wordiness, try specifying a number or using “many” or “numerous” instead.
Context: ...ful in scenarios where you already have a large number of repos already checked out. Local reposi...
(LARGE_NUMBER_OF)
⏰ Context from checks skipped due to timeout of 90000ms (1)- GitHub Check: build
Makefile (1)13-13: Quoting $(PWD) fixes PATHs containing spaces – good catch.
packages/web/src/app/[domain]/settings/(general)/components/changeOrgNameCard.tsx (1)68-68: UI copy typo fixed – looks good
The spelling correction from “Sourceobot” ➜ “Sourcebot” is correct and no other code is affected.
packages/web/src/app/components/syntaxReferenceGuide.tsx (1)69-69: Typo fixed – no further action
“space-separated” spelling is now correct; nothing else changes.
packages/web/src/app/[domain]/components/syntaxReferenceGuide.tsx (1)69-69: Typo fixed – mirrored change
Same “space-separated” correction as the global component. LGTM.
packages/web/src/app/[domain]/components/searchBar/useSuggestionModeAndQuery.ts (1)24-25: Comment typo fixed
“sentinel” spelling is now correct; logic untouched.
packages/web/src/features/agents/review-agent/app.ts (1)15-15: Typo fix looks good.
The corrected spelling in the guidance string keeps the instructions clear and consistent.
packages/backend/src/repoCompileUtils.ts (1)379-382: Comment typo fixed.
Nothing else changed; implementation remains unaffected.
CONTRIBUTING.md (1)41-41: Spelling correction acknowledged.
Documentation reads clearly after replacing “declerative” with “declarative”.
packages/backend/src/repoManager.ts (1)175-178: Minor comment typo fixed.
No functional impact.
packages/web/src/auth.ts (1)193-193: Comment spelling corrected.
No code changes required.
packages/web/src/features/agents/review-agent/nodes/generateDiffReviewPrompt.ts (1)11-12: Typo correction confirmed – no further action needed
packages/web/src/ee/features/billing/actions.ts (1)
The replacement of “excells” with “excels” fixes the prompt text and introduces no behavioural changes.63-66: String typo resolved – looks good
packages/web/src/app/[domain]/browse/hooks/useBrowseParams.ts (1)
Correcting “Attemped” → “Attempted” improves log clarity. No further issues spotted in this hunk.14-20: Rename safe – no occurrences of sentinalIndex found
packages/web/src/features/fileTree/components/pureFileTreePanel.tsx (1)
A global search for the old identifier yielded zero matches, confirming that renaming sentinalIndex → sentinelIndex is non-breaking.17-22: Function rename applied correctly
packages/web/src/actions.ts (2)
buildCollapsableTree → buildCollapsibleTree aligns with dictionary spelling; all internal references updated.741-742: Typo fix looks good
Comment now reads correctly (“constraint”). No further action required.
184-190: No lingering getAuthorizationPrecendence references found
packages/schemas/src/v2/index.type.ts (1)
A repo-wide search (rg -n "getAuthorizationPrecendence") returned zero matches, so all call sites now use the corrected getAuthorizationPrecedence.312-313: Spelling correction acknowledged
“excluded” is now spelled correctly in the JSDoc. Documentation consistency improved.
packages/schemas/src/v2/index.schema.ts (1)687-689: Correct typo – no functional impact
The spelling fix from “exluded” → “excluded” improves clarity across the schema docs. No functional or validation behaviour is affected.Also applies to: 1389-1391, 2173-2175
docs/docs/connections/local-repos.mdx (1)30-31: Typo fixed – looks good
packages/web/src/app/[domain]/components/searchBar/searchSuggestionsBox.test.tsx (1)
“separate” is now spelled correctly; the doc reads well.37-51: Test description typo corrected
Changing “correclty” → “correctly” in the two test names improves readability. Test logic remains intact.Also applies to: 53-59
schemas/v2/index.json (1)497-499: Consistent typo fix across JSON schema
packages/web/src/app/[domain]/components/searchBar/searchSuggestionsBox.tsx (1)
“exluded” → “excluded” keeps the JSON schema descriptions consistent with TypeScript sources. No further action needed.441-456: Typo seperator fully replaced
No occurrences of the old misspelling were found in any .ts, .tsx, .js, .jsx, .mjs, or .cjs files—separator is now consistently used throughout the codebase.
docs/snippets/schemas/v2/index.schema.mdx (1)688-689: Typo fixed (“excluded”) – LGTM.
Also applies to: 1390-1391, 2174-2175
Sorry, something went wrong.
brendan-kellam
left a comment
There was a problem hiding this comment.
LGTM, thanks for the PR! I'd be open to having a typos.toml if you'd like to open a PR for that 😃
Sorry, something went wrong.
E.g. `Application Support` on MacOS
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)packages/mcp/README.md (2)📜 Review details21-23: Fix Markdown list indentation & capitalisation
markdownlint (MD007) warns about excess indentation (4 spaces) for the nested list item, and “api” should be capitalised.
- - _"Identify repositories that depend on this deprecated api"_ + - _"Identify repositories that depend on this deprecated API"_
20-20: Remove duplicated word “like”
- - Building custom LLM horizontal agents like like compliance auditing agents, migration agents, etc. + - Building custom LLM horizontal agents like compliance auditing agents, migration agents, etc.
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Reviewing files that changed from the base of the PR and between ed21810 and 7186929.
📒 Files selected for processing (26)- CONTRIBUTING.md (1 hunks)
- Makefile (1 hunks)
- _typos.toml (1 hunks)
- docs/docs/connections/local-repos.mdx (1 hunks)
- docs/snippets/schemas/v2/index.schema.mdx (3 hunks)
- packages/backend/src/repoCompileUtils.ts (1 hunks)
- packages/backend/src/repoManager.ts (1 hunks)
- packages/mcp/README.md (1 hunks)
- packages/schemas/src/v2/index.schema.ts (4 hunks)
- packages/schemas/src/v2/index.type.ts (1 hunks)
- packages/shared/README.md (1 hunks)
- packages/web/src/actions.ts (3 hunks)
- packages/web/src/app/[domain]/browse/hooks/utils.ts (1 hunks)
- packages/web/src/app/[domain]/components/searchBar/searchSuggestionsBox.test.tsx (2 hunks)
- packages/web/src/app/[domain]/components/searchBar/searchSuggestionsBox.tsx (2 hunks)
- packages/web/src/app/[domain]/components/searchBar/useSuggestionModeAndQuery.ts (1 hunks)
- packages/web/src/app/[domain]/components/syntaxReferenceGuide.tsx (1 hunks)
- packages/web/src/app/[domain]/settings/(general)/components/changeOrgNameCard.tsx (1 hunks)
- packages/web/src/app/components/syntaxReferenceGuide.tsx (1 hunks)
- packages/web/src/app/onboard/page.tsx (6 hunks)
- packages/web/src/auth.ts (1 hunks)
- packages/web/src/ee/features/billing/actions.ts (1 hunks)
- packages/web/src/features/agents/review-agent/app.ts (1 hunks)
- packages/web/src/features/agents/review-agent/nodes/generateDiffReviewPrompt.ts (1 hunks)
- packages/web/src/features/fileTree/components/pureFileTreePanel.tsx (2 hunks)
- schemas/v2/index.json (1 hunks)
- packages/web/src/app/[domain]/settings/(general)/components/changeOrgNameCard.tsx
- schemas/v2/index.json
- packages/web/src/features/agents/review-agent/nodes/generateDiffReviewPrompt.ts
- packages/backend/src/repoCompileUtils.ts
- _typos.toml
- packages/schemas/src/v2/index.type.ts
- docs/docs/connections/local-repos.mdx
- packages/web/src/app/[domain]/browse/hooks/utils.ts
- packages/web/src/actions.ts
- packages/web/src/app/[domain]/components/searchBar/useSuggestionModeAndQuery.ts
- packages/web/src/features/agents/review-agent/app.ts
- packages/backend/src/repoManager.ts
- packages/shared/README.md
- packages/web/src/app/components/syntaxReferenceGuide.tsx
- packages/web/src/auth.ts
- packages/web/src/app/[domain]/components/searchBar/searchSuggestionsBox.test.tsx
- CONTRIBUTING.md
- Makefile
- packages/web/src/ee/features/billing/actions.ts
- docs/snippets/schemas/v2/index.schema.mdx
- packages/schemas/src/v2/index.schema.ts
- packages/web/src/app/[domain]/components/syntaxReferenceGuide.tsx
- packages/web/src/app/[domain]/components/searchBar/searchSuggestionsBox.tsx
- packages/web/src/features/fileTree/components/pureFileTreePanel.tsx
22-22: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
⏰ 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: build
packages/web/src/app/onboard/page.tsx (6)17-17: LGTM: Typo correction in import statement
The import statement correctly fixes the typo from BetweenHorizonalStart to BetweenHorizontalStart, addressing the missing 't' in "Horizontal".
109-109: LGTM: Consistent usage of corrected icon name
The icon usage correctly matches the fixed import, maintaining consistency throughout the component.
185-185: LGTM: JSX formatting improvement
Removing the trailing space after the opening <a tag improves code cleanliness.
247-247: LGTM: JSX formatting improvement
Removing the trailing space after the opening <div tag improves code cleanliness.
362-362: LGTM: Clean up blank line
Removing the extra blank line in the NonOwnerOnboardingMessage component improves code formatting consistency.
393-394: LGTM: JSX formatting improvement
The formatting improvement to the anchor tag enhances code readability and consistency.
Sorry, something went wrong.
|
@brendan-kellam Rebased and added simple _typos.toml |
Sorry, something went wrong.
brendan-kellam
left a comment
There was a problem hiding this comment.
LGTM thanks!
Sorry, something went wrong.
Hey 👋
Small PR to fix some typos, after I noticed the Sourceobot in the settings. I've also ran typos to fix some. I can add the typos.toml config if you're interested.
Also a small Makefile tweak to support PATH with spaces (e.g. Application Support on MacOS), with proper quotes.
Have a great day!
Summary by CodeRabbit
Documentation
Style
Refactor