@danilqa/eslint-plugin-ts-pattern 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daniil Sitdikov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,73 @@
+# @danilqa/eslint-plugin-ts-pattern
+
+An ESLint plugin that warns when you branch on a string-literal union type with `if`/`else`, and points you at [`ts-pattern`](https://github.com/gvergnaud/ts-pattern)'s exhaustive `match` instead.
+
+## Problem
+
+```ts
+type State = 'failed' | 'success' | 'pending'
+
+interface Payment {
+  state: State
+}
+
+function describe(payment: Payment) {
+  if (payment.state === 'failed') return 'a'
+  // …
+}
+```
+
+When `State` later grows a `'refunded'` variant, the compiler does not flag this `if`. The branch silently misses the new case — and so does every other `if` block scattered across the codebase.
+
+## Solution
+
+```ts
+import { match } from 'ts-pattern'
+
+function describe(payment: Payment) {
+  return match(payment.state)
+    .with('failed', () => 'a')
+    .with('success', () => 'b')
+    .with('pending', () => 'c')
+    .exhaustive()
+}
+```
+
+`.exhaustive()` makes a missing case a **compile-time error**. Adding `'refunded'` to `State` immediately fails the build everywhere it isn't handled.
+
+## Install
+
+```sh
+npm i --dev @danilqa/eslint-plugin-ts-pattern
+```
+
+```
+yarn add -D @danilqa/eslint-plugin-ts-pattern
+```
+
+```
+pnpm add -D @danilqa/eslint-plugin-ts-pattern
+```
+
+## Usage (flat config)
+
+```js
+import tsPattern from '@danilqa/eslint-plugin-ts-pattern'
+
+export default [
+  {
+    // ...
+    plugins: { 'ts-pattern': tsPattern },
+    rules: {
+      'ts-pattern/prefer-match-on-union': 'warn',
+    },
+    // ...
+  },
+]
+```
+
+## Rules
+
+| Rule                    | Description                                                              |
+| ----------------------- | ------------------------------------------------------------------------ |
+| `prefer-match-on-union` | Warn on `if (x === 'literal')` when `x` has a string-literal union type. |

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+declare const plugin: {
+    meta: {
+        name: string;
+        version: string;
+    };
+    rules: {
+        'prefer-match-on-union': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferMatch", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
+            name: string;
+        };
+    };
+};
+export default plugin;
+//# 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":"AAEA,QAAA,MAAM,MAAM;;;;;;;;;;CAMX,CAAA;AAED,eAAe,MAAM,CAAA"}

package/dist/index.js

@@ -0,0 +1,10 @@
+import { rules } from './rules/index.js';
+const plugin = {
+    meta: {
+        name: '@danilqa/eslint-plugin-ts-pattern',
+        version: '0.0.1',
+    },
+    rules,
+};
+export default plugin;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAE/B,MAAM,MAAM,GAAG;IACb,IAAI,EAAE;QACJ,IAAI,EAAE,mCAAmC;QACzC,OAAO,EAAE,OAAO;KACjB;IACD,KAAK;CACN,CAAA;AAED,eAAe,MAAM,CAAA"}

package/dist/rules/index.d.ts

@@ -0,0 +1,6 @@
+export declare const rules: {
+    'prefer-match-on-union': import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferMatch", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
+        name: string;
+    };
+};
+//# 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":"AAEA,eAAO,MAAM,KAAK;;;;CAEjB,CAAA"}

package/dist/rules/index.js

@@ -0,0 +1,5 @@
+import { preferMatchOnUnion } from './prefer-match-on-union.js';
+export const rules = {
+    'prefer-match-on-union': preferMatchOnUnion,
+};
+//# 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":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAE5D,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,uBAAuB,EAAE,kBAAkB;CAC5C,CAAA"}

package/dist/rules/prefer-match-on-union.d.ts

@@ -0,0 +1,5 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const preferMatchOnUnion: ESLintUtils.RuleModule<"preferMatch", [], unknown, ESLintUtils.RuleListener> & {
+    name: string;
+};
+//# sourceMappingURL=prefer-match-on-union.d.ts.map

package/dist/rules/prefer-match-on-union.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-match-on-union.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-match-on-union.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AA4BtD,eAAO,MAAM,kBAAkB;;CA2C7B,CAAA"}

package/dist/rules/prefer-match-on-union.js

@@ -0,0 +1,63 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+import { createRule } from '../utils/create-rule.js';
+function isStringLiteralUnion(type) {
+    if (!type.isUnion())
+        return false;
+    const constituents = type.types;
+    if (constituents.length < 2)
+        return false;
+    return constituents.every((t) => t.isStringLiteral());
+}
+function getNonLiteralOperand(node) {
+    const { left, right } = node;
+    if (left.type === 'PrivateIdentifier')
+        return null;
+    const leftIsStringLit = left.type === 'Literal' && typeof left.value === 'string';
+    const rightIsStringLit = right.type === 'Literal' && typeof right.value === 'string';
+    if (leftIsStringLit && !rightIsStringLit)
+        return right;
+    if (rightIsStringLit && !leftIsStringLit)
+        return left;
+    return null;
+}
+export const preferMatchOnUnion = createRule({
+    name: 'prefer-match-on-union',
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: "Warn when `if` or a ternary branches on a string-literal union type via `===`/`!==`. Prefer ts-pattern's `match(...).exhaustive()`.",
+        },
+        schema: [],
+        messages: {
+            preferMatch: 'Avoid `===`/`!==` checks on string-literal union types. Use `match(value).with(...).exhaustive()` from ts-pattern so missing cases are caught at compile time.',
+        },
+    },
+    defaultOptions: [],
+    create(context) {
+        const services = ESLintUtils.getParserServices(context);
+        const checker = services.program.getTypeChecker();
+        function check(test) {
+            if (test.type !== 'BinaryExpression')
+                return;
+            if (test.operator !== '===' && test.operator !== '!==')
+                return;
+            const target = getNonLiteralOperand(test);
+            if (!target)
+                return;
+            const tsNode = services.esTreeNodeToTSNodeMap.get(target);
+            const type = checker.getTypeAtLocation(tsNode);
+            if (!isStringLiteralUnion(type))
+                return;
+            context.report({ node: test, messageId: 'preferMatch' });
+        }
+        return {
+            IfStatement(node) {
+                check(node.test);
+            },
+            ConditionalExpression(node) {
+                check(node.test);
+            },
+        };
+    },
+});
+//# sourceMappingURL=prefer-match-on-union.js.map

