Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@jellyfish-tom/cursor-rules) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Cursor Rules
Shared Cursor IDE rules and guidelines for TypeScript/React projects.
Installation
npm install --save-dev @jellyfish-tom/cursor-rulesThe package automatically copies the .cursor directory to your project root after installation via the postinstall script.
Usage
After installation, the .cursor directory is available in your project root with all rules and commands. Cursor IDE automatically picks up these rules.
Updating Rules
To update the rules in all projects:
- Update the rules in this repository
- Publish a new version to npm
- Run
npm update @jellyfish-tom/cursor-rulesin your projects
Manual Installation
If you need to manually copy the rules:
cp -r node_modules/@jellyfish-tom/cursor-rules/.cursor ./Contents
- Rules: TypeScript, React, coding guidelines, refactoring patterns, and more
- Commands: Custom Cursor commands
Development
To test locally:
npm link
cd /path/to/your/project
npm link @jellyfish-tom/cursor-rules