Skip to main content

Cursor

Cursor 是一个 AI 驱动的代码编辑器，旨在通过自动执行重复的编码任务来提高工作效率。当与 Prisma（一种用于数据库工作流的强大且类型安全的工具包）搭配使用时，它将成为管理和优化数据库模式、查询和数据播种的强大解决方案。

¥Cursor is an AI-powered code editor designed to boost productivity by automating repetitive coding tasks. When paired with Prisma, a robust and type-safe toolkit for database workflows, it becomes a powerful solution for managing and optimizing database schemas, queries, and data seeding.

本指南提供了有效使用 Prisma 和 Cursor 的详细说明：

¥This guide provides detailed instructions for effectively using Prisma with Cursor to:

  • 使用 .cursorrules 定义特定于项目的最佳实践。

    ¥Define project-specific best practices with .cursorrules.

  • 使用 Cursor 的上下文感知功能。

    ¥Using Cursor's context-aware capabilities.

  • 生成适合你数据库的模式、查询和种子数据。

    ¥Generate schemas, queries, and seed data tailored to your database.

注意

虽然本指南重点介绍 Cursor，但这些模式应该适用于任何 AI 编辑器。在 X 上让我们知道 如果你希望我们为你首选的工具创建指南！

¥While this guide is focused on Cursor, these patterns should work with any AI editor. Let us know on X if you'd like us to create guides for your preferred tool!

Prisma MCP 服务器​

¥Prisma MCP server

Prisma 提供自己的 模型上下文协议 (MCP) 服务器，可让你管理 Prisma Postgres 数据库、建模数据库模式并通过迁移进行聊天。了解更多关于如何将其添加到 Cursor 此处 的信息。你也可以通过点击以下链接，使用 一键安装 将 Prisma MCP 服务器添加到 Cursor：

¥Prisma provides its own Model Context Protocol (MCP) server that lets you manage Prisma Postgres databases, model database schemas and chat through migrations. Learn more about how you can add it to Cursor here. You can also add the Prisma MCP server to Cursor using the one-click installation by clicking on the following link:

Install MCP Server

这将提示你在浏览器中打开 Cursor 应用。打开后，系统将引导你将 Prisma MCP 服务器直接安装到你的 Cursor 配置中。

¥This will prompt you to open the Cursor app in your browser. Once opened, you'll be guided to install the Prisma MCP server directly into your Cursor configuration.

使用 .cursorrules 定义项目特定规则​

¥Defining project-specific rules with .cursorrules

Cursor 中的 .cursorrules 文件 允许你实现针对你的 Prisma 项目的最佳实践和开发标准。通过定义清晰一致的规则，你可以确保 Cursor 以最少的手动调整生成干净、可维护且特定于项目的代码。

¥The .cursorrules file in Cursor allows you to enforce best practices and development standards tailored to your Prisma projects. By defining clear and consistent rules, you can ensure that Cursor generates clean, maintainable, and project-specific code with minimal manual adjustments.

要实现这些规则，请在项目的根目录中创建一个 .cursorrules 文件。以下是示例配置：

¥To implement these rules, create a .cursorrules file in the root of your project. Below is an example configuration:

示例 .cursorrules 文件

¥Example .cursorrules file

.cursorrules
You are a senior TypeScript/JavaScript programmer with expertise in Prisma, clean code principles, and modern backend development.
Generate code, corrections, and refactorings that comply with the following guidelines:
TypeScript General Guidelines
Basic Principles
- Use English for all code and documentation.
- Always declare explicit types for variables and functions.
  - Avoid using "any".
  - Create precise, descriptive types.
- Use JSDoc to document public classes and methods.
- Maintain a single export per file.
- Write self-documenting, intention-revealing code.
Nomenclature
- Use PascalCase for classes and interfaces.
- Use camelCase for variables, functions, methods.
- Use kebab-case for file and directory names.
- Use UPPERCASE for environment variables and constants.
- Start function names with a verb.
- Use verb-based names for boolean variables:
  - isLoading, hasError, canDelete
- Use complete words, avoiding unnecessary abbreviations.
  - Exceptions: standard abbreviations like API, URL
  - Accepted short forms: 
    - i, j for loop indices
    - err for errors
    - ctx for contexts
Functions
- Write concise, single-purpose functions.
  - Aim for less than 20 lines of code.
- Name functions descriptively with a verb.
- Minimize function complexity:
  - Use early returns.
  - Extract complex logic to utility functions.
- Leverage functional programming techniques:
  - Prefer map, filter, reduce.
  - Use arrow functions for simple operations.
  - Use named functions for complex logic.
