Adds Cursor rules for writing Trigger.dev tasks

[samejr]

New Cursor rules for writing Trigger.dev tasks

The file contains:

• A strict deprecation ruleset to prevent v2 tasks being written by mistake
• A condensed list of functions, config settings and descriptions for all the main ways to write tasks correctly
• A final checklist before to verify any code generated
• Further resources to be got from trigger.dev/docs/llms.txt

Summary by CodeRabbit

• Documentation
  • Introduced a comprehensive guide for writing tasks in Trigger.dev.
  • The guidelines cover step-by-step instructions for task setup, environment configuration, lifecycle management, scheduling, and best practices.
  • This update helps ensure consistent and correct task implementations across the ecosystem.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 9d06c11

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

A new markdown document has been added at .cursor/rules/writing-tasks.mdc to serve as a comprehensive guide for writing tasks in Trigger.dev. The file details the workflow for creating, configuring, and executing tasks via CLI commands, proper environment setup, and lifecycle management. It specifies strict requirements for AI-generated code, including the usage of the @trigger.dev/sdk/v3 package, and outlines the acceptable and deprecated code patterns along with instructions for task scheduling, schema validation, and metadata handling.

Changes

File	Summary
.cursor/rules/writing-tasks.mdc	New file with detailed guidelines for writing Trigger.dev tasks, covering CLI initialization, environment variable setup, lifecycle functions (init, cleanup, onStart, etc.), and code practices.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant CLI as CLI Tool
    participant Env as Environment
    participant Engine as Task Engine

    Dev->>CLI: Run initialization command
    CLI->>Dev: Display setup instructions (env variables, etc.)
    Dev->>Env: Configure environment variables
    Dev->>CLI: Execute development command
    CLI->>Engine: Trigger task execution
    Engine->>Engine: Run lifecycle functions (init, onStart, onSuccess, onFailure, handleError)

Loading

Poem

I’m a rabbit in the code-filled glen,
Hopping 'round tasks again and again.
New guidelines sprout like fresh spring carrots,
Directing each line with friendly merits.
In this garden of code, I cheer and play,
Celebrating clear rules every byte of the day!
🐰 Happy coding in our whimsical way!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

.cursor/rules/writing-tasks.mdc (1)

317-317: Fix typographical error.

“Sepcify” should be “Specify” to maintain professionalism and consistency.

-// Sepcify a cron pattern (UTC)
+// Specify a cron pattern (UTC)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7f25697 and 9d06c11.

📒 Files selected for processing (1)

• .cursor/rules/writing-tasks.mdc (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (7)

• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
• GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
• GitHub Check: typecheck / typecheck
• GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
• GitHub Check: units / 🧪 Unit Tests
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (2)

.cursor/rules/writing-tasks.mdc (2)

15-44: Commendable clarity on deprecated vs. correct patterns.

This section clearly distinguishes which legacy patterns to avoid and which updated approach to adopt. It helps prevent confusion and ensures consistent usage of the new task API from @trigger.dev/sdk/v3. Great job documenting these differences in detail.

---

1248-1270: Excellent verification steps for AI-generated code.

The explicit checklist and consequences for not adhering to these guidelines set a high standard of quality control. This clarity helps ensure that any generated code properly follows the new Trigger.dev v3 task patterns.