package/dist/rules/prefer-match-on-union.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-match-on-union.js","sourceRoot":"","sources":["../../src/rules/prefer-match-on-union.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AAGtD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAIjD,SAAS,oBAAoB,CAAC,IAAa;IACzC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;QAAE,OAAO,KAAK,CAAA;IACjC,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAA;IAC/B,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,KAAK,CAAA;IACzC,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,EAAE,CAAC,CAAA;AACvD,CAAC;AAED,SAAS,oBAAoB,CAC3B,IAA+B;IAE/B,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAA;IAC5B,IAAI,IAAI,CAAC,IAAI,KAAK,mBAAmB;QAAE,OAAO,IAAI,CAAA;IAClD,MAAM,eAAe,GACnB,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAA;IAC3D,MAAM,gBAAgB,GACpB,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,CAAA;IAC7D,IAAI,eAAe,IAAI,CAAC,gBAAgB;QAAE,OAAO,KAAK,CAAA;IACtD,IAAI,gBAAgB,IAAI,CAAC,eAAe;QAAE,OAAO,IAAI,CAAA;IACrD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAiB;IAC3D,IAAI,EAAE,uBAAuB;IAC7B,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EACT,qIAAqI;SACxI;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,WAAW,EACT,gKAAgK;SACnK;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACZ,MAAM,QAAQ,GAAG,WAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAA;QACvD,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,CAAA;QAEjD,SAAS,KAAK,CAAC,IAAyB;YACtC,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB;gBAAE,OAAM;YAC5C,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK;gBAAE,OAAM;YAE9D,MAAM,MAAM,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAA;YACzC,IAAI,CAAC,MAAM;gBAAE,OAAM;YAEnB,MAAM,MAAM,GAAG,QAAQ,CAAC,qBAAqB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;YACzD,MAAM,IAAI,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAA;YAE9C,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC;gBAAE,OAAM;YAEvC,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAA;QAC1D,CAAC;QAED,OAAO;YACL,WAAW,CAAC,IAAI;gBACd,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAClB,CAAC;YACD,qBAAqB,CAAC,IAAI;gBACxB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAClB,CAAC;SACF,CAAA;IACH,CAAC;CACF,CAAC,CAAA"}

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

@@ -0,0 +1,5 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+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/utils/create-rule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-rule.d.ts","sourceRoot":"","sources":["../../src/utils/create-rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AAEtD,eAAO,MAAM,UAAU;;CAGtB,CAAA"}

package/dist/utils/create-rule.js

@@ -0,0 +1,3 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export const createRule = ESLintUtils.RuleCreator((name) => `https://github.com/danilqa/eslint-plugin-ts-pattern/blob/main/docs/rules/${name}.md`);
+//# sourceMappingURL=create-rule.js.map

package/dist/utils/create-rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-rule.js","sourceRoot":"","sources":["../../src/utils/create-rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AAEtD,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC,WAAW,CAC/C,CAAC,IAAI,EAAE,EAAE,CACP,4EAA4E,IAAI,KAAK,CACxF,CAAA"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@danilqa/eslint-plugin-ts-pattern",
+  "version": "0.0.1",
+  "description": "ESLint plugin: warn when `if` is used on string-literal union types instead of ts-pattern's exhaustive `match`",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json --resolve-full-paths",
+    "typecheck": "tsc --noEmit",
+    "test": "node --import tsx --test 'tests/**/*.test.ts'",
+    "test:watch": "node --import tsx --test --watch 'tests/**/*.test.ts'",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "check": "pnpm format:check && pnpm lint && pnpm typecheck && pnpm test",
+    "prepare": "husky",
+    "prepublishOnly": "pnpm check && pnpm build"
+  },
+  "peerDependencies": {
+    "eslint": ">=9",
+    "typescript": ">=5"
+  },
+  "devDependencies": {
+    "@types/node": "25.6.2",
+    "@typescript-eslint/parser": "8.59.2",
+    "@typescript-eslint/rule-tester": "8.59.2",
+    "@typescript-eslint/utils": "8.59.2",
+    "eslint": "10.3.0",
+    "eslint-config-prettier": "10.1.8",
+    "husky": "9.1.7",
+    "prettier": "3.8.3",
+    "tsc-alias": "1.8.17",
+    "tsx": "4.21.0",
+    "typescript": "6.0.3",
+    "typescript-eslint": "8.59.2"
+  },
+  "packageManager": "pnpm@11.0.9"
+}