eslint-plugin-zod-mini 1.0.2 → 1.1.0

package/README.md

@@ -17,7 +17,7 @@
 [issuesBadge]: https://img.shields.io/github/issues/marcalexiei/eslint-zod.svg?style=for-the-badge
 [issuesURL]: https://github.com/marcalexiei/eslint-zod/issues
 
-[ESLint](https://eslint.org) plugin that adds custom linting rules to enforce best practices when using [Zod Mini](https://zod.dev/?id=zod-mini) (`zod/mini`).
+[ESLint](https://eslint.org) plugin that adds custom linting rules to enforce best practices when using [Zod Mini](https://zod.dev/packages/mini) (`zod/mini`).
 
 It can also work with [Oxlint](https://oxc.rs/docs/guide/usage/linter.html)!\
 Find out more about [Oxlint's `jsPLugins`](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).
@@ -41,6 +41,7 @@ Find out more about [Oxlint's `jsPLugins`](https://oxc.rs/docs/guide/usage/linte
 | [no-any-schema](docs/rules/no-any-schema.md)                                             | Disallow usage of `z.any()` in Zod Mini schemas                                                    | ✅  |     | 💡  |
 | [no-empty-custom-schema](docs/rules/no-empty-custom-schema.md)                           | Disallow usage of `z.custom()` without arguments                                                   | ✅  |     |     |
 | [no-unknown-schema](docs/rules/no-unknown-schema.md)                                     | Disallow usage of `z.unknown()` in Zod Mini schemas                                                |     |     |     |
+| [prefer-enum-over-literal-union](docs/rules/prefer-enum-over-literal-union.md)           | Prefer `z.enum()` over `z.union()` when all members are string literals.                           | ✅  | 🔧  |     |
 | [prefer-meta](docs/rules/prefer-meta.md)                                                 | Enforce usage of `z.meta()` over `z.describe()`                                                    | ✅  | 🔧  |     |
 | [require-brand-type-parameter](docs/rules/require-brand-type-parameter.md)               | Require type parameter on `.brand()` functions                                                     | ✅  |     | 💡  |
 | [require-error-message](docs/rules/require-error-message.md)                             | Enforce that custom refinements include an error message                                           | ✅  | 🔧  |     |
@@ -88,10 +89,7 @@ import { defineConfig } from 'eslint/config';
 import eslint from '@eslint/js';
 import eslintPluginZodMini from 'eslint-plugin-zod-mini';
 
-export default defineConfig(
-  eslint.configs.recommended,
-  eslintPluginZodMini.configs.recommended,
-);
+export default defineConfig(eslint.configs.recommended, eslintPluginZodMini.configs.recommended);
 ```
 
 ### Oxlint

package/dist/index.cjs

@@ -7,6 +7,7 @@ const require_consistent_schema_var_name = require("./rules/consistent-schema-va
 const require_no_any_schema = require("./rules/no-any-schema.cjs");
 const require_no_empty_custom_schema = require("./rules/no-empty-custom-schema.cjs");
 const require_no_unknown_schema = require("./rules/no-unknown-schema.cjs");
+const require_prefer_enum_over_literal_union = require("./rules/prefer-enum-over-literal-union.cjs");
 const require_prefer_meta = require("./rules/prefer-meta.cjs");
 const require_require_brand_type_parameter = require("./rules/require-brand-type-parameter.cjs");
 const require_require_error_message = require("./rules/require-error-message.cjs");
@@ -26,6 +27,7 @@ const eslintPluginZodMini = {
 		"no-any-schema": require_no_any_schema.noAnySchema,
 		"no-empty-custom-schema": require_no_empty_custom_schema.noEmptyCustomSchema,
 		"no-unknown-schema": require_no_unknown_schema.noUnknownSchema,
+		"prefer-enum-over-literal-union": require_prefer_enum_over_literal_union.preferEnumOverLiteralUnion,
 		"prefer-meta": require_prefer_meta.preferMeta,
 		"require-brand-type-parameter": require_require_brand_type_parameter.requireBrandTypeParameter,
 		"require-error-message": require_require_error_message.requireErrorMessage,
@@ -41,6 +43,7 @@ const recommendedConfig = {
 		"zod-mini/consistent-schema-var-name": "error",
 		"zod-mini/no-any-schema": "error",
 		"zod-mini/no-empty-custom-schema": "error",
+		"zod-mini/prefer-enum-over-literal-union": "error",
 		"zod-mini/prefer-meta": "error",
 		"zod-mini/require-brand-type-parameter": "error",
 		"zod-mini/require-error-message": "error"

package/dist/index.mjs

@@ -7,6 +7,7 @@ import { consistentSchemaVarName } from "./rules/consistent-schema-var-name.mjs"
 import { noAnySchema } from "./rules/no-any-schema.mjs";
 import { noEmptyCustomSchema } from "./rules/no-empty-custom-schema.mjs";
 import { noUnknownSchema } from "./rules/no-unknown-schema.mjs";
+import { preferEnumOverLiteralUnion } from "./rules/prefer-enum-over-literal-union.mjs";
 import { preferMeta } from "./rules/prefer-meta.mjs";
 import { requireBrandTypeParameter } from "./rules/require-brand-type-parameter.mjs";
 import { requireErrorMessage } from "./rules/require-error-message.mjs";
@@ -26,6 +27,7 @@ const eslintPluginZodMini = {
 		"no-any-schema": noAnySchema,
 		"no-empty-custom-schema": noEmptyCustomSchema,
 		"no-unknown-schema": noUnknownSchema,
+		"prefer-enum-over-literal-union": preferEnumOverLiteralUnion,
 		"prefer-meta": preferMeta,
 		"require-brand-type-parameter": requireBrandTypeParameter,
 		"require-error-message": requireErrorMessage,
@@ -41,6 +43,7 @@ const recommendedConfig = {
 		"zod-mini/consistent-schema-var-name": "error",
 		"zod-mini/no-any-schema": "error",
 		"zod-mini/no-empty-custom-schema": "error",
+		"zod-mini/prefer-enum-over-literal-union": "error",
 		"zod-mini/prefer-meta": "error",
 		"zod-mini/require-brand-type-parameter": "error",
 		"zod-mini/require-error-message": "error"

package/dist/rules/prefer-enum-over-literal-union.cjs

@@ -0,0 +1,18 @@
+require("../_virtual/_rolldown/runtime.cjs");
+const require_create_plugin_rule = require("../utils/create-plugin-rule.cjs");
+let _eslint_zod_utils = require("@eslint-zod/utils");
+//#region src/rules/prefer-enum-over-literal-union.ts
+const preferEnumOverLiteralUnion = require_create_plugin_rule.createZodMiniPluginRule({
+	name: "prefer-enum-over-literal-union",
+	meta: {
+		type: "suggestion",
+		fixable: "code",
+		docs: { description: "Prefer `z.enum()` over `z.union()` when all members are string literals." },
+		messages: { useEnum: "Replace this union of string literals with `z.enum()`." },
+		schema: []
+	},
+	defaultOptions: [],
+	create: (0, _eslint_zod_utils.buildPreferEnumOverLiteralUnionCreate)(_eslint_zod_utils.zodMiniImportScope)
+});
+//#endregion
+exports.preferEnumOverLiteralUnion = preferEnumOverLiteralUnion;

package/dist/rules/prefer-enum-over-literal-union.mjs

@@ -0,0 +1,17 @@
+import { createZodMiniPluginRule } from "../utils/create-plugin-rule.mjs";
+import { buildPreferEnumOverLiteralUnionCreate, zodMiniImportScope } from "@eslint-zod/utils";
+//#region src/rules/prefer-enum-over-literal-union.ts
+const preferEnumOverLiteralUnion = createZodMiniPluginRule({
+	name: "prefer-enum-over-literal-union",
+	meta: {
+		type: "suggestion",
+		fixable: "code",
+		docs: { description: "Prefer `z.enum()` over `z.union()` when all members are string literals." },
+		messages: { useEnum: "Replace this union of string literals with `z.enum()`." },
+		schema: []
+	},
+	defaultOptions: [],
+	create: buildPreferEnumOverLiteralUnionCreate(zodMiniImportScope)
+});
+//#endregion
+export { preferEnumOverLiteralUnion };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-zod-mini",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "ESLint plugin that adds custom linting rules to enforce best practices when using Zod Mini",
   "keywords": [
     "eslint",
@@ -40,17 +40,17 @@
   "dependencies": {
     "@typescript-eslint/utils": "^8.57.0",
     "esquery": "^1.6.0",
-    "@eslint-zod/utils": "1.1.0"
+    "@eslint-zod/utils": "1.3.0"
   },
   "devDependencies": {
-    "@marcalexiei/prettier-config": "1.1.4",
+    "@marcalexiei/prettier-config": "2.0.0",
     "@types/esquery": "1.5.4",
-    "@typescript-eslint/rule-tester": "8.59.2",
+    "@typescript-eslint/rule-tester": "8.59.3",
     "dedent": "1.7.2",
     "eslint-doc-generator": "3.3.2",
     "prettier": "3.8.3",
-    "tsdown": "0.21.10",
-    "vitest": "4.1.5"
+    "tsdown": "0.22.0",
+    "vitest": "4.1.6"
   },
   "peerDependencies": {
     "eslint": "^9 || ^10",