- Use object parameters for multiple arguments.
- Maintain a single level of abstraction.
Data Handling
- Encapsulate data in composite types.
- Prefer immutability.
  - Use readonly for unchanging data.
  - Use as const for literal values.
- Validate data at the boundaries.
Error Handling
- Use specific, descriptive error types.
- Provide context in error messages.
- Use global error handling where appropriate.
- Log errors with sufficient context.
Prisma-Specific Guidelines
Schema Design
- Use meaningful, domain-driven model names.
- Leverage Prisma schema features:
  - Use @id for primary keys.
  - Use @unique for natural unique identifiers.
  - Utilize @relation for explicit relationship definitions.
- Keep schemas normalized and DRY.
- Use meaningful field names and types.
- Implement soft delete with deletedAt timestamp.
- Use Prisma's native type decorators.
Prisma Client Usage
- Always use type-safe Prisma client operations.
- Prefer transactions for complex, multi-step operations.
- Use Prisma middleware for cross-cutting concerns:
  - Logging
  - Soft delete
  - Auditing
- Handle optional relations explicitly.
- Use Prisma's filtering and pagination capabilities.
Database Migrations
- Create migrations for schema changes.
- Use descriptive migration names.
- Review migrations before applying.
- Never modify existing migrations.
- Keep migrations idempotent.
Error Handling with Prisma
- Catch and handle Prisma-specific errors:
  - PrismaClientKnownRequestError
  - PrismaClientUnknownRequestError
  - PrismaClientValidationError
- Provide user-friendly error messages.
- Log detailed error information for debugging.
Testing Prisma Code
- Use in-memory database for unit tests.
- Mock Prisma client for isolated testing.
- Test different scenarios:
  - Successful operations
  - Error cases
  - Edge conditions
- Use factory methods for test data generation.
- Implement integration tests with actual database.
Performance Considerations
- Use select and include judiciously.
- Avoid N+1 query problems.
- Use findMany with take and skip for pagination.
- Leverage Prisma's distinct for unique results.
- Profile and optimize database queries.
Security Best Practices
- Never expose raw Prisma client in APIs.
- Use input validation before database operations.
- Implement row-level security.
- Sanitize and validate all user inputs.
- Use Prisma's built-in protections against SQL injection.
Coding Style
- Keep Prisma-related code in dedicated repositories/modules.
- Separate data access logic from business logic.
- Create repository patterns for complex queries.
- Use dependency injection for Prisma services.
Code Quality
- Follow SOLID principles.
- Prefer composition over inheritance.
- Write clean, readable, and maintainable code.
- Continuously refactor and improve code structure.
Development Workflow
- Use version control (Git).
- Implement comprehensive test coverage.
- Use continuous integration.
- Perform regular code reviews.
- Keep dependencies up to date.

此文件确保一致且可维护的代码生成，减少人工干预，同时提高项目质量。

¥This file ensures consistent and maintainable code generation, reducing manual intervention while improving project quality.

使用 Cursor 的上下文感知功能​

¥Using Cursor's context-aware capabilities

Cursor 的 context-aware 功能可让你添加特定的网站、文件、文件夹或文档，以增强其对你项目的理解。通过添加 schema.prisma 文件作为上下文，你可以启用 Cursor 根据数据库模式生成更准确的查询、测试和种子数据。

¥Cursor's context-aware capabilities let you add specific websites, files, folders or documentation to enhance its understanding of your project. By adding your schema.prisma file as context, you enable Cursor to generate more accurate queries, tests, and seed data based on your database schema.

将 Prisma docs llm.txt 文件添加为 @Docs 上下文​

¥Add Prisma docs llm.txt file as @Docs context

为了提高 Cursor 对项目中与 Prisma 相关的建议的理解，请将 /llms.txt markdown 文件作为上下文包含在内。此文件提供简明的概述、有用的指导以及指向详细 Prisma 文档的链接 - 所有这些都针对 LLM 处理进行了优化。只需导航到 url 并将其作为 @Docs 资源添加到你的 Cursor 配置中。

¥To improve Cursor's understanding of Prisma-related suggestions in your project, include the /llms.txt markdown file as context. This file offers a concise overview, useful guidance, and links to detailed Prisma documentation—all optimized for LLM processing. Simply navigate to the url and add it as a @Docs resource in your Cursor configuration.

添加其他 Prisma 文档​

¥Adding additional Prisma documentation

Cursor 已经包含来自 Prisma 文档的内置上下文，因此你无需添加任何内容即可使用我们的文档！你可以查看 Cursor 使用 此处 的现有资源。

¥Cursor already includes built-in context from Prisma documentation, so you don't need to add anything to make us of our docs! You can view the existing resources Cursor uses here.

