docs: expose hidden CLI options --mask and --from in help output#62
docs: expose hidden CLI options --mask and --from in help output#62ambicuity merged 3 commits intoambicuity:mainfrom
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! 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 focuses on improving the user experience of the Highlights
Using Gemini Code AssistThe 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
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 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. Footnotes
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Thank you for your first pull request to KINDX. A maintainer will review your changes shortly.
Please make sure your PR: - Has a title following Conventional Commits format (e.g., feat(engine): add collection filter) - Is linked to an issue with Fixes #N in the description - Passes all CI checks
See CONTRIBUTING.md for the full contribution guide.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
The pull request successfully updates the help output for the kindx collection add command to expose the --mask option, improving discoverability for users. However, the pull request title mentions exposing the --from CLI option, but no changes related to --from are present in the provided diff. Please clarify if the --from option was intended to be included in this PR or if the title needs to be updated.
| console.log(" kindx collection add <path> [--name <name>] [--mask <glob>]"); | ||
| console.log(" - Add collection. --mask sets glob pattern (default: **/*.md)"); | ||
| console.log(" kindx collection list/remove/rename/show/update-cmd/include/exclude"); | ||
| console.log(" - Manage indexed folders and default-query behavior"); |
There was a problem hiding this comment.
The pull request title indicates that the --from CLI option should also be exposed in the help output. However, the provided changes only address the --mask option for kindx collection add. The help text for kindx get (where --from is used) remains unchanged in this patch. Please either include the documentation for --from or update the PR title and description to accurately reflect the scope of this pull request.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (3)
WalkthroughUpdated CLI help and documentation to expose previously undocumented flags: Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📋 Issue PlannerBuilt with CodeRabbit's Coding Plans for faster development and fewer bugs. View plan used: ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Warning
CodeRabbit couldn't request changes on this pull request because it doesn't have sufficient GitHub permissions.
Please grant CodeRabbit Pull requests: Read and write permission and re-run the review.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@engine/kindx.ts`:
- Around line 2459-2461: The top-level help text does not advertise the get
command's --from option, so update the help-printing code that outputs the CLI
summary (the block that prints lines like "kindx collection add ..." in
kindx.ts) to include a line showing get usage with --from and an example
demonstrating line-offset usage; specifically add a mirror entry for "kindx get
[--from <n>]" (or similar) to the same help output area so kindx --help surfaces
both --mask (already added) and --from for get, and ensure the get-related help
text references the get function/command name used in the file.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: a92371c6-3498-4c44-a7b7-565a375ed598
📒 Files selected for processing (1)
engine/kindx.ts
There was a problem hiding this comment.
Warning
CodeRabbit couldn't request changes on this pull request because it doesn't have sufficient GitHub permissions.
Please grant CodeRabbit Pull requests: Read and write permission and re-run the review.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@engine/kindx.ts`:
- Line 2460: The help text hardcodes "**/*.md" while the code uses the constant
DEFAULT_GLOB; update the console.log call (the line that prints " - Add
collection. --mask sets glob pattern (default: **/*.md)") to reference
DEFAULT_GLOB instead of the literal so the displayed default stays in sync with
the runtime constant (use string interpolation or concatenation with
DEFAULT_GLOB where that console.log is emitted).
- Line 2452: The help synopsis printed by the top-level get command (the
console.log call that currently outputs "kindx get <file>[:line] [-l N] [--from
<line>] - Show a single document from specific line, optional line slice") is
missing the supported --line-numbers flag; update that console.log string in
engine/kindx.ts to include the --line-numbers flag (matching the actual command
usage in the get implementation referenced later) so the top-level help and the
implementation stay in sync.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 01cc413c-eb16-4e7c-8240-56c6390d96c8
📒 Files selected for processing (1)
engine/kindx.ts
|
Implemented issue-complete parity and validated AI findings locally. AI review triage:
Additional issue #51 parity fixes included:
Local validation:
|
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
2 participants
Fixes #51
Changes
--mask <glob>option visibility incollection addhelp textWhy
The
--maskoption was supported but not shown inkindx --help, making it effectively hidden unless users read the source code.Summary by CodeRabbit
Documentation
kindx getdocuments--from <N>and--line-numbers;kindx collection addnow showscollection add <path> [--name <name>] [--mask <glob>](default**/*.md); other collection subcommands restated.Tests
--mask,--from, and--line-numbers.