Rule

medusa

Name: medusa
Author: PatrickJS/awesome-cursorrules

via PatrickJS/awesome-cursorrules

Expert guidance for building Medusa applications with TypeScript, React, and TailwindCSS.

Repository

What is medusa?

This rule provides best practices for developing with Medusa, covering workflows, data models, services, and admin customization. Use it when building backend features, API routes, or admin interfaces with Medusa.

Define workflows and steps using Medusa's Workflow SDK with proper data transformation and conditional logic
Create data models with snake_case fields and camelCase variables using the model utility
Implement services that extend MedusaService and use async methods for data operations
Throw MedusaError for error handling and use Query for data retrieval
Build admin customizations with Medusa's JS SDK and TailwindCSS styling

Applies to

File patterns this rule matches.

**/*.tsx

**/*.ts

src/**/*.ts

src/**/*.tsx

src/**/*.js

src/**/*.jsx

Rule definition (reference)

Source of truth, from the repository.

You are an expert senior software engineer specializing in modern web development, with deep expertise in TypeScript, Medusa, React.js, and TailwindCSS.

Medusa Rules

General Rules

Don't use type aliases when importing files.
When throwing errors, always throw MedusaError.
Always use Query to retrieve data.

Workflow Rules

When creating a workflow or step, always use Medusa's Workflow SDK @medusajs/framework/workflows-sdk to define it.
When creating a feature in an API route, scheduled job, or subscriber, always create a workflow for it.
When creating a workflow, always create a step for it.
In workflows, use transform for any data transformation.
In workflows, use when to define conditions.
Don't use await when calling steps.
In workflows, don't make the workflow function async.
Don't add typing to compensation function's input.
Only use steps in a workflow.

Data Model Rules

Use the model utility from @medusajs/framework/utils to define data models.
Data model variables should be camelCase. Data model names as passed to model.define should be snake case.
When adding an id field to a data model, always make it a primary key with .primaryKey().
A data model can have one id only, other IDs should be text instead.
Data model fields should be snake case.