update docs#15
Merged
Merged
Conversation
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughDocumentation and CLI tooling are updated to prioritize npm scaffolding ( Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Review rate limit: 0/1 reviews remaining, refill in 47 minutes and 44 seconds.Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
apps/docs/docs/orm/index.md (1)
54-54: ⚡ Quick winNormalize CLI invocation style within this page.
This page now mixes
npx holo ...and bareholo ...commands, which can be unclear about prerequisites. Consider one convention (or a short note explaining both forms).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@apps/docs/docs/orm/index.md` at line 54, The page mixes two CLI invocation styles ("npx holo migrate" and bare "holo ..."); choose one convention (preferably include "npx " for clarity about prerequisites) and update every command instance to that style (e.g., replace occurrences of "holo" with "npx holo" or vice versa), or add a single note near the top explaining both forms and when to use each; update the line containing "npx holo migrate" and any other command examples to match the chosen convention and ensure wording around the commands (like "refreshes server/db/schema.generated.ts") remains accurate.packages/cache/tests/docs-smoke.test.ts (1)
22-27: ⚡ Quick winAdd coverage for the new scaffold example.
The smoke test now checks the updated command strings, but it still won't catch regressions in the new project-scaffolding snippet.
Proposed test update
const installation = await readFile(resolve(root, 'apps/docs/docs/installation.md'), 'utf8') const index = await readCacheDoc('index.md') const setup = await readCacheDoc('setup-and-cli.md') + expect(setup).toContain('npm create holo-js@latest my-app -- --package cache') const config = await readCacheDoc('config-and-drivers.md')🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/cache/tests/docs-smoke.test.ts` around lines 22 - 27, The test only asserts existing cache CLI lines but misses the new project-scaffolding example; update packages/cache/tests/docs-smoke.test.ts to add an expectation against the setup variable for the new scaffold example so regressions are caught, following the same pattern as the other expect(setup).toContain assertions and placing it alongside the other cache command assertions.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@apps/docs/docs/installation.md`:
- Around line 162-164: Replace the plain `holo prepare` example with the
exec/wrapper form used elsewhere so it works in a fresh install (e.g., use the
`npx holo prepare` style); update the text that refers to "Run `holo prepare`
directly" to instead say "Run `npx holo prepare`" (or the equivalent
package-manager exec wrapper) so the documentation matches the surrounding `npx
holo ...` guidance and won’t fail when the binary isn't globally installed.
In `@packages/cli/src/parsing.ts`:
- Around line 238-242: The code changed the non-interactive fallback package
manager to 'npm' (see resolveStringFlag, normalizeChoice,
SUPPORTED_NEW_PACKAGE_MANAGERS and prompts.choose in parsing.ts), so update the
'defaults-app' test and any other tests that call resolveNewProjectInput with
empty flags to expect packageManager: 'npm' instead of 'bun'; find assertions or
fixtures referencing 'bun' (including the test at the previous line ~3650) and
replace them with 'npm' (or alternatively adjust the test setup to explicitly
set the package-manager flag to 'bun' if you want to preserve the old behavior).
---
Nitpick comments:
In `@apps/docs/docs/orm/index.md`:
- Line 54: The page mixes two CLI invocation styles ("npx holo migrate" and bare
"holo ..."); choose one convention (preferably include "npx " for clarity about
prerequisites) and update every command instance to that style (e.g., replace
occurrences of "holo" with "npx holo" or vice versa), or add a single note near
the top explaining both forms and when to use each; update the line containing
"npx holo migrate" and any other command examples to match the chosen convention
and ensure wording around the commands (like "refreshes
server/db/schema.generated.ts") remains accurate.
In `@packages/cache/tests/docs-smoke.test.ts`:
- Around line 22-27: The test only asserts existing cache CLI lines but misses
the new project-scaffolding example; update
packages/cache/tests/docs-smoke.test.ts to add an expectation against the setup
variable for the new scaffold example so regressions are caught, following the
same pattern as the other expect(setup).toContain assertions and placing it
alongside the other cache command assertions.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 9e4a9e91-d2a9-4409-8c30-e3c13ce1f30c
📒 Files selected for processing (38)
README.mdapps/docs/docs/auth/email-verification.mdapps/docs/docs/auth/index.mdapps/docs/docs/auth/social-login.mdapps/docs/docs/authorization/index.mdapps/docs/docs/cache/config-and-drivers.mdapps/docs/docs/cache/setup-and-cli.mdapps/docs/docs/database/commands.mdapps/docs/docs/database/index.mdapps/docs/docs/database/migrations.mdapps/docs/docs/deployment.mdapps/docs/docs/development/index.mdapps/docs/docs/development/workflow.mdapps/docs/docs/directory-structure.mdapps/docs/docs/events/setup-and-cli.mdapps/docs/docs/index.mdapps/docs/docs/installation.mdapps/docs/docs/mail/setup-and-cli.mdapps/docs/docs/media.mdapps/docs/docs/notifications/setup-and-cli.mdapps/docs/docs/orm/index.mdapps/docs/docs/queue/database.mdapps/docs/docs/queue/failed-jobs.mdapps/docs/docs/queue/index.mdapps/docs/docs/queue/jobs.mdapps/docs/docs/queue/media.mdapps/docs/docs/queue/workers.mdapps/docs/docs/security.mdpackages/auth/tests/docs-smoke.test.tspackages/broadcast/tests/docs-smoke.test.tspackages/cache/tests/docs-smoke.test.tspackages/cli/src/metadata.tspackages/cli/src/parsing.tspackages/cli/src/project/shared.tspackages/mail/tests/docs-smoke.test.tspackages/media/package.jsonpackages/notifications/tests/docs-smoke.test.tspackages/security/tests/docs-smoke.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
Documentation
npxinstead ofbunxfor running Holo commands across all feature modulesbun runtonpm runcommands