Medusa

Hält KI-generierten Code in Medusa-Commerce-Projekten an die Framework-eigenen Konventionen.

Original-Beschreibung der Autoren: Cursor rules for Medusa.

Die Regel

---
description: "Cursor rules for Medusa."
globs: **/*
alwaysApply: false
---
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.

## Service Rules

- When creating a service, always make methods async.
- If a module has data models, make the service extend `MedusaService`.

## Admin Customization Rules

- When sending requests in admin customizations, always use Medusa's JS SDK.
- Use TailwindCSS for styling.

# Additional Resources

- [Medusa Documentation](https://docs.medusajs.com/llms-full.txt)

So nutzt du sie

Die Regel kopieren (Button oben) oder als Datei herunterladen und im Projekt unter .cursor/rules/ ablegen — Cursor lädt sie beim nächsten Start automatisch. Ältere Cursor-Versionen lesen alternativ eine einzelne .cursorrules-Datei im Projektstamm; dort einfach den Regel-Text ohne den Kopfblock zwischen den ----Zeilen einfügen.

Der Regel-Text ist englisch — Cursor versteht ihn unabhängig von der Sprache, in der Sie mit dem Editor chatten.

Im Detail

Diese Cursor-Regel richtet sich an Teams, die mit dem Open-Source-E-Commerce-Framework Medusa arbeiten. Sie sorgt dafür, dass die KI beim Generieren von Code die Medusa-spezifischen Muster einhält – etwa Modul-Struktur, Service- und Repository-Konventionen sowie die Event-Bus-Architektur des Frameworks. Statt generischen Node.js-Code vorzuschlagen, orientiert sich die KI an den tatsächlichen Medusa-APIs. Das spart Zeit beim Reviewen und verhindert Vorschläge, die nicht zum Framework passen oder veraltete Muster verwenden. Sinnvoll für Entwickler, die bereits ein Medusa-Backend betreiben und Cursor als Haupt-Editor nutzen; für Neueinsteiger ins Framework bringt sie wenig, da sie Konventionen voraussetzt statt sie zu erklären.

Praxis-Tipp

Regel aktivieren, dann z. B. “Erstelle einen neuen Fulfillment-Service für Versand-Provider X” eingeben – die KI hält sich dabei an Medusas Service-Pattern statt eigene Strukturen zu erfinden.

Lizenz & Quelle

• Lizenz: CC0 1.0
• Quelle: PatrickJS/awesome-cursorrules (GitHub)

Lade …