Back to Medusa

{metadata.title}

www/apps/resources/app/lint/rules/prices-in-major-units/page.mdx

2.17.01.6 KB
Original Source

export const metadata = { title: prices-in-major-units - ESLint plugin rules, }

{metadata.title}

This rule disallows price values that look like they're in the smallest currency unit, since Medusa stores prices in major units.

Severity

warn. This rule is enabled in the recommended preset.

What it Targets

This rule targets price-like properties, such as amount, unit_price, or total. It reports values that look like cents, such as a value multiplied by 100, an identifier named with a cents suffix, or a large integer literal.

The following code is reported by the rule:

ts
const item = { amount: price * 100 }

Instead, use the value in major units:

ts
const item = { amount: price }

Why it's Important

Medusa expects prices in major units, such as 19.99 rather than 1999. Passing a value in the smallest currency unit results in prices that are inflated by a factor of the currency's minor units.

Fixable

This rule isn't auto-fixable.

Turn it Off

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

ts
import { defineConfig } from "eslint/config"
import medusa from "@medusajs/eslint-plugin"

export default defineConfig([
  ...medusa.configs.recommended,
  {
    rules: {
      "@medusajs/prices-in-major-units": "off",
    },
  },
])

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

ts
// eslint-disable-next-line @medusajs/prices-in-major-units
const item = { amount: price * 100 }