-
-
Notifications
You must be signed in to change notification settings - Fork 828
Additional files docs with legacyDevProcessCwdBehaviour #2543
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
Walkthrough
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal). Please share your feedback with us on this Discord post. 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/config/extensions/additionalFiles.mdx (3)
16-18
: Clarify default/scope and caution existing projects
- Confirm the default is indeed true in the current release and that this flag only changes dev-time CWD (not deploy).
- Consider adding a brief note that flipping this may break path assumptions in existing projects; recommend for new projects first.
Suggested addition:
// We strongly recommend setting this to false // When set to `false`, the current working directory will be set to the build directory, which more closely matches production behavior. legacyDevProcessCwdBehaviour: false, // Default: true + // Note: Changing this may break existing dev setups that rely on process.cwd() pointing to the project root. + // We recommend enabling this for new projects or after auditing file path usage.
20-20
: Normalize path style in example for consistencyUse consistent leading "./" (or omit it for both). This avoids reader confusion about relative path handling.
- extensions: [additionalFiles({ files: ["./assets/**", "wrangler/wrangler.toml"] })], + extensions: [additionalFiles({ files: ["./assets/**", "./wrangler/wrangler.toml"] })],
29-36
: Good, but add a usage hintSnippet is solid. Consider showing a quick fs read example to make the intention explicit.
import path from "node:path"; // You can use `process.cwd()` if you use `legacyDevProcessCwdBehaviour: false` const interRegularFont = path.join(process.cwd(), "assets/Inter-Regular.ttf"); +// e.g. read at runtime: +// import fs from "node:fs"; +// const fontBuffer = fs.readFileSync(interRegularFont);
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/config/extensions/additionalFiles.mdx
(2 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to trigger.config.ts : Declare build options and extensions (external, jsx, conditions, extensions) via the build block in trigger.config.ts rather than custom scripts
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to trigger.config.ts : Provide a valid Trigger.dev configuration using defineConfig with project ref and dirs (e.g., ["./trigger"]; tests/specs auto-excluded)
Applied to files:
docs/config/extensions/additionalFiles.mdx
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to trigger.config.ts : Declare build options and extensions (external, jsx, conditions, extensions) via the build block in trigger.config.ts rather than custom scripts
Applied to files:
docs/config/extensions/additionalFiles.mdx
📚 Learning: 2025-08-29T10:06:49.293Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/webapp.mdc:0-0
Timestamp: 2025-08-29T10:06:49.293Z
Learning: Applies to apps/webapp/**/*.{ts,tsx} : When importing from trigger.dev/core in the webapp, never import the root package path; always use one of the documented subpath exports from trigger.dev/core’s package.json
Applied to files:
docs/config/extensions/additionalFiles.mdx
⏰ 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: Analyze (javascript-typescript)
No description provided.