要了解最新更改或合并其他上下文，请将这些资源添加为 @Docs 上下文：

¥To stay updated with the latest changes or incorporate additional context, add these resources as @Docs context:

要了解如何添加和管理文档上下文，请访问 光标文档。

¥To learn how to add and manage documentation context, visit the Cursor documentation.

使用模式作为上下文​

¥Using schema as context

在请求查询、测试或种子脚本之前，使用 @Files 语法将你的 schema.prisma 文件（或整个代码库）添加为上下文。这允许 Cursor 生成精确的、模式驱动的输出，例如查询、测试和种子数据。例如，在 光标聊天 中，你可以通过键入 @Files 然后添加 schema.prisma 文件来包含你的架构。

¥Add your schema.prisma file (or the entire codebase) as context using the @Files syntax before requesting queries, tests, or seed scripts. This allows Cursor to generate precise, schema-driven outputs such as queries, tests, and seed data. For example, in Cursor Chat, you can include your schema by typing @Files followed by adding your schema.prisma file.

生成 Prisma 模式​

¥Generating Prisma Schema

Cursor 可以从高级描述中生成 Prisma 模式，使你能够快速为数据库模式建立坚实的基础。通过提供清晰详细的提示，Cursor 可以根据你的要求创建 Prisma 模式。无论你需要通用的基础模式还是针对详细用例的高度特定的模式，Cursor 都可以精确地提供。这是一个示例提示及其相应的结果：

¥Cursor can generate Prisma schemas from high-level descriptions, enabling you to quickly establish a solid foundation for your database schema. By providing a clear and detailed prompt, Cursor creates Prisma schemas tailored to your requirements. Whether you need a general foundational schema or a highly specific one for detailed use cases, Cursor can deliver with precision. Here's an example prompt and its corresponding result:

注意

如果你运行以下提示，你可能会收到不同的输出，因为 LLM 会产生非确定性响应。

¥If you run the prompts below, you may receive a different outputs because LLMs produce non-deterministic responses.

"Create a Prisma schema for a SaaS app using PostgreSQL as a provider with `User`, `Organization`, and `Subscription` models, ensuring all models include `createdAt` and `updatedAt` DateTime fields with defaults, a soft-delete `deletedAt` field, and proper relationships between entities."

生成 Prisma 查询​

¥Generating Prisma queries

Cursor 可以帮助你创建针对你的 Prisma 模式定制的查询，无论是用于基本数据检索还是复杂的优化操作。为了获得最佳结果，请专注于编写清晰、具体的提示来定义你的要求，例如要包含的字段、要应用的条件和要遍历的关系。这确保 Cursor 生成准确、高性能和类型安全的查询。这是一个示例提示及其结果查询：

¥Cursor can help you create queries tailored to your Prisma schema, whether for basic data retrieval or complex, optimized operations. To get the best results, focus on writing clear, specific prompts that define your requirements, such as the fields to include, conditions to apply, and relationships to traverse. This ensures Cursor generates accurate, performant, and type-safe queries. Here's an example prompt and its resulting query:

"Generate a query to retrieve all User records associated with an Organization that has an `active` Subscription, while excluding any records where the deletedAt field is set."

使用 Cursor 创建种子文件​

¥Creating seed files with Cursor

编写种子脚本可能是一个繁琐的过程，但 Cursor 通过快速生成结构化和有组织的种子代码简化了它。通过提供清晰的说明，你可以指导 Cursor 创建脚本，用真实数据填充数据库，包括处理模式中定义的关系和复杂结构。这是一个示例提示及其结果种子脚本：

¥Writing seed scripts can be a tedious process, but Cursor simplifies it by quickly generating structured and organized seed code. By providing clear instructions, you can guide Cursor to create scripts that populate your database with realistic data, including handling relationships and complex structures defined in your schema. Here's an example prompt and its resulting seed script:

"Generate code to populate the Prisma schema with realistic data for the User, Organization, and Subscription models, ensuring all necessary fields are included."

其他资源​

¥Additional resources

总之，将 Cursor 与 Prisma 结合使用可简化你的工作流程，从生成架构和查询到编写种子脚本。通过遵循本指南，你可以节省时间、减少错误并专注于构建应用。

¥In summary, using Cursor with Prisma simplifies your workflow, from generating schemas and queries to writing seed scripts. By following this guide, you can save time, reduce errors, and focus on building your application.

了解有关其 官方文档 中的 Cursor 的更多信息。

¥Learn more about Cursor in their official documentation.


Stay connected with Prisma

Continue your Prisma journey by connecting with our active community. Stay informed, get involved, and collaborate with other developers:

We genuinely value your involvement and look forward to having you as part of our community!