data-model-table-name-snake-case - ESLint plugin rules

This rule requires that the name passed to model.define(name, ...) is snake_case.

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 the name passed to model.define(name, ...) when it isn't snake_case (lowercase letters, digits, and underscores, starting with a letter).

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("blogPost", {4  id: model.id().primaryKey(),5})

Instead, use a snake_case name:

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

Why it's Important#

The data model name is used to derive the database table name. A consistent snake_case name keeps table names predictable and aligned with Medusa's database conventions.

Learn more in the Data Models documentation.

Fixable#

This rule is auto-fixable. Run the linter with the --fix option to apply the fix automatically.

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/data-model-table-name-snake-case": "off",9    },10  },11])

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

Code
1// eslint-disable-next-line @medusajs/data-model-table-name-snake-case2export const Post = model.define("blogPost", {})