-
-
Notifications
You must be signed in to change notification settings - Fork 287
docs: add Cursor IDE development rules with MCP integration for enhanced developer experience #1819
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
Conversation
✅ Deploy Preview for analog-blog ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for analog-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for analog-app ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
@brandonroberts plan is to keep stacking rules per package so we can do some refactoring (no changes to functionality) to enhance test coverage, debuggability, and make it easy for new contributors to understand the pipeline of the tooling ... vite/nitro/h3 etc ... |
✅ Deploy Preview for analog-ng-app ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
@brandonroberts |
- Lint: `nx lint content-plugin` | ||
|
||
## Build Details | ||
- Uses esbuild executor |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is incorrect.
- Uses esbuild executor | |
- Uses esbuild executor |
- Part of release build process | ||
|
||
## Build Details | ||
- Uses esbuild executor |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above
## Build Details | ||
- Uses esbuild executor | ||
- Multiple entry points for different features | ||
- Output format: CommonJS No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an ESM plugin
label: 'Version Compatibilty', | ||
}, | ||
{ | ||
type: 'doc', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should go into a different section for developers. This isn't necessarily for end users
}, | ||
"nxCloudAccessToken": "NDRkYzdkYmMtNDI3NS00MDI0LWFkMGQtMmI0Zjc2MTY2YzU0fHJlYWQtb25seQ==", | ||
"defaultBase": "beta", | ||
"tui": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Revert these
- Part of release build process | ||
|
||
## Testing | ||
- Unit tests with Jest |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Unit tests with Jest | |
- Unit tests with Vitest |
## Build Details | ||
- TypeScript compilation with swc | ||
- Generators and executors for Nx workspace | ||
- Not tagged for release (published separately) No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This package is published as part of the @analogjs/platform
package.
builder: { | ||
viteConfigPath: 'path/to/vite.config.ts' | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove
builder: { | |
viteConfigPath: 'path/to/vite.config.ts' | |
} |
🎯 Overview
This PR introduces comprehensive Cursor IDE integration and development rules to enhance the developer experience across the entire Analog workspace. The changes establish consistent coding practices, AI-assisted development capabilities, and streamlined workflows for all contributors.
✨ Key Changes
🔧 Infrastructure Enhancements
.cursor/mcp.json
for AI-assisted development with Nx toolsnx.json
for better developer experience📚 Package-Specific Documentation
🏗️ Development Workflow Improvements
💢 Impact
🚀 Benefits for Maintainers
📁 Files Changed
Global Configuration
.cursor/mcp.json
- Nx MCP server configuration.cursor/rules/nx-rules.mdc
- Nx workspace guidelines.cursor/rules/repo-ci-cd.mdc
- Global CI/CD practices.cursor/settings.json
- Cursor IDE settingsnx.json
- TUI configuration addedPackage-Specific Rules
Each package now includes:
.cursor/rules/ci-cd.mdc
- CI/CD guidelines.cursor/rules/development.mdc
- Development best practicesApps:
analog-app
,blog-app
,docs-app
,ng-app
,trpc-app
Packages:
astro-angular
,content
,content-plugin
,create-analog
,nx-plugin
,platform
,router
,storybook-angular
,trpc
,vite-plugin-angular
,vite-plugin-nitro
,vitest-angular
🧪 Testing
📝 Migration Notes