fix: unintended project initialization at absolute path /trigger during project initialization

[amuwal]

Closes #1081

✅ Checklist

• I have followed every step in the contributing guide
• The PR title follows the convention.
• I ran and tested the code works

---

Testing

[Describe the steps you took to test this change]

• Ran init command in /references/hello-world
• Gave /trigger input as project path
• Verified that /trigger is present at /references/hello-world/trigger

---

Summary by CodeRabbit

Summary by CodeRabbit

• Documentation

  • Updated instructions for running the CLI from source, clarifying the location of job catalogs and modifying the command structure for execution.

• Bug Fixes

  • Improved handling of directory paths in the initialization process, ensuring robustness by stripping leading slashes from the location variable.
  • Fixed an issue to prevent unintended project initialization at the absolute path /trigger.

[changeset-bot]

🦋 Changeset detected

Latest commit: 8a32367

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages

Name	Type
trigger.dev	Patch
@trigger.dev/build	Patch
@trigger.dev/core	Patch
@trigger.dev/sdk	Patch
@trigger.dev/database	Patch
@trigger.dev/otlp-importer	Patch
@internal/redis-worker	Patch
@internal/zod-worker	Patch
@internal/testcontainers	Patch

Not sure what this means? Click here to learn what changesets are.

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

[coderabbitai]

Walkthrough

The changes in this pull request include updates to the CLI documentation and modifications to the createTriggerDir function in the init.ts file. The documentation clarifies the location of job catalogs and alters the command for executing the CLI. The function now ensures that leading slashes in the directory path are stripped, making the path relative. Minor improvements were also made to comments and logging for better clarity.

Changes

File Path	Change Summary
packages/cli-v3/DEVELOPMENT.md	Updated documentation for running the CLI from source, clarifying job catalog location and command structure.
packages/cli-v3/src/commands/init.ts	Modified createTriggerDir to strip leading slashes from the location variable for relative path handling; improved comments and logging.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure the path for CLI initialization is treated as relative (#1081)	✅

Possibly related PRs

• v3: self-hosting support for latest packages #1319: This PR includes updates to the documentation related to self-hosting, which aligns with the changes made in the main PR regarding CLI usage and command structure.
• doc: add instructions to create new reference project and run it locally #1417: This PR enhances documentation for creating and running reference projects, which may relate to the CLI instructions updated in the main PR, as both involve user guidance for utilizing the CLI effectively.

🐰 "In the garden where we play,
The paths are clear, no more dismay.
With commands now bright and neat,
We hop along, our work's complete!
Job catalogs in their place,
A happy rabbit, a smiling face!" 🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 711a83a and 8a32367.

📒 Files selected for processing (3)

• .changeset/gentle-mails-sip.md (1 hunks)
• packages/cli-v3/DEVELOPMENT.md (1 hunks)
• packages/cli-v3/src/commands/init.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (3)

• .changeset/gentle-mails-sip.md
• packages/cli-v3/DEVELOPMENT.md
• packages/cli-v3/src/commands/init.ts

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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

🧹 Outside diff range and nitpick comments (2)

packages/cli-v3/DEVELOPMENT.md (1)

10-10: Approved with a suggestion for clarity

The updated description provides more specific information about the location of job-catalogs, which is helpful for users. However, to avoid potential confusion, consider clarifying whether "/references" is an absolute path or relative to the project root.

Suggestion: Consider rephrasing to "job-catalogs located in the references directory of the project" if it's not an absolute path.

packages/cli-v3/src/commands/init.ts (1)

232-234: LGTM! This change addresses the unintended project initialization issue.

The addition of location.replace(/^\//, "") ensures that the path is always treated as relative, preventing unintended project initialization at the root of the drive. This effectively resolves the issue described in #1081.

A minor suggestion to improve code clarity:

Consider adding a comment explaining why we're stripping the leading slash. This will help future maintainers understand the rationale behind this change. For example:

 // Ensure that the path is always relative by stripping leading '/' if present
-const relativeLocation = location.replace(/^\//, "");
+// This prevents unintended project initialization at the root of the drive (issue #1081)
+const relativeLocation = location.replace(/^\//, "");

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between be7790b and b3a2a25.

📒 Files selected for processing (2)

• packages/cli-v3/DEVELOPMENT.md (1 hunks)
• packages/cli-v3/src/commands/init.ts (1 hunks)

🧰 Additional context used

🔇 Additional comments (2)

packages/cli-v3/DEVELOPMENT.md (2)

Line range hint 1-14: Documentation updates align well with PR objectives

The changes to this file improve the clarity of instructions for running the CLI from source. They provide more specific information about job-catalog locations and reflect updates to the CLI command structure. These updates align well with the PR objectives of enhancing CLI initialization and documentation.

---

14-14: Approved with a request for additional information

The updated command structure provides more flexibility and aligns with common CLI patterns. This change improves usability and is consistent with the PR objectives.

To ensure completeness of the documentation:

1. Could you provide examples of common commands that users might use?
2. Is there a way to list all available commands (e.g., a --help option)?

To verify the available commands, we can run the following script: