feat: add rev:* syntax to explicitly search all branches
#281
Conversation
WalkthroughThe update modifies the Changes
Assessment against linked issues
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 (
|
brendan-kellam
changed the title
rev:* syntax to explicitly search all branchesrev:* syntax to explicitly search all branches
brendan-kellam
force-pushed
the
bkellam/rev_wildcard
branch
from
8f0f0eb to
c46d437
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
docs/docs/more/multi-branch-indexing.mdx (1)
1-94: 🛠️ Refactor suggestionEnsure changelog is updated to document this feature
Please add an entry under "Unreleased" inCHANGELOG.mddescribing the addition of multi-branch indexing and the newrev:*syntax in the documentation.🧰 Tools
🪛 LanguageTool
[uncategorized] ~58-~58: You might be missing the article “the” here.
Context: ...anches or tags matching the patterns inbranchesandtagsarray will be index...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🧹 Nitpick comments (2)
docs/docs/more/multi-branch-indexing.mdx (2)
18-18: Fix grammatical mistake in configuration section
Change "configured on in the [connection]" to "configured in the [connection]" for clearer grammar. For example:- Multi-branch indexing is configured on in the [connection] using the `revisions.branches` and `revisions.tags` arrays. + Multi-branch indexing is configured in the [connection] using the `revisions.branches` and `revisions.tags` arrays.
58-58: Add missing article and correct pluralization
In the sentence "patterns inbranchesandtagsarray", add "the" before "branches" and pluralize "array" to "arrays":- any branches or tags matching the patterns in `branches` and `tags` array will be indexed. + any branches or tags matching the patterns in the `branches` and `tags` arrays will be indexed.🧰 Tools
🪛 LanguageTool
[uncategorized] ~58-~58: You might be missing the article “the” here.
Context: ...anches or tags matching the patterns inbranchesandtagsarray will be index...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/docs.json(1 hunks)docs/docs/more/multi-branch-indexing.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/docs.json
🧰 Additional context used
🪛 LanguageTool
docs/docs/more/multi-branch-indexing.mdx
[uncategorized] ~58-~58: You might be missing the article “the” here.
Context: ...anches or tags matching the patterns in branches and tags array will be index...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🔇 Additional comments (2)
docs/docs/more/multi-branch-indexing.mdx (2)
1-4: Verify inclusion in navigation
Ensure that this new MDX page is referenced indocs/docs.jsonunder the "Supported platforms" subgroup within "Connecting your code," so it appears in the sidebar.
14-16: Verify admonition syntax
Confirm that the<Warning>MDX component is available or imported in your Docusaurus/MDX setup. If not, consider using the standard admonition syntax (e.g.,:::warning).
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/docs/more/multi-branch-indexing.mdx (4)
18-18: Fix preposition in configuration description.
The phrase “configured on in the connection” is awkward—remove the extra “on” to read:- Multi-branch indexing is configured on in the [connection] + Multi-branch indexing is configured in the [connection]
58-58: Clarify grammar and plurality.
Change to “…patterns in thebranchesandtagsarrays will be indexed.” to include the article “the” and pluralize “arrays.”- any branches or tags matching the patterns in `branches` and `tags` array will be indexed. + any branches or tags matching the patterns in the `branches` and `tags` arrays will be indexed.🧰 Tools
🪛 LanguageTool
[uncategorized] ~58-~58: You might be missing the article “the” here.
Context: ...anches or tags matching the patterns inbranchesandtagsarray will be index...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
67-67: Remove trailing space in code example.
There’s an extra space inside the backticks—trim it for consistency:- | `rev:feature/foo useEffect ` | … + | `rev:feature/foo useEffect` | …
6-6: Improve readability by reducing repetition.
Consider rephrasing to avoid repeating “default” twice:- By default, only the default branch of a repository is indexed and can be searched. + By default, only a repository’s default branch is indexed and searchable.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
CHANGELOG.md(1 hunks)docs/docs.json(1 hunks)docs/docs/more/multi-branch-indexing.mdx(1 hunks)packages/web/src/lib/server/searchService.ts(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- packages/web/src/lib/server/searchService.ts
- docs/docs.json
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md
[duplication] ~10-~10: Possible typo: you repeated a word.
Context: ...pec/v2.0.0.html). ## [Unreleased] ### Added - Added special * value for rev: to allow s...
(ENGLISH_WORD_REPEAT_RULE)
docs/docs/more/multi-branch-indexing.mdx
[uncategorized] ~58-~58: You might be missing the article “the” here.
Context: ...anches or tags matching the patterns in branches and tags array will be index...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
🔇 Additional comments (1)
CHANGELOG.md (1)
10-11: Changelog entry is accurate.
The “Unreleased” section correctly documents the addition ofrev:*for all-branch search with a link to PR #281.🧰 Tools
🪛 LanguageTool
[duplication] ~10-~10: Possible typo: you repeated a word.
Context: ...pec/v2.0.0.html). ## [Unreleased] ### Added - Added special*value forrev:to allow s...(ENGLISH_WORD_REPEAT_RULE)
This PR makes it s.t., using
rev:*searches all revisions that are indexed for a given repository.Fixes #120
Summary by CodeRabbit