Skip to content

feat: add commands to download cursor rules #20

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

Merged
merged 7 commits into from
May 16, 2025

Conversation

westonplatter
Copy link
Member

@westonplatter westonplatter commented May 14, 2025

what

  • Create commands to download cursor-rules from an internal repo
  • taskit cursor:fetch-rule -- cursor_rules.mdc
  • taskit cursor:fetch-rules-all

why

  • I'd like to create an easily way to pull down Cursor rules across multiple repos

references

Summary by CodeRabbit

  • Chores
    • Added a configuration to exclude .cursor-rules directory from version control.
    • Updated task configuration to include a new module for rule management.
    • Introduced automated tasks for securely fetching single or multiple rule files from a private repository into a local directory.

@westonplatter westonplatter requested a review from a team as a code owner May 14, 2025 22:05
Copy link

coderabbitai bot commented May 14, 2025

Walkthrough

A new .gitignore file is added to exclude the .cursor-rules directory from version control. The Taskfile.yaml is updated to include a new module named cursor mapped to lib/cursor. Within lib/cursor, a new Taskfile.yml is introduced, defining two tasks: fetch-rule for downloading a specific file from a private GitHub repository, and fetch-rules-all for downloading all files from a designated directory in the same repository. Both tasks require a GITHUB_TOKEN for authentication and utilize the jq tool for processing JSON responses.

[!ANNOUNCEMENT]

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


[!ANNOUNCEMENT]

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

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.

Copy link

@coderabbitai coderabbitai bot left a 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 (4)
.gitignore (1)

1-1: Prefer ignoring the directory, not just its contents
Using .cursor-rules/* ignores files inside the directory but not the directory itself (e.g., newly created subdirectories). It’s more robust to ignore the directory recursively:

-.cursor-rules/*
+.cursor-rules/
lib/cursor/Taskfile.yml (3)

8-13: DRY: Extract shared variables to top-level
Both fetch-rule and fetch-rules-all repeat OWNER, REPO, REF, and OUTDIR. You can move these to a top-level vars: block to avoid repetition:

version: "3"
vars:
  OWNER: masterpointio
  REPO: internal-cursor-rules
  REF: main
  OUTDIR: .cursor-rules

tasks:
  fetch-rule:
    vars:
      filename: '{{default "cursor_rules.mdc" .CLI_ARGS}}'
    ...
  fetch-rules-all:
    vars:
      SRC_DIR: rules
    ...

Also applies to: 38-43


31-33: Ensure curl is available in preconditions
You currently check for jq (in fetch-rules-all) and GITHUB_TOKEN, but don’t verify that curl exists. If curl is missing, the download steps will fail unpredictably. Add a command -v curl >/dev/null 2>&1 check to both tasks’ preconditions:

preconditions:
  - command -v curl >/dev/null 2>&1
  - test -n "$GITHUB_TOKEN"

Also applies to: 71-73


26-30: Improve error handling for downloads
By default, curl -sSL will write HTTP error pages into your output files on failure. Add --fail (-f) so that non-2xx responses cause curl to exit non-zero:

- curl -sSL \
+ curl -sSLf \

Optionally, at the top of each shell block you could add set -euo pipefail to make any command failure abort the task immediately.

Also applies to: 65-69

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f3dce3a and 38f6471.

📒 Files selected for processing (3)
  • .gitignore (1 hunks)
  • Taskfile.yaml (1 hunks)
  • lib/cursor/Taskfile.yml (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.yaml`: You are well-versed in writing and reviewing YAML configurations for the Task tool (https://taskfile.dev/). Provide recommendations for clarity, maintainability, and a...

**/*.yaml: You are well-versed in writing and reviewing YAML configurations for the Task tool (https://taskfile.dev/).
Provide recommendations for clarity, maintainability, and adherence to Taskfile best practices, including usage of variables, environment blocks, and includes.
These configurations may also contain embedded Bash scripts or commands.
Demonstrate bash scripting best practices such as error handling, secure variable expansions, and clear documentation.

  • Taskfile.yaml
🔇 Additional comments (1)
Taskfile.yaml (1)

7-7: Module inclusion looks good
The new cursor: lib/cursor entry correctly integrates the cursor tasks into the root Taskfile.yaml.

@westonplatter westonplatter force-pushed the feat/add-cursor-rules-download-utility branch from 7b463dd to 0aea9da Compare May 14, 2025 22:29
@westonplatter westonplatter requested a review from gberenice May 15, 2025 15:25
@westonplatter westonplatter enabled auto-merge (squash) May 15, 2025 21:15
Copy link
Member

@gberenice gberenice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@westonplatter westonplatter merged commit de411c2 into main May 16, 2025
2 checks passed
@westonplatter westonplatter deleted the feat/add-cursor-rules-download-utility branch May 16, 2025 09:31
oycyc pushed a commit that referenced this pull request Jun 6, 2025
🤖 I have created a release *beep* *boop*
---


##
[0.4.0](v0.3.1...v0.4.0)
(2025-06-04)


### Features

* add commands to download cursor rules
([#20](#20))
([de411c2](de411c2))
* small solutions for running task os:sync-all
([#23](#23))
([0b2ddc3](0b2ddc3))


### Bug Fixes

* **snaplet:** add snaplet target DB var to SNAPSHOT_PATHs
([#25](#25))
([f5e70c6](f5e70c6))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants