chore(docs): remove Cursor rules support - #443
Conversation
Remove Cursor editor integration from the @gunshi/docs package. Cursor can now read CLAUDE.md and Claude Code skills directly, making separate Cursor rules configuration redundant. Changes: - Remove Cursor/cursor-agent detection in init.js - Remove .cursor/rules symlink/file creation logic - Remove Windows-specific handling for Cursor rules - Update setup.md to reference only Claude Code - Update v0.27 release notes to remove Cursor mentions
WalkthroughThe PR removes Cursor integration from the CLI initialization script, setup documentation, and release notes. The init process simplifies to handle Claude Code skills only, with conditional CLAUDE.md updates based on Gunshi presence. All Cursor configuration and setup guidance references are removed. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (3)
🧰 Additional context used📓 Path-based instructions (2)packages/docs/**/*📄 CodeRabbit inference engine (CLAUDE.md)
Files:
**/*.{ts,tsx,js,jsx}📄 CodeRabbit inference engine (CLAUDE.md)
Files:
🧠 Learnings (1)📚 Learning: 2025-12-11T17:01:43.864ZApplied to files:
⏰ 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)
🔇 Additional comments (5)
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 |
@gunshi/bone
@gunshi/definition
@gunshi/docs
gunshi
@gunshi/plugin
@gunshi/plugin-completion
@gunshi/plugin-dryrun
@gunshi/plugin-global
@gunshi/plugin-i18n
@gunshi/plugin-renderer
@gunshi/resources
@gunshi/shared
commit: |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
packages/docs/bin/init.js (1)
70-76: Cross-platform issue:mkdir -pfails on Windows.The
mkdir -pcommand is Unix-specific and will fail on Windows (cmd.exe doesn't recognize the-pflag). This prevents Windows users from using the init script.🔎 Apply this diff to use Node.js built-in mkdir for cross-platform compatibility:
-await x('mkdir', ['-p', path.dirname(CLAUDE_SKILL_PATH)]) +await fs.mkdir(path.dirname(CLAUDE_SKILL_PATH), { recursive: true }) await fs.writeFile(CLAUDE_SKILL_PATH, SKILL_CONTENT, 'utf8') console.log(`Created Claude skill at ${CLAUDE_SKILL_PATH}`)
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
packages/docs/bin/init.js(2 hunks)packages/docs/src/guide/introduction/setup.md(3 hunks)packages/docs/src/release/v0.27.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
packages/docs/**/*
📄 CodeRabbit inference engine (CLAUDE.md)
Update documentation when adding new features or changing APIs in the documentation site at
packages/docs/
Files:
packages/docs/src/guide/introduction/setup.mdpackages/docs/src/release/v0.27.mdpackages/docs/bin/init.js
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (CLAUDE.md)
Code style must be enforced by ESLint and Prettier; run
pnpm fixto auto-fix issues
Files:
packages/docs/bin/init.js
🧠 Learnings (1)
📚 Learning: 2025-12-11T17:01:43.864Z
Learnt from: CR
Repo: kazupon/gunshi PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-11T17:01:43.864Z
Learning: Applies to packages/gunshi/src/utils.ts : Runtime-specific utilities must be implemented in `packages/gunshi/src/utils.ts` for Node.js, Deno, and Bun compatibility
Applied to files:
packages/docs/bin/init.js
⏰ 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: Test on Node.js 20
🔇 Additional comments (5)
packages/docs/src/release/v0.27.md (1)
185-195: LGTM - Clean removal of Cursor references.The documentation now correctly describes the package as supporting Claude Code only, which aligns with the PR objective that Cursor can now read CLAUDE.md and Claude Code skills directly.
packages/docs/src/guide/introduction/setup.md (1)
34-99: LGTM - Documentation consolidated to Claude Code only.The setup documentation now provides a streamlined experience focused solely on Claude Code integration, which simplifies the setup process for users.
packages/docs/bin/init.js (3)
44-46: Claude Code detection is Unix-focused but safely handled.The
whichcommand is Unix-specific and may not work on Windows, but the error handling (throwOnError: falseand.catch()) ensures it defaults tofalsegracefully. This means Windows users won't get automatic CLAUDE.md updates, but the skill file will still be created successfully.
78-97: LGTM - Robust CLAUDE.md update logic.The logic correctly handles all cases: existing file with/without Gunshi instructions, new file creation, and skipping when instructions already exist. Good use of
hasGunshiInstructionhelper to prevent duplication.
99-132: LGTM - Clear and user-friendly installation flow.The interactive prompt correctly installs gunshi as a production dependency and @gunshi/docs as a dev dependency, with appropriate error handling and fallback instructions.
2 participants
Summary
Remove Cursor editor integration from the @gunshi/docs package.
Why
Cursor can now read
CLAUDE.mdand Claude Code skills directly, making separate Cursor rules configuration redundant. This simplifies the LLM-assisted development setup by maintaining only the Claude Code skills as the single source of truth.What Changed
Summary by CodeRabbit
Release Notes
✏️ Tip: You can customize this high-level summary in your review settings.