@medusajs/eslint-plugin 2.15.5

package/README.md

@@ -0,0 +1,34 @@
+# @medusajs/eslint-plugin
+
+Official ESLint plugin for Medusa projects. Codifies Medusa's framework conventions into automatically-enforced static checks across API routes, modules, workflows, subscribers, scheduled jobs, admin extensions, and module links.
+
+> Status: pre-release. The plugin currently ships with no rules — only the package scaffold and `recommended` / `strict` config shapes. Rules will land incrementally; see `MEDUSA_LINT_RULES_CATALOG.md` at the repo root for the planned set.
+
+## Installation
+
+```bash
+npm install -D @medusajs/eslint-plugin eslint
+```
+
+`eslint` is a peer dependency — install it in the consuming project.
+
+## Usage (flat config)
+
+```js
+// eslint.config.js
+import medusa from "@medusajs/eslint-plugin"
+
+export default [...medusa.configs.recommended]
+```
+
+## Configs
+
+- `recommended` — default preset for Medusa projects.
+- `strict` — extends `recommended` and enables stricter, opt-in heuristics.
+
+## Development
+
+```bash
+yarn workspace @medusajs/eslint-plugin build
+yarn workspace @medusajs/eslint-plugin test
+```

package/dist/configs/recommended.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from "eslint";
+export declare function buildRecommended(plugin: unknown): Linter.Config[];
+//# sourceMappingURL=recommended.d.ts.map

package/dist/configs/recommended.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommended.d.ts","sourceRoot":"","sources":["../../src/configs/recommended.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAEpC,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,CAwBjE"}

package/dist/configs/recommended.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildRecommended = buildRecommended;
+function buildRecommended(plugin) {
+    return [
+        {
+            ignores: [
+                ".medusa/**",
+                ".yalc/**",
+                "dist/**",
+                "build/**",
+                "node_modules/**",
+                "coverage/**",
+                ".cache/**",
+                "**/*.generated.ts",
+            ],
+        },
+        {
+            files: ["**/*.{ts,tsx}"],
+            plugins: { "@medusajs": plugin },
+            languageOptions: {
+                parser: require("@typescript-eslint/parser"),
+                parserOptions: { project: true, sourceType: "module" },
+            },
+            rules: {},
+        },
+    ];
+}
+//# sourceMappingURL=recommended.js.map

package/dist/configs/recommended.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommended.js","sourceRoot":"","sources":["../../src/configs/recommended.ts"],"names":[],"mappings":";;AAEA,4CAwBC;AAxBD,SAAgB,gBAAgB,CAAC,MAAe;IAC9C,OAAO;QACL;YACE,OAAO,EAAE;gBACP,YAAY;gBACZ,UAAU;gBACV,SAAS;gBACT,UAAU;gBACV,iBAAiB;gBACjB,aAAa;gBACb,WAAW;gBACX,mBAAmB;aACpB;SACF;QACD;YACE,KAAK,EAAE,CAAC,eAAe,CAAC;YACxB,OAAO,EAAE,EAAE,WAAW,EAAE,MAAe,EAAE;YACzC,eAAe,EAAE;gBACf,MAAM,EAAE,OAAO,CAAC,2BAA2B,CAAC;gBAC5C,aAAa,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE;aACvD;YACD,KAAK,EAAE,EAAE;SACV;KACF,CAAA;AACH,CAAC"}

package/dist/configs/strict.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from "eslint";
+export declare function buildStrict(plugin: unknown): Linter.Config[];
+//# sourceMappingURL=strict.d.ts.map

package/dist/configs/strict.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"strict.d.ts","sourceRoot":"","sources":["../../src/configs/strict.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAGpC,wBAAgB,WAAW,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,CAE5D"}

package/dist/configs/strict.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildStrict = buildStrict;
+const recommended_1 = require("./recommended");
+function buildStrict(plugin) {
+    return [...(0, recommended_1.buildRecommended)(plugin)];
+}
+//# sourceMappingURL=strict.js.map

package/dist/configs/strict.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"strict.js","sourceRoot":"","sources":["../../src/configs/strict.ts"],"names":[],"mappings":";;AAGA,kCAEC;AAJD,+CAAgD;AAEhD,SAAgB,WAAW,CAAC,MAAe;IACzC,OAAO,CAAC,GAAG,IAAA,8BAAgB,EAAC,MAAM,CAAC,CAAC,CAAA;AACtC,CAAC"}

package/dist/create-rule.d.ts

