Added missing trigger.config options to the docs #2409
Conversation
|
WalkthroughAdds extensive documentation to docs/config/config-file.mdx describing new and existing Trigger configuration options, including custom tsconfig path, console logging controls, process keep-alive settings, development working directory behavior, extra CA certificates, build configuration flags, and scaffolding for various extensions (files, packages, Prisma, env sync, puppeteer, ffmpeg, esbuild plugins, apt-get). Example config blocks are updated to illustrate these options. In packages/core/src/v3/config.ts, a JSDoc comment for the extra CA certificates setting is reworded slightly with no functional or type changes. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches
🧪 Generate unit tests
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. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 2
🔭 Outside diff range comments (2)
packages/core/src/v3/config.ts (1)
319-325: Fix env var name and grammar in JSDoc (NODE_EXTRA_CA_CERTS, self‑signed).Node uses NODE_EXTRA_CA_CERTS (plural). The current singular name and phrasing are misleading.
Apply this diff:
- /** - * CA Cert file to be added to NODE_EXTRA_CA_CERT environment variable, useful in use with self signed cert in the trigger.dev environment. + /** + * CA certificate file to be added to the NODE_EXTRA_CA_CERTS environment variable; useful when using a self-signed certificate in the Trigger.dev environment. * * @example "./certs/ca.crt" * Note: must start with "./" and be relative to the project root. * */docs/config/config-file.mdx (1)
272-274: Property name mismatch: usemachine, notdefaultMachine.The config type exposes
machine?: MachinePresetName;. UsingdefaultMachinewill be ignored by the system and misleads users.Apply this diff:
- defaultMachine: "large-1x", + machine: "large-1x",
🧹 Nitpick comments (3)
docs/config/config-file.mdx (3)
47-49: Grammar: “with be” → “will be” and add article.Apply this diff:
-anything defined in the `build` config is automatically stripped out of the config file, and -imports used inside build config with be tree-shaken out. +anything defined in the `build` config is automatically stripped out of the config file, and +imports used inside the `build` config will be tree-shaken out.
415-416: Grammar: “These means” → “This means”.Apply this diff:
- stripped out. These means any imports only used inside the `build` configuration are also removed + stripped out. This means any imports only used inside the `build` configuration are also removed
499-499: Word choice: “effect” → “affect”.Apply this diff:
-These conditions effect how imports are resolved during the build process. For example, the `react-server` condition will resolve `ai/rsc` to the server version of the `ai/rsc` export. +These conditions affect how imports are resolved during the build process. For example, the `react-server` condition will resolve `ai/rsc` to the server version of the `ai/rsc` export.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
docs/config/config-file.mdx(4 hunks)packages/core/src/v3/config.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)
**/*.{ts,tsx}: Always prefer using isomorphic code like fetch, ReadableStream, etc. instead of Node.js specific code
For TypeScript, we usually use types over interfaces
Avoid enums
No default exports, use function declarations
Files:
packages/core/src/v3/config.ts
{packages/core,apps/webapp}/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)
We use zod a lot in packages/core and in the webapp
Files:
packages/core/src/v3/config.ts
🧠 Learnings (12)
📓 Common learnings
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
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
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
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)
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Import Trigger.dev APIs from "trigger.dev/sdk/v3" when writing tasks or related utilities
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
Learning: Applies to trigger.config.ts : Configure global task lifecycle hooks (onStart/onSuccess/onFailure) only within trigger.config.ts if needed, not within arbitrary files
📚 Learning: 2025-08-18T10:07:17.345Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
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:
packages/core/src/v3/config.tsdocs/config/config-file.mdx
📚 Learning: 2025-08-18T10:07:17.345Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
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:
packages/core/src/v3/config.tsdocs/config/config-file.mdx
📚 Learning: 2025-08-18T10:07:17.345Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Import Trigger.dev APIs from "trigger.dev/sdk/v3" when writing tasks or related utilities
Applied to files:
docs/config/config-file.mdx
📚 Learning: 2025-08-18T10:07:17.345Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
Learning: Applies to trigger.config.ts : Configure global task lifecycle hooks (onStart/onSuccess/onFailure) only within trigger.config.ts if needed, not within arbitrary files
Applied to files:
docs/config/config-file.mdx
📚 Learning: 2025-08-18T10:07:17.345Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Define tasks using task({ id, run, ... }) with a unique id per project
Applied to files:
docs/config/config-file.mdx
📚 Learning: 2025-08-18T10:07:17.345Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Do not use client.defineJob or any deprecated v2 patterns (e.g., eventTrigger) when defining tasks
Applied to files:
docs/config/config-file.mdx
📚 Learning: 2025-08-18T10:07:17.345Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use triggerAndWait() only from within a task context (not from generic app code) and handle result.ok or use unwrap() with error handling
Applied to files:
docs/config/config-file.mdx
📚 Learning: 2025-08-18T10:07:17.345Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Export every task (including subtasks) defined with task(), schedules.task(), or schemaTask()
Applied to files:
docs/config/config-file.mdx
📚 Learning: 2025-08-18T10:07:17.345Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use schemaTask({ schema, run, ... }) to validate payloads when input validation is required
Applied to files:
docs/config/config-file.mdx
📚 Learning: 2025-08-18T10:07:17.345Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use schedules.task(...) for scheduled (cron) tasks; do not implement schedules as plain task() with external cron logic
Applied to files:
docs/config/config-file.mdx
📚 Learning: 2025-08-18T10:07:17.345Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Inside tasks, prefer logger.debug/log/info/warn/error over ad-hoc console logging for structured logs
Applied to files:
docs/config/config-file.mdx
🪛 LanguageTool
docs/config/config-file.mdx
[grammar] ~377-~377: There might be a mistake here.
Context: ... certificates CA Cert file to be added to NODE_EXTRA_CA_CERT environment variable...
(QB_NEW_EN)
⏰ 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). (23)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 8)
- GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
- GitHub Check: typecheck / typecheck
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
docs/config/config-file.mdx (1)
78-91: Docs additions look solid and align with config types.New sections for tsconfig path, console logging controls, process keep-alive, dev CWD behavior, CA certs, and build flags match the
TriggerConfigshape and defaults.Also applies to: 294-307, 325-357, 359-371, 375-388, 403-409
| @@ -277,6 +291,21 @@ export default defineConfig({ | |||
|
|
|||
| The `logLevel` only determines which logs are sent to the Trigger.dev instance when using the `logger` API. All `console` based logs are always sent. | |||
There was a problem hiding this comment.
Console logging statement contradicts new options.
“All console based logs are always sent.” is no longer accurate with disableConsoleInterceptor. Clarify the default and the override.
Apply this diff:
-The `logLevel` only determines which logs are sent to the Trigger.dev instance when using the `logger` API. All `console` based logs are always sent.
+The `logLevel` only determines which logs are sent when using the `logger` API. Console-based logs are sent by default, unless `disableConsoleInterceptor` is set to `true`.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The `logLevel` only determines which logs are sent to the Trigger.dev instance when using the `logger` API. All `console` based logs are always sent. | |
| The `logLevel` only determines which logs are sent when using the `logger` API. Console-based logs are sent by default, unless `disableConsoleInterceptor` is set to `true`. |
🤖 Prompt for AI Agents
In docs/config/config-file.mdx around line 292, the sentence "All `console`
based logs are always sent." is inaccurate because `disableConsoleInterceptor`
can override that behavior; update the text to state the default behavior
(console logs are sent to the Trigger.dev instance unless
`disableConsoleInterceptor: true` is set) and clarify that `logLevel` controls
which logs the `logger` API sends while console interception can be disabled by
the `disableConsoleInterceptor` option; make the wording concise and explicit
about the default and the override.
|
|
||
| ## CA certificates | ||
|
|
||
| CA Cert file to be added to NODE_EXTRA_CA_CERT environment variable, useful in use with self signed cert in the trigger.dev environment. |
There was a problem hiding this comment.
Correct env var and grammar (NODE_EXTRA_CA_CERTS; self‑signed).
Use the correct Node env var and improve phrasing.
Apply this diff:
-CA Cert file to be added to NODE_EXTRA_CA_CERT environment variable, useful in use with self signed cert in the trigger.dev environment.
+CA certificate file to be added to the NODE_EXTRA_CA_CERTS environment variable; useful when using a self-signed certificate in the Trigger.dev environment.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| CA Cert file to be added to NODE_EXTRA_CA_CERT environment variable, useful in use with self signed cert in the trigger.dev environment. | |
| CA certificate file to be added to the NODE_EXTRA_CA_CERTS environment variable; useful when using a self-signed certificate in the Trigger.dev environment. |
🧰 Tools
🪛 LanguageTool
[grammar] ~377-~377: There might be a mistake here.
Context: ... certificates CA Cert file to be added to NODE_EXTRA_CA_CERT environment variable...
(QB_NEW_EN)
🤖 Prompt for AI Agents
In docs/config/config-file.mdx around line 377, the sentence uses the wrong Node
environment variable name and has awkward grammar; update it to reference
NODE_EXTRA_CA_CERTS (plural) and improve phrasing to mention "self-signed
certificates" and that the CA cert file should be added to NODE_EXTRA_CA_CERTS,
e.g. rewrite the line to something like: "CA certificate file(s) to add to the
NODE_EXTRA_CA_CERTS environment variable; useful when using self-signed
certificates in the trigger.dev environment." Ensure "NODE_EXTRA_CA_CERTS" is
spelled exactly and replace "self signed cert" with "self-signed certificates."
No description provided.