6466f3fb45
Adding a cursor rule for nx ## Changes - Added `.cursor/rules/nx-rules.mdc` - The rule provides structured guidelines for AI assistants to better help developers
34 lines
2.1 KiB
Plaintext
34 lines
2.1 KiB
Plaintext
---
|
|
description: Guidelines and best practices for working with Nx in the Twenty workspace, including workspace architecture understanding, configuration management, and generator usage.
|
|
globs:
|
|
alwaysApply: false
|
|
---
|
|
|
|
// This file is automatically generated by Nx Console
|
|
|
|
You are in an nx workspace using Nx 18.3.3 and yarn as the package manager.
|
|
|
|
You have access to the Nx MCP server and the tools it provides. Use them. Follow these guidelines in order to best help the user:
|
|
|
|
# General Guidelines
|
|
- When answering questions, use the nx_workspace tool first to gain an understanding of the workspace architecture
|
|
- For questions around nx configuration, best practices or if you're unsure, use the nx_docs tool to get relevant, up-to-date docs!! Always use this instead of assuming things about nx configuration
|
|
- If the user needs help with an Nx configuration or project graph error, use the 'nx_workspace' tool to get any errors
|
|
- To help answer questions about the workspace structure or simply help with demonstrating how tasks depend on each other, use the 'nx_visualize_graph' tool
|
|
|
|
# Generation Guidelines
|
|
If the user wants to generate something, use the following flow:
|
|
|
|
- learn about the nx workspace and any specifics the user needs by using the 'nx_workspace' tool and the 'nx_project_details' tool if applicable
|
|
- get the available generators using the 'nx_generators' tool
|
|
- decide which generator to use. If no generators seem relevant, check the 'nx_available_plugins' tool to see if the user could install a plugin to help them
|
|
- get generator details using the 'nx_generator_schema' tool
|
|
- you may use the 'nx_docs' tool to learn more about a specific generator or technology if you're unsure
|
|
- decide which options to provide in order to best complete the user's request. Don't make any assumptions and keep the options minimalistic
|
|
- open the generator UI using the 'nx_open_generate_ui' tool
|
|
- wait for the user to finish the generator
|
|
- read the generator log file using the 'nx_read_generator_log' tool
|
|
- use the information provided in the log file to answer the user's question or continue with what they were doing
|
|
|
|
|