@@ -0,0 +1,11 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+export interface MedusaRuleDocs {
+    description: string;
+    recommended?: boolean;
+    strict?: boolean;
+    requiresTypeChecking?: boolean;
+}
+export declare const createRule: <Options extends readonly unknown[], MessageIds extends string>({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, unknown>>) => ESLintUtils.RuleModule<MessageIds, Options, unknown, ESLintUtils.RuleListener> & {
+    name: string;
+};
+//# sourceMappingURL=create-rule.d.ts.map

package/dist/create-rule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-rule.d.ts","sourceRoot":"","sources":["../src/create-rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AAEtD,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,eAAO,MAAM,UAAU;;CAGtB,CAAA"}

package/dist/create-rule.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRule = void 0;
+const utils_1 = require("@typescript-eslint/utils");
+exports.createRule = utils_1.ESLintUtils.RuleCreator(
+// TODO: Update this to point to the actual documentation for each rule once it's published
+(name) => `https://docs.medusajs.com/resources/lint/rules/${name}`);
+//# sourceMappingURL=create-rule.js.map

package/dist/create-rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-rule.js","sourceRoot":"","sources":["../src/create-rule.ts"],"names":[],"mappings":";;;AAAA,oDAAsD;AASzC,QAAA,UAAU,GAAG,mBAAW,CAAC,WAAW;AAC/C,2FAA2F;AAC3F,CAAC,IAAI,EAAE,EAAE,CAAC,kDAAkD,IAAI,EAAE,CACnE,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import type { Linter } from "eslint";
+import { rules } from "./rules";
+declare const plugin: {
+    meta: {
+        name: string;
+    };
+    rules: Record<string, import("@eslint/core").RuleDefinition<import("@eslint/core").RuleDefinitionTypeOptions>>;
+    configs: {
+        recommended: Linter.Config[];
+        strict: Linter.Config[];
+    };
+};
+export default plugin;
+export declare const meta: {
+    name: string;
+}, configs: {
+    recommended: Linter.Config[];
+    strict: Linter.Config[];
+};
+export { rules };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAU,MAAM,EAAE,MAAM,QAAQ,CAAA;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAM/B,QAAA,MAAM,MAAM;;;;;aAGK;QACb,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,CAAA;QAC5B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAA;KACxB;CACsB,CAAA;AAKzB,eAAe,MAAM,CAAA;AACrB,eAAO,MAAQ,IAAI;;GAAE,OAAO;iBATX,MAAM,CAAC,MAAM,EAAE;YACpB,MAAM,CAAC,MAAM,EAAE;CAQY,CAAA;AACvC,OAAO,EAAE,KAAK,EAAE,CAAA"}

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rules = exports.configs = exports.meta = void 0;
+const rules_1 = require("./rules");
+Object.defineProperty(exports, "rules", { enumerable: true, get: function () { return rules_1.rules; } });
+const recommended_1 = require("./configs/recommended");
+const strict_1 = require("./configs/strict");
+const PLUGIN_NAME = "@medusajs/eslint-plugin";
+const plugin = {
+    meta: { name: PLUGIN_NAME },
+    rules: rules_1.rules,
+    configs: {},
+};
+plugin.configs.recommended = (0, recommended_1.buildRecommended)(plugin);
+plugin.configs.strict = (0, strict_1.buildStrict)(plugin);
+exports.default = plugin;
+exports.meta = plugin.meta, exports.configs = plugin.configs;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,mCAA+B;AAoBtB,sFApBA,aAAK,OAoBA;AAnBd,uDAAwD;AACxD,6CAA8C;AAE9C,MAAM,WAAW,GAAG,yBAAyB,CAAA;AAE7C,MAAM,MAAM,GAAG;IACb,IAAI,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE;IAC3B,KAAK,EAAL,aAAK;IACL,OAAO,EAAE,EAGR;CACsB,CAAA;AAEzB,MAAM,CAAC,OAAO,CAAC,WAAW,GAAG,IAAA,8BAAgB,EAAC,MAAM,CAAC,CAAA;AACrD,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,IAAA,oBAAW,EAAC,MAAM,CAAC,CAAA;AAE3C,kBAAe,MAAM,CAAA;AACN,YAAI,GAAc,MAAM,OAAlB,eAAO,GAAK,MAAM,SAAA"}

package/dist/rules/index.d.ts

@@ -0,0 +1,3 @@
+import type { ESLint } from "eslint";
+export declare const rules: NonNullable<ESLint.Plugin["rules"]>;
+//# sourceMappingURL=index.d.ts.map

package/dist/rules/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAEpC,eAAO,MAAM,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAM,CAAA"}

package/dist/rules/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rules = void 0;
+exports.rules = {};
+//# sourceMappingURL=index.js.map

package/dist/rules/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":";;;AAEa,QAAA,KAAK,GAAwC,EAAE,CAAA"}

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/create-rule.ts","../src/index.ts","../src/__tests__/plugin.spec.ts","../src/configs/recommended.ts","../src/configs/strict.ts","../src/rules/index.ts"],"version":"5.9.3"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@medusajs/eslint-plugin",
+  "version": "2.15.5",
+  "description": "Official ESLint plugin for Medusa projects. Enforces Medusa's framework conventions across API routes, modules, workflows, subscribers, jobs, admin extensions, and module links.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/medusajs/medusa",
+    "directory": "packages/eslint-plugin"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./configs/recommended": "./dist/configs/recommended.js",
+    "./configs/strict": "./dist/configs/strict.js"
+  },
+  "scripts": {
+    "build": "yarn run -T rimraf dist && yarn run -T tsc --build",
+    "watch": "yarn run -T tsc --build --watch",
+    "test": "../../node_modules/.bin/jest --silent=false --bail --forceExit --testPathPattern=src"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "!dist/**/__tests__",
+    "!dist/**/*.spec.*",
+    "!dist/**/*.test.*"
+  ],
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin",
+    "medusa",
+    "medusajs"
+  ],
+  "author": "Medusa",
+  "license": "MIT",
+  "peerDependencies": {
+    "eslint": "^9.0.0",
+    "typescript": ">=4.8.0"
+  },
+  "dependencies": {
+    "@typescript-eslint/parser": "^8.0.0",
+    "@typescript-eslint/utils": "^8.0.0"
+  },
+  "devDependencies": {
+    "@types/eslint": "^9.6.1",
+    "@typescript-eslint/rule-tester": "^8.0.0",
+    "eslint": "^9.0.0",
+    "typescript": "^5.4.0"
+  }
+}