chore: Misc typos (UI, docs, code...), Makefile PATH with spaces #369
Conversation
E.g. `Application Support` on MacOS
WalkthroughThis update corrects typographical and spelling errors across various documentation files, code comments, variable names, function names, and user-facing strings. The changes include renaming functions and variables for accuracy, fixing typos in documentation and schema descriptions, and updating error messages, without altering any underlying logic or control flow. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant UI_Component
participant FileTreeLogic
User->>UI_Component: Interacts with file tree panel
UI_Component->>FileTreeLogic: Calls buildCollapsibleTree(tree)
FileTreeLogic-->>UI_Component: Returns structured file tree
UI_Component-->>User: Renders updated file tree
Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches
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. 🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
packages/mcp/README.md (1)
20-23: Adjust list indentation to satisfy markdown-lint
markdownlint-cli2flags 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/shared/README.md (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/features/fileTree/components/pureFileTreePanel.tsx (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.packages/web/src/actions.ts (1)
172-181: Consider hoistinggetAuthorizationPrecedenceor using an enum ordinalNice catch on the typo – the rename improves clarity.
Given this helper is recreated on everywithOrgMembershipcall, consider extracting it to module scope or convertingOrgRolevalues to numeric ordinals (e.g. viaconst roleWeight: Record<OrgRole, number> = …). This avoids re-allocating the switch on each invocation and makes the precedence policy easier to unit-test in isolation.docs/docs/connections/local-repos.mdx (1)
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.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 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)
🧰 Additional context used
🧠 Learnings (4)
packages/shared/README.md (1)
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.
packages/web/src/app/[domain]/settings/(general)/components/changeOrgNameCard.tsx (1)
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.
packages/backend/src/repoCompileUtils.ts (2)
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 `[email protected]: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 `[email protected]: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/app/[domain]/browse/hooks/useBrowseParams.ts (2)
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 `[email protected]: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 `[email protected]: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.
🧬 Code Graph Analysis (1)
packages/web/src/features/fileTree/components/pureFileTreePanel.tsx (4)
packages/web/src/features/fileTree/actions.ts (1)
FileTreeNode(20-22)packages/web/src/app/[domain]/browse/hooks/useBrowseNavigation.ts (1)
useBrowseNavigation(25-59)packages/web/src/app/[domain]/browse/hooks/useBrowseParams.ts (1)
useBrowseParams(5-48)packages/web/src/hooks/usePrefetchFileSource.ts (1)
usePrefetchFileSource(14-34)
🪛 markdownlint-cli2 (0.17.2)
packages/mcp/README.md
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
🔇 Additional comments (23)
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 goodThe 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 changeSame “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
The replacement of “excells” with “excels” fixes the prompt text and introduces no behavioural changes.packages/web/src/ee/features/billing/actions.ts (1)
63-66: String typo resolved – looks good
Correcting “Attemped” → “Attempted” improves log clarity. No further issues spotted in this hunk.packages/web/src/app/[domain]/browse/hooks/useBrowseParams.ts (1)
14-20: Rename safe – no occurrences ofsentinalIndexfound
A global search for the old identifier yielded zero matches, confirming that renamingsentinalIndex→sentinelIndexis non-breaking.packages/web/src/features/fileTree/components/pureFileTreePanel.tsx (1)
17-22: Function rename applied correctly
buildCollapsableTree→buildCollapsibleTreealigns with dictionary spelling; all internal references updated.packages/web/src/actions.ts (2)
741-742: Typo fix looks good
Comment now reads correctly (“constraint”). No further action required.
184-190: No lingeringgetAuthorizationPrecendencereferences found
A repo-wide search (rg -n "getAuthorizationPrecendence") returned zero matches, so all call sites now use the correctedgetAuthorizationPrecedence.packages/schemas/src/v2/index.type.ts (1)
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
“separate” is now spelled correctly; the doc reads well.packages/web/src/app/[domain]/components/searchBar/searchSuggestionsBox.test.tsx (1)
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
“exluded” → “excluded” keeps the JSON schema descriptions consistent with TypeScript sources. No further action needed.packages/web/src/app/[domain]/components/searchBar/searchSuggestionsBox.tsx (1)
441-456: Typoseperatorfully replacedNo occurrences of the old misspelling were found in any
.ts,.tsx,.js,.jsx,.mjs, or.cjsfiles—separatoris 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
| mkdir -p bin | ||
| go build -C vendor/zoekt -o $(PWD)/bin ./cmd/... | ||
| export PATH=$(PWD)/bin:$(PATH) | ||
| export PATH="$(PWD)/bin:$(PATH)" | ||
| export CTAGS_COMMANDS=ctags | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
export runs in its own subshell – PATH / CTAGS won’t propagate to later recipe lines.
Each recipe line is executed in a separate shell, so the two export statements have no lasting effect beyond their individual lines.
If subsequent build commands rely on the modified PATH or CTAGS, combine them into a single line, use back-slash continuations, or add .ONESHELL: to the Makefile.
Example:
zoekt:
. ./vendor/zoekt/env.sh && \
PATH="$(PWD)/bin:$$PATH" \
CTAGS_COMMANDS=ctags \
go build -C vendor/zoekt -o "$(PWD)/bin" ./cmd/...—or—
.ONESHELL:
zoekt:
mkdir -p bin
export PATH="$(PWD)/bin:$$PATH"
export CTAGS_COMMANDS=ctags
go build -C vendor/zoekt -o "$(PWD)/bin" ./cmd/...🤖 Prompt for AI Agents
In the Makefile around lines 11 to 15, the export statements for PATH and
CTAGS_COMMANDS are each run in separate subshells, so their effects do not
persist to subsequent lines. To fix this, either combine all commands that rely
on these environment variables into a single recipe line using backslash
continuations, or add the .ONESHELL: directive at the top of the Makefile so all
recipe lines run in the same shell, allowing exports to persist across lines.
Hey 👋
Small PR to fix some typos, after I noticed the
Sourceobotin the settings. I've also ran typos to fix some. I can add thetypos.tomlconfig if you're interested.Also a small Makefile tweak to support PATH with spaces (e.g.
Application Supporton MacOS), with proper quotes.Have a great day!
Summary by CodeRabbit
Bug Fixes
Documentation