primary-key-required - ESLint plugin rules

This rule requires that a data model defined with model.define declares a primary key via .primaryKey().

Severity#

warn. This rule is enabled in the recommended preset.

What it Targets#

This rule targets data model files in your project's src/modules directory. It reports a model.define schema that doesn't declare a primary key on any of its properties.

The following code is reported by the rule:

src/modules/blog/models/post.ts
1import { model } from "@medusajs/framework/utils"2
3export const Post = model.define("post", {4  id: model.id(),5  title: model.text(),6})

Instead, add .primaryKey() to one of the properties:

src/modules/blog/models/post.ts
1import { model } from "@medusajs/framework/utils"2
3export const Post = model.define("post", {4  id: model.id().primaryKey(),5  title: model.text(),6})

Why it's Important#

A data model needs a primary key to uniquely identify each record. Without one, the model can't be persisted or queried reliably.

Learn more in the Data Models documentation.

Fixable#

This rule isn't auto-fixable.

Turn it Off#

To turn off this rule, set it to off in your ESLint configuration:

eslint.config.ts
1import { defineConfig } from "eslint/config"2import medusa from "@medusajs/eslint-plugin"3
4export default defineConfig([5  ...medusa.configs.recommended,6  {7    rules: {8      "@medusajs/primary-key-required": "off",9    },10  },11])

Or disable it for a single line using an inline comment:

Code
1// eslint-disable-next-line @medusajs/primary-key-required2export const Post = model.define("post", {