eslint-plugin-zod 1.3.0 → 1.4.0

package/README.md

@@ -12,6 +12,7 @@
     * [Installation](#user-content-eslint-plugin-zod-installation)
     * [Configuration](#user-content-eslint-plugin-zod-configuration)
     * [Rules](#user-content-eslint-plugin-zod-rules)
+        * [`prefer-enum`](#user-content-eslint-plugin-zod-rules-prefer-enum)
         * [`require-strict`](#user-content-eslint-plugin-zod-rules-require-strict)
 
 
@@ -44,9 +45,8 @@ npm install eslint-plugin-zod --save-dev
     "zod"
   ],
   "rules": {
-    "zod/require-strict": [
-      2,
-    ],
+    "zod/prefer-enum": 2,
+    "zod/require-strict": 2
   }
 }
 
@@ -58,6 +58,16 @@ npm install eslint-plugin-zod --save-dev
 
 <!-- Rules are sorted alphabetically. -->
 
+<a name="user-content-eslint-plugin-zod-rules-prefer-enum"></a>
+<a name="eslint-plugin-zod-rules-prefer-enum"></a>
+### <code>prefer-enum</code>
+
+_The `--fix` option on the command line automatically fixes problems reported by this rule._
+
+Prefers `z.enum` over a union of literals.
+
+
+
 <a name="user-content-eslint-plugin-zod-rules-require-strict"></a>
 <a name="eslint-plugin-zod-rules-require-strict"></a>
 ### <code>require-strict</code>

package/dist/src/index.d.ts

@@ -1,5 +1,23 @@
 declare const _default: {
     rules: {
+        'prefer-enum': {
+            create: (context: any) => {
+                CallExpression(node: any): void;
+            };
+            meta: {
+                docs: {
+                    description: string;
+                    url: string;
+                };
+                fixable: string;
+                schema: {
+                    additionalProperties: boolean;
+                    properties: {};
+                    type: string;
+                }[];
+                type: string;
+            };
+        };
         'require-strict': {
             create: (context: any) => {
                 CallExpression(node: any): void;
@@ -25,6 +43,7 @@ declare const _default: {
         };
     };
     rulesConfig: {
+        'prefer-enum': number;
         'require-strict': number;
     };
 };

package/dist/src/index.js

@@ -2,13 +2,16 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+const preferEnum_1 = __importDefault(require("./rules/preferEnum"));
 const requireStrict_1 = __importDefault(require("./rules/requireStrict"));
 const rules = {
+    'prefer-enum': preferEnum_1.default,
     'require-strict': requireStrict_1.default,
 };
 module.exports = {
     rules,
     rulesConfig: {
+        'prefer-enum': 0,
         'require-strict': 0,
     },
 };

package/dist/src/rules/preferEnum.d.ts

@@ -0,0 +1,19 @@
+declare const _default: {
+    create: (context: any) => {
+        CallExpression(node: any): void;
+    };
+    meta: {
+        docs: {
+            description: string;
+            url: string;
+        };
+        fixable: string;
+        schema: {
+            additionalProperties: boolean;
+            properties: {};
+            type: string;
+        }[];
+        type: string;
+    };
+};
+export = _default;

package/dist/src/rules/preferEnum.js

@@ -0,0 +1,43 @@
+"use strict";
+const create = (context) => {
+    return {
+        CallExpression(node) {
+            var _a;
+            if (((_a = node.callee.object) === null || _a === void 0 ? void 0 : _a.name) !== 'z') {
+                return;
+            }
+            if (node.callee.property.name !== 'union') {
+                return;
+            }
+            const members = node.arguments[0].elements;
+            const allMembersAreLiterals = members.every((member) => {
+                return member.type === 'CallExpression' && member.callee.object.name === 'z' && member.callee.property.name === 'literal';
+            });
+            if (!allMembersAreLiterals) {
+                return;
+            }
+            context.report({
+                message: 'Use z.enum().',
+                node,
+            });
+        },
+    };
+};
+module.exports = {
+    create,
+    meta: {
+        docs: {
+            description: 'Prefers `z.enum` over a union of literals.',
+            url: 'https://github.com/gajus/eslint-plugin-zod#eslint-plugin-zod-rules-prefer-enum',
+        },
+        fixable: 'code',
+        schema: [
+            {
+                additionalProperties: false,
+                properties: {},
+                type: 'object',
+            },
+        ],
+        type: 'problem',
+    },
+};

package/package.json

@@ -46,5 +46,5 @@
     "lint": "eslint ./src ./test && tsc --noEmit",
     "test": "mocha --require tsx test/**/*"
   },
-  "version": "1.3.0"
+  "version": "1.4.0"
 }