eslint-plugin-zod 4.0.0 → 4.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. package/README.md +33 -31
  2. package/dist/_virtual/_rolldown/runtime.cjs +23 -0
  3. package/dist/index.cjs +105 -0
  4. package/dist/index.d.cts +22 -0
  5. package/dist/index.d.mts +23 -0
  6. package/dist/index.mjs +105 -0
  7. package/dist/meta.cjs +11 -0
  8. package/dist/meta.mjs +8 -0
  9. package/dist/rules/array-style.cjs +87 -0
  10. package/dist/rules/array-style.mjs +86 -0
  11. package/dist/rules/consistent-import-source.cjs +58 -0
  12. package/dist/rules/consistent-import-source.mjs +57 -0
  13. package/dist/rules/consistent-import.cjs +107 -0
  14. package/dist/rules/consistent-import.mjs +106 -0
  15. package/dist/rules/consistent-object-schema-type.cjs +79 -0
  16. package/dist/rules/consistent-object-schema-type.mjs +78 -0
  17. package/dist/rules/consistent-schema-output-type-style.cjs +67 -0
  18. package/dist/rules/consistent-schema-output-type-style.mjs +66 -0
  19. package/dist/rules/consistent-schema-var-name.cjs +54 -0
  20. package/dist/rules/consistent-schema-var-name.mjs +53 -0
  21. package/dist/rules/no-any-schema.cjs +60 -0
  22. package/dist/rules/no-any-schema.mjs +59 -0
  23. package/dist/rules/no-empty-custom-schema.cjs +34 -0
  24. package/dist/rules/no-empty-custom-schema.mjs +33 -0
  25. package/dist/rules/no-number-schema-with-finite.cjs +41 -0
  26. package/dist/rules/no-number-schema-with-finite.mjs +40 -0
  27. package/dist/rules/no-number-schema-with-int.cjs +54 -0
  28. package/dist/rules/no-number-schema-with-int.mjs +53 -0
  29. package/dist/rules/no-number-schema-with-is-finite.cjs +35 -0
  30. package/dist/rules/no-number-schema-with-is-finite.mjs +34 -0
  31. package/dist/rules/no-number-schema-with-is-int.cjs +35 -0
  32. package/dist/rules/no-number-schema-with-is-int.mjs +34 -0
  33. package/dist/rules/no-number-schema-with-safe.cjs +54 -0
  34. package/dist/rules/no-number-schema-with-safe.mjs +53 -0
  35. package/dist/rules/no-number-schema-with-step.cjs +40 -0
  36. package/dist/rules/no-number-schema-with-step.mjs +39 -0
  37. package/dist/rules/no-optional-and-default-together.cjs +69 -0
  38. package/dist/rules/no-optional-and-default-together.mjs +68 -0
  39. package/dist/rules/no-string-schema-with-uuid.cjs +58 -0
  40. package/dist/rules/no-string-schema-with-uuid.mjs +57 -0
  41. package/dist/rules/no-throw-in-refine.cjs +67 -0
  42. package/dist/rules/no-throw-in-refine.mjs +66 -0
  43. package/dist/rules/no-transform-in-record-key.cjs +51 -0
  44. package/dist/rules/no-transform-in-record-key.mjs +50 -0
  45. package/dist/rules/no-unknown-schema.cjs +29 -0
  46. package/dist/rules/no-unknown-schema.mjs +28 -0
  47. package/dist/rules/prefer-enum-over-literal-union.cjs +61 -0
  48. package/dist/rules/prefer-enum-over-literal-union.mjs +60 -0
  49. package/dist/rules/prefer-meta-last.cjs +47 -0
  50. package/dist/rules/prefer-meta-last.mjs +46 -0
  51. package/dist/rules/prefer-meta.cjs +38 -0
  52. package/dist/rules/prefer-meta.mjs +37 -0
  53. package/dist/rules/prefer-string-schema-with-trim.cjs +49 -0
  54. package/dist/rules/prefer-string-schema-with-trim.mjs +48 -0
  55. package/dist/rules/prefer-top-level-string-formats.cjs +193 -0
  56. package/dist/rules/prefer-top-level-string-formats.mjs +192 -0
  57. package/dist/rules/prefer-trim-before-string-length-checks.cjs +60 -0
  58. package/dist/rules/prefer-trim-before-string-length-checks.mjs +59 -0
  59. package/dist/rules/require-brand-type-parameter.cjs +47 -0
  60. package/dist/rules/require-brand-type-parameter.mjs +46 -0
  61. package/dist/rules/require-error-message.cjs +82 -0
  62. package/dist/rules/require-error-message.mjs +81 -0
  63. package/dist/rules/schema-error-property-style.cjs +93 -0
  64. package/dist/rules/schema-error-property-style.mjs +91 -0
  65. package/dist/utils/create-plugin-rule.cjs +6 -0
  66. package/dist/utils/create-plugin-rule.mjs +6 -0
  67. package/package.json +2 -2
package/README.md CHANGED
@@ -29,37 +29,39 @@ Find out more about [Oxlint's `jsPLugins`](https://oxc.rs/docs/guide/usage/linte
29
29
  💼 Configurations enabled in.\
30
30
  ✅ Set in the `recommended` configuration.\
31
31
  🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
32
- 💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
33
-
34
- | Name                                    | Description | 💼 | 🔧 | 💡 |
35
- | :----------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------- | :-- | :-- | :-- |
36
- | [array-style](docs/rules/array-style.md) | Enforce consistent Zod array style | | 🔧 | |
37
- | [consistent-import](docs/rules/consistent-import.md) | Enforce a consistent import style for Zod | ✅ | 🔧 | |
38
- | [consistent-import-source](docs/rules/consistent-import-source.md) | Enforce consistent source from Zod imports | | | 💡 |
39
- | [consistent-object-schema-type](docs/rules/consistent-object-schema-type.md) | Enforce consistent usage of Zod schema methods | | | 💡 |
40
- | [consistent-schema-output-type-style](docs/rules/consistent-schema-output-type-style.md) | Enforce consistent use of z.infer or z.output for schema type inference | | 🔧 | |
41
- | [consistent-schema-var-name](docs/rules/consistent-schema-var-name.md) | Enforce a consistent naming convention for Zod schema variables | | | |
42
- | [no-any-schema](docs/rules/no-any-schema.md) | Disallow usage of `z.any()` in Zod schemas | ✅ | | 💡 |
43
- | [no-empty-custom-schema](docs/rules/no-empty-custom-schema.md) | Disallow usage of `z.custom()` without arguments | ✅ | | |
44
- | [no-number-schema-with-finite](docs/rules/no-number-schema-with-finite.md) | Disallow deprecated `z.number().finite()`. In Zod 4+ number schemas do not allow infinite values by default, so it is a no-op. | ✅ | 🔧 | |
45
- | [no-number-schema-with-int](docs/rules/no-number-schema-with-int.md) | Disallow usage of `z.number().int()` as it is considered legacy | ✅ | 🔧 | |
46
- | [no-number-schema-with-is-finite](docs/rules/no-number-schema-with-is-finite.md) | Disallow using deprecated `isFinite` on a Zod number schema; in v4+ it is always `true`. | ✅ | | |
47
- | [no-number-schema-with-is-int](docs/rules/no-number-schema-with-is-int.md) | Disallow using deprecated `isInt` on a Zod number schema; check the `format` property instead. | ✅ | | |
48
- | [no-number-schema-with-safe](docs/rules/no-number-schema-with-safe.md) | Disallow deprecated `z.number().safe()`. Use `z.int()`; `.safe()` is now identical to `.int()`. | ✅ | 🔧 | |
49
- | [no-number-schema-with-step](docs/rules/no-number-schema-with-step.md) | Disallow deprecated `z.number().step()`. Use `.multipleOf()` instead. | ✅ | 🔧 | |
50
- | [no-optional-and-default-together](docs/rules/no-optional-and-default-together.md) | Disallow using both `.optional()` and `.default()` on the same Zod schema | ✅ | 🔧 | |
51
- | [no-string-schema-with-uuid](docs/rules/no-string-schema-with-uuid.md) | Disallow usage of `z.string().uuid()` in favor of the dedicated `z.uuid()` schema | ✅ | 🔧 | |
52
- | [no-throw-in-refine](docs/rules/no-throw-in-refine.md) | Disallow throwing errors directly inside Zod refine callbacks | ✅ | | |
53
- | [no-transform-in-record-key](docs/rules/no-transform-in-record-key.md) | Disallow transforms in z.record() key schemas, which can cause silent key mutations and data loss through key collisions | | | |
54
- | [no-unknown-schema](docs/rules/no-unknown-schema.md) | Disallow usage of `z.unknown()` in Zod schemas | | | |
55
- | [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. || 🔧 | |
56
- | [prefer-meta](docs/rules/prefer-meta.md) | Enforce usage of `.meta()` over `.describe()` | ✅ | 🔧 | |
57
- | [prefer-meta-last](docs/rules/prefer-meta-last.md) | Enforce `.meta()` as last method | ✅ | 🔧 | |
58
- | [prefer-string-schema-with-trim](docs/rules/prefer-string-schema-with-trim.md) | Enforce `z.string().trim()` to prevent accidental leading/trailing whitespace | ✅ | 🔧 | |
59
- | [prefer-trim-before-string-length-checks](docs/rules/prefer-trim-before-string-length-checks.md) | Enforce `.trim()` is called before string length checks to ensure accurate validation | ✅ | 🔧 | |
60
- | [require-brand-type-parameter](docs/rules/require-brand-type-parameter.md) | Require type parameter on `.brand()` functions | ✅ | | 💡 |
61
- | [require-error-message](docs/rules/require-error-message.md) | Enforce that custom refinements include an error message | ✅ | 🔧 | |
62
- | [schema-error-property-style](docs/rules/schema-error-property-style.md) | Enforce consistent style for error messages in Zod schema validation (using ESQuery patterns) | | | |
32
+ 💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).\
33
+ ❌ Deprecated.
34
+
35
+ | Name                                    | Description | 💼 | 🔧 | 💡 | |
36
+ | :----------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------- | :-- | :-- | :-- | :-- |
37
+ | [array-style](docs/rules/array-style.md) | Enforce consistent Zod array style | ✅ | 🔧 | | |
38
+ | [consistent-import](docs/rules/consistent-import.md) | Enforce a consistent import style for Zod | | 🔧 | | |
39
+ | [consistent-import-source](docs/rules/consistent-import-source.md) | Enforce consistent source from Zod imports | | | 💡 | |
40
+ | [consistent-object-schema-type](docs/rules/consistent-object-schema-type.md) | Enforce consistent usage of Zod schema methods | | | 💡 | |
41
+ | [consistent-schema-output-type-style](docs/rules/consistent-schema-output-type-style.md) | Enforce consistent use of z.infer or z.output for schema type inference | | 🔧 | | |
42
+ | [consistent-schema-var-name](docs/rules/consistent-schema-var-name.md) | Enforce a consistent naming convention for Zod schema variables | ✅ | | | |
43
+ | [no-any-schema](docs/rules/no-any-schema.md) | Disallow usage of `z.any()` in Zod schemas | ✅ | | 💡 | |
44
+ | [no-empty-custom-schema](docs/rules/no-empty-custom-schema.md) | Disallow usage of `z.custom()` without arguments | ✅ | | | |
45
+ | [no-number-schema-with-finite](docs/rules/no-number-schema-with-finite.md) | Disallow deprecated `z.number().finite()`. In Zod 4+ number schemas do not allow infinite values by default, so it is a no-op. | ✅ | 🔧 | | |
46
+ | [no-number-schema-with-int](docs/rules/no-number-schema-with-int.md) | Disallow usage of `z.number().int()` as it is considered legacy | ✅ | 🔧 | | |
47
+ | [no-number-schema-with-is-finite](docs/rules/no-number-schema-with-is-finite.md) | Disallow using deprecated `isFinite` on a Zod number schema; in v4+ it is always `true`. | ✅ | | | |
48
+ | [no-number-schema-with-is-int](docs/rules/no-number-schema-with-is-int.md) | Disallow using deprecated `isInt` on a Zod number schema; check the `format` property instead. | ✅ | | | |
49
+ | [no-number-schema-with-safe](docs/rules/no-number-schema-with-safe.md) | Disallow deprecated `z.number().safe()`. Use `z.int()`; `.safe()` is now identical to `.int()`. | ✅ | 🔧 | | |
50
+ | [no-number-schema-with-step](docs/rules/no-number-schema-with-step.md) | Disallow deprecated `z.number().step()`. Use `.multipleOf()` instead. | ✅ | 🔧 | | |
51
+ | [no-optional-and-default-together](docs/rules/no-optional-and-default-together.md) | Disallow using both `.optional()` and `.default()` on the same Zod schema | ✅ | 🔧 | | |
52
+ | [no-string-schema-with-uuid](docs/rules/no-string-schema-with-uuid.md) | Disallow usage of `z.string().uuid()` in favor of the dedicated `z.uuid()` schema | ✅ | 🔧 | | ❌ |
53
+ | [no-throw-in-refine](docs/rules/no-throw-in-refine.md) | Disallow throwing errors directly inside Zod refine callbacks | | | | |
54
+ | [no-transform-in-record-key](docs/rules/no-transform-in-record-key.md) | Disallow transforms in z.record() key schemas, which can cause silent key mutations and data loss through key collisions | | | | |
55
+ | [no-unknown-schema](docs/rules/no-unknown-schema.md) | Disallow usage of `z.unknown()` in Zod schemas | | | | |
56
+ | [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. | ✅ | 🔧 | | |
57
+ | [prefer-meta](docs/rules/prefer-meta.md) | Enforce usage of `.meta()` over `.describe()` | ✅ | 🔧 | | |
58
+ | [prefer-meta-last](docs/rules/prefer-meta-last.md) | Enforce `.meta()` as last method | ✅ | 🔧 | | |
59
+ | [prefer-string-schema-with-trim](docs/rules/prefer-string-schema-with-trim.md) | Enforce `z.string().trim()` to prevent accidental leading/trailing whitespace | ✅ | 🔧 | | |
60
+ | [prefer-top-level-string-formats](docs/rules/prefer-top-level-string-formats.md) | Prefer top-level string format schemas over deprecated `z.string().<format>()` methods | ✅ | 🔧 | | |
61
+ | [prefer-trim-before-string-length-checks](docs/rules/prefer-trim-before-string-length-checks.md) | Enforce `.trim()` is called before string length checks to ensure accurate validation | ✅ | 🔧 | | |
62
+ | [require-brand-type-parameter](docs/rules/require-brand-type-parameter.md) | Require type parameter on `.brand()` functions | | | 💡 | |
63
+ | [require-error-message](docs/rules/require-error-message.md) | Enforce that custom refinements include an error message | ✅ | 🔧 | | |
64
+ | [schema-error-property-style](docs/rules/schema-error-property-style.md) | Enforce consistent style for error messages in Zod schema validation (using ESQuery patterns) | | | | |
63
65
 
64
66
  <!-- end auto-generated rules list -->
65
67
 
@@ -0,0 +1,23 @@
1
+ //#region \0rolldown/runtime.js
2
+ var __create = Object.create;
3
+ var __defProp = Object.defineProperty;
4
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
+ var __getOwnPropNames = Object.getOwnPropertyNames;
6
+ var __getProtoOf = Object.getPrototypeOf;
7
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
8
+ var __copyProps = (to, from, except, desc) => {
9
+ if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
10
+ key = keys[i];
11
+ if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
12
+ get: ((k) => from[k]).bind(null, key),
13
+ enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
14
+ });
15
+ }
16
+ return to;
17
+ };
18
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
19
+ value: mod,
20
+ enumerable: true
21
+ }) : target, mod));
22
+ //#endregion
23
+ exports.__toESM = __toESM;
package/dist/index.cjs ADDED
@@ -0,0 +1,105 @@
1
+ const require_meta = require("./meta.cjs");
2
+ const require_array_style = require("./rules/array-style.cjs");
3
+ const require_consistent_import_source = require("./rules/consistent-import-source.cjs");
4
+ const require_consistent_import = require("./rules/consistent-import.cjs");
5
+ const require_consistent_object_schema_type = require("./rules/consistent-object-schema-type.cjs");
6
+ const require_consistent_schema_output_type_style = require("./rules/consistent-schema-output-type-style.cjs");
7
+ const require_consistent_schema_var_name = require("./rules/consistent-schema-var-name.cjs");
8
+ const require_no_any_schema = require("./rules/no-any-schema.cjs");
9
+ const require_no_empty_custom_schema = require("./rules/no-empty-custom-schema.cjs");
10
+ const require_no_number_schema_with_finite = require("./rules/no-number-schema-with-finite.cjs");
11
+ const require_no_number_schema_with_int = require("./rules/no-number-schema-with-int.cjs");
12
+ const require_no_number_schema_with_is_finite = require("./rules/no-number-schema-with-is-finite.cjs");
13
+ const require_no_number_schema_with_is_int = require("./rules/no-number-schema-with-is-int.cjs");
14
+ const require_no_number_schema_with_safe = require("./rules/no-number-schema-with-safe.cjs");
15
+ const require_no_number_schema_with_step = require("./rules/no-number-schema-with-step.cjs");
16
+ const require_no_optional_and_default_together = require("./rules/no-optional-and-default-together.cjs");
17
+ const require_no_string_schema_with_uuid = require("./rules/no-string-schema-with-uuid.cjs");
18
+ const require_no_throw_in_refine = require("./rules/no-throw-in-refine.cjs");
19
+ const require_no_transform_in_record_key = require("./rules/no-transform-in-record-key.cjs");
20
+ const require_no_unknown_schema = require("./rules/no-unknown-schema.cjs");
21
+ const require_prefer_enum_over_literal_union = require("./rules/prefer-enum-over-literal-union.cjs");
22
+ const require_prefer_meta_last = require("./rules/prefer-meta-last.cjs");
23
+ const require_prefer_meta = require("./rules/prefer-meta.cjs");
24
+ const require_prefer_string_schema_with_trim = require("./rules/prefer-string-schema-with-trim.cjs");
25
+ const require_prefer_top_level_string_formats = require("./rules/prefer-top-level-string-formats.cjs");
26
+ const require_prefer_trim_before_string_length_checks = require("./rules/prefer-trim-before-string-length-checks.cjs");
27
+ const require_require_brand_type_parameter = require("./rules/require-brand-type-parameter.cjs");
28
+ const require_require_error_message = require("./rules/require-error-message.cjs");
29
+ const require_schema_error_property_style = require("./rules/schema-error-property-style.cjs");
30
+ //#region src/index.ts
31
+ const eslintPluginZod = {
32
+ meta: {
33
+ name: require_meta.PLUGIN_NAME,
34
+ version: require_meta.PLUGIN_VERSION
35
+ },
36
+ rules: {
37
+ "array-style": require_array_style.arrayStyle,
38
+ "consistent-import-source": require_consistent_import_source.consistentImportSource,
39
+ "consistent-import": require_consistent_import.consistentImport,
40
+ "consistent-object-schema-type": require_consistent_object_schema_type.consistentObjectSchemaType,
41
+ "consistent-schema-var-name": require_consistent_schema_var_name.consistentSchemaVarName,
42
+ "consistent-schema-output-type-style": require_consistent_schema_output_type_style.consistentSchemaOutputTypeStyle,
43
+ "no-any-schema": require_no_any_schema.noAnySchema,
44
+ "no-empty-custom-schema": require_no_empty_custom_schema.noEmptyCustomSchema,
45
+ "no-number-schema-with-finite": require_no_number_schema_with_finite.noNumberSchemaWithFinite,
46
+ "no-number-schema-with-int": require_no_number_schema_with_int.noNumberSchemaWithInt,
47
+ "no-number-schema-with-is-finite": require_no_number_schema_with_is_finite.noNumberSchemaWithIsFinite,
48
+ "no-number-schema-with-is-int": require_no_number_schema_with_is_int.noNumberSchemaWithIsInt,
49
+ "no-number-schema-with-safe": require_no_number_schema_with_safe.noNumberSchemaWithSafe,
50
+ "no-number-schema-with-step": require_no_number_schema_with_step.noNumberSchemaWithStep,
51
+ "no-string-schema-with-uuid": require_no_string_schema_with_uuid.noStringSchemaWithUuid,
52
+ "no-optional-and-default-together": require_no_optional_and_default_together.noOptionalAndDefaultTogether,
53
+ "no-throw-in-refine": require_no_throw_in_refine.noThrowInRefine,
54
+ "no-transform-in-record-key": require_no_transform_in_record_key.noTransformInRecordKey,
55
+ "no-unknown-schema": require_no_unknown_schema.noUnknownSchema,
56
+ "prefer-enum-over-literal-union": require_prefer_enum_over_literal_union.preferEnumOverLiteralUnion,
57
+ "prefer-meta": require_prefer_meta.preferMeta,
58
+ "prefer-meta-last": require_prefer_meta_last.preferMetaLast,
59
+ "prefer-top-level-string-formats": require_prefer_top_level_string_formats.preferTopLevelStringFormats,
60
+ "prefer-string-schema-with-trim": require_prefer_string_schema_with_trim.preferStringSchemaWithTrim,
61
+ "prefer-trim-before-string-length-checks": require_prefer_trim_before_string_length_checks.preferTrimBeforeStringLengthChecks,
62
+ "require-brand-type-parameter": require_require_brand_type_parameter.requireBrandTypeParameter,
63
+ "require-error-message": require_require_error_message.requireErrorMessage,
64
+ "schema-error-property-style": require_schema_error_property_style.schemaErrorPropertyStyle
65
+ }
66
+ };
67
+ const recommendedConfig = {
68
+ name: `${require_meta.PLUGIN_NAME}/recommended`,
69
+ files: ["**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}"],
70
+ plugins: { zod: eslintPluginZod },
71
+ rules: {
72
+ "zod/array-style": "error",
73
+ "zod/consistent-import": "error",
74
+ "zod/consistent-schema-var-name": "error",
75
+ "zod/no-any-schema": "error",
76
+ "zod/no-empty-custom-schema": "error",
77
+ "zod/no-number-schema-with-finite": "error",
78
+ "zod/no-number-schema-with-int": "error",
79
+ "zod/no-number-schema-with-is-finite": "error",
80
+ "zod/no-number-schema-with-is-int": "error",
81
+ "zod/no-number-schema-with-safe": "error",
82
+ "zod/no-number-schema-with-step": "error",
83
+ "zod/no-string-schema-with-uuid": "error",
84
+ "zod/no-optional-and-default-together": "error",
85
+ "zod/no-throw-in-refine": "error",
86
+ "zod/prefer-enum-over-literal-union": "error",
87
+ "zod/prefer-meta": "error",
88
+ "zod/prefer-meta-last": "error",
89
+ "zod/prefer-top-level-string-formats": "error",
90
+ "zod/prefer-string-schema-with-trim": "error",
91
+ "zod/prefer-trim-before-string-length-checks": "error",
92
+ "zod/require-brand-type-parameter": "error",
93
+ "zod/require-error-message": "error"
94
+ }
95
+ };
96
+ var src_default = {
97
+ ...eslintPluginZod,
98
+ configs: { recommended: recommendedConfig }
99
+ };
100
+ /**
101
+ * why `satisfies`?
102
+ * @see https://github.com/marcalexiei/eslint-zod/issues/49
103
+ */
104
+ //#endregion
105
+ module.exports = src_default;
@@ -0,0 +1,22 @@
1
+ //#region src/index.d.ts
2
+ interface CompatibleConfig {
3
+ name?: string;
4
+ rules?: object;
5
+ plugins?: Record<string, CompatiblePlugin>;
6
+ }
7
+ interface CompatiblePlugin {
8
+ meta: {
9
+ name: string;
10
+ version: string;
11
+ };
12
+ }
13
+ declare const _default: {
14
+ configs: {
15
+ recommended: CompatibleConfig;
16
+ };
17
+ meta: {
18
+ name: string;
19
+ version: string;
20
+ };
21
+ };
22
+ export = _default;
@@ -0,0 +1,23 @@
1
+ //#region src/index.d.ts
2
+ interface CompatibleConfig {
3
+ name?: string;
4
+ rules?: object;
5
+ plugins?: Record<string, CompatiblePlugin>;
6
+ }
7
+ interface CompatiblePlugin {
8
+ meta: {
9
+ name: string;
10
+ version: string;
11
+ };
12
+ }
13
+ declare const _default: {
14
+ configs: {
15
+ recommended: CompatibleConfig;
16
+ };
17
+ meta: {
18
+ name: string;
19
+ version: string;
20
+ };
21
+ };
22
+ //#endregion
23
+ export { _default as default };
package/dist/index.mjs ADDED
@@ -0,0 +1,105 @@
1
+ import { PLUGIN_NAME, PLUGIN_VERSION } from "./meta.mjs";
2
+ import { arrayStyle } from "./rules/array-style.mjs";
3
+ import { consistentImportSource } from "./rules/consistent-import-source.mjs";
4
+ import { consistentImport } from "./rules/consistent-import.mjs";
5
+ import { consistentObjectSchemaType } from "./rules/consistent-object-schema-type.mjs";
6
+ import { consistentSchemaOutputTypeStyle } from "./rules/consistent-schema-output-type-style.mjs";
7
+ import { consistentSchemaVarName } from "./rules/consistent-schema-var-name.mjs";
8
+ import { noAnySchema } from "./rules/no-any-schema.mjs";
9
+ import { noEmptyCustomSchema } from "./rules/no-empty-custom-schema.mjs";
10
+ import { noNumberSchemaWithFinite } from "./rules/no-number-schema-with-finite.mjs";
11
+ import { noNumberSchemaWithInt } from "./rules/no-number-schema-with-int.mjs";
12
+ import { noNumberSchemaWithIsFinite } from "./rules/no-number-schema-with-is-finite.mjs";
13
+ import { noNumberSchemaWithIsInt } from "./rules/no-number-schema-with-is-int.mjs";
14
+ import { noNumberSchemaWithSafe } from "./rules/no-number-schema-with-safe.mjs";
15
+ import { noNumberSchemaWithStep } from "./rules/no-number-schema-with-step.mjs";
16
+ import { noOptionalAndDefaultTogether } from "./rules/no-optional-and-default-together.mjs";
17
+ import { noStringSchemaWithUuid } from "./rules/no-string-schema-with-uuid.mjs";
18
+ import { noThrowInRefine } from "./rules/no-throw-in-refine.mjs";
19
+ import { noTransformInRecordKey } from "./rules/no-transform-in-record-key.mjs";
20
+ import { noUnknownSchema } from "./rules/no-unknown-schema.mjs";
21
+ import { preferEnumOverLiteralUnion } from "./rules/prefer-enum-over-literal-union.mjs";
22
+ import { preferMetaLast } from "./rules/prefer-meta-last.mjs";
23
+ import { preferMeta } from "./rules/prefer-meta.mjs";
24
+ import { preferStringSchemaWithTrim } from "./rules/prefer-string-schema-with-trim.mjs";
25
+ import { preferTopLevelStringFormats } from "./rules/prefer-top-level-string-formats.mjs";
26
+ import { preferTrimBeforeStringLengthChecks } from "./rules/prefer-trim-before-string-length-checks.mjs";
27
+ import { requireBrandTypeParameter } from "./rules/require-brand-type-parameter.mjs";
28
+ import { requireErrorMessage } from "./rules/require-error-message.mjs";
29
+ import { schemaErrorPropertyStyle } from "./rules/schema-error-property-style.mjs";
30
+ //#region src/index.ts
31
+ const eslintPluginZod = {
32
+ meta: {
33
+ name: PLUGIN_NAME,
34
+ version: PLUGIN_VERSION
35
+ },
36
+ rules: {
37
+ "array-style": arrayStyle,
38
+ "consistent-import-source": consistentImportSource,
39
+ "consistent-import": consistentImport,
40
+ "consistent-object-schema-type": consistentObjectSchemaType,
41
+ "consistent-schema-var-name": consistentSchemaVarName,
42
+ "consistent-schema-output-type-style": consistentSchemaOutputTypeStyle,
43
+ "no-any-schema": noAnySchema,
44
+ "no-empty-custom-schema": noEmptyCustomSchema,
45
+ "no-number-schema-with-finite": noNumberSchemaWithFinite,
46
+ "no-number-schema-with-int": noNumberSchemaWithInt,
47
+ "no-number-schema-with-is-finite": noNumberSchemaWithIsFinite,
48
+ "no-number-schema-with-is-int": noNumberSchemaWithIsInt,
49
+ "no-number-schema-with-safe": noNumberSchemaWithSafe,
50
+ "no-number-schema-with-step": noNumberSchemaWithStep,
51
+ "no-string-schema-with-uuid": noStringSchemaWithUuid,
52
+ "no-optional-and-default-together": noOptionalAndDefaultTogether,
53
+ "no-throw-in-refine": noThrowInRefine,
54
+ "no-transform-in-record-key": noTransformInRecordKey,
55
+ "no-unknown-schema": noUnknownSchema,
56
+ "prefer-enum-over-literal-union": preferEnumOverLiteralUnion,
57
+ "prefer-meta": preferMeta,
58
+ "prefer-meta-last": preferMetaLast,
59
+ "prefer-top-level-string-formats": preferTopLevelStringFormats,
60
+ "prefer-string-schema-with-trim": preferStringSchemaWithTrim,
61
+ "prefer-trim-before-string-length-checks": preferTrimBeforeStringLengthChecks,
62
+ "require-brand-type-parameter": requireBrandTypeParameter,
63
+ "require-error-message": requireErrorMessage,
64
+ "schema-error-property-style": schemaErrorPropertyStyle
65
+ }
66
+ };
67
+ const recommendedConfig = {
68
+ name: `${PLUGIN_NAME}/recommended`,
69
+ files: ["**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}"],
70
+ plugins: { zod: eslintPluginZod },
71
+ rules: {
72
+ "zod/array-style": "error",
73
+ "zod/consistent-import": "error",
74
+ "zod/consistent-schema-var-name": "error",
75
+ "zod/no-any-schema": "error",
76
+ "zod/no-empty-custom-schema": "error",
77
+ "zod/no-number-schema-with-finite": "error",
78
+ "zod/no-number-schema-with-int": "error",
79
+ "zod/no-number-schema-with-is-finite": "error",
80
+ "zod/no-number-schema-with-is-int": "error",
81
+ "zod/no-number-schema-with-safe": "error",
82
+ "zod/no-number-schema-with-step": "error",
83
+ "zod/no-string-schema-with-uuid": "error",
84
+ "zod/no-optional-and-default-together": "error",
85
+ "zod/no-throw-in-refine": "error",
86
+ "zod/prefer-enum-over-literal-union": "error",
87
+ "zod/prefer-meta": "error",
88
+ "zod/prefer-meta-last": "error",
89
+ "zod/prefer-top-level-string-formats": "error",
90
+ "zod/prefer-string-schema-with-trim": "error",
91
+ "zod/prefer-trim-before-string-length-checks": "error",
92
+ "zod/require-brand-type-parameter": "error",
93
+ "zod/require-error-message": "error"
94
+ }
95
+ };
96
+ var src_default = {
97
+ ...eslintPluginZod,
98
+ configs: { recommended: recommendedConfig }
99
+ };
100
+ /**
101
+ * why `satisfies`?
102
+ * @see https://github.com/marcalexiei/eslint-zod/issues/49
103
+ */
104
+ //#endregion
105
+ export { src_default as default };
package/dist/meta.cjs ADDED
@@ -0,0 +1,11 @@
1
+ require("./_virtual/_rolldown/runtime.cjs");
2
+ let node_fs = require("node:fs");
3
+ //#region src/meta.ts
4
+ const { name: PLUGIN_NAME, version: PLUGIN_VERSION, repository } = JSON.parse((0, node_fs.readFileSync)(new URL("../package.json", require("url").pathToFileURL(__filename).href), "utf8"));
5
+ function getRuleURL(ruleID) {
6
+ return `${repository.url}/blob/HEAD/${repository.directory}/docs/rules/${ruleID}.md`;
7
+ }
8
+ //#endregion
9
+ exports.PLUGIN_NAME = PLUGIN_NAME;
10
+ exports.PLUGIN_VERSION = PLUGIN_VERSION;
11
+ exports.getRuleURL = getRuleURL;
package/dist/meta.mjs ADDED
@@ -0,0 +1,8 @@
1
+ import { readFileSync } from "node:fs";
2
+ //#region src/meta.ts
3
+ const { name: PLUGIN_NAME, version: PLUGIN_VERSION, repository } = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
4
+ function getRuleURL(ruleID) {
5
+ return `${repository.url}/blob/HEAD/${repository.directory}/docs/rules/${ruleID}.md`;
6
+ }
7
+ //#endregion
8
+ export { PLUGIN_NAME, PLUGIN_VERSION, getRuleURL };
@@ -0,0 +1,87 @@
1
+ require("../_virtual/_rolldown/runtime.cjs");
2
+ const require_create_plugin_rule = require("../utils/create-plugin-rule.cjs");
3
+ let _eslint_zod_utils = require("@eslint-zod/utils");
4
+ //#region src/rules/array-style.ts
5
+ const ZOD_ARRAY_STYLES = ["function", "method"];
6
+ const defaultOptions = { style: "function" };
7
+ const { trackZodSchemaImports } = (0, _eslint_zod_utils.createZodSchemaImportTrack)(_eslint_zod_utils.zodImportScope);
8
+ const arrayStyle = require_create_plugin_rule.createZodPluginRule({
9
+ name: "array-style",
10
+ meta: {
11
+ type: "suggestion",
12
+ fixable: "code",
13
+ docs: { description: "Enforce consistent Zod array style" },
14
+ messages: {
15
+ useFunction: "Use z.array(schema) instead of schema.array().",
16
+ useMethod: "Use schema.array() instead of z.array(schema)."
17
+ },
18
+ schema: [{
19
+ type: "object",
20
+ properties: { style: {
21
+ description: "Decides which style for zod array function",
22
+ type: "string",
23
+ enum: ZOD_ARRAY_STYLES
24
+ } },
25
+ additionalProperties: false
26
+ }]
27
+ },
28
+ defaultOptions: [defaultOptions],
29
+ create(context, [{ style }]) {
30
+ const { sourceCode } = context;
31
+ const { importDeclarationListener, detectZodSchemaRootNode, collectZodChainMethods } = trackZodSchemaImports();
32
+ return {
33
+ ImportDeclaration: importDeclarationListener,
34
+ CallExpression(node) {
35
+ const zodSchema = detectZodSchemaRootNode(node);
36
+ if (!zodSchema) return;
37
+ const { schemaDecl, schemaType } = zodSchema;
38
+ if (style === "method") {
39
+ if (schemaType === "array") {
40
+ if (schemaDecl === "namespace") {
41
+ context.report({
42
+ node,
43
+ messageId: "useMethod",
44
+ fix(fixer) {
45
+ const arrayCall = collectZodChainMethods(node).find((c) => c.name === "array");
46
+ if (!arrayCall) return null;
47
+ const arg = arrayCall.node.arguments.at(0);
48
+ if (!arg) return null;
49
+ const argText = sourceCode.getText(arg);
50
+ return fixer.replaceText(arrayCall.node, `${argText}.array()`);
51
+ }
52
+ });
53
+ return;
54
+ }
55
+ context.report({
56
+ node,
57
+ messageId: "useMethod"
58
+ });
59
+ }
60
+ return;
61
+ }
62
+ const arrayMethod = collectZodChainMethods(node).find((it) => it.name === "array" && it.node.arguments.length === 0);
63
+ if (arrayMethod) {
64
+ const arrayNode = arrayMethod.node;
65
+ if (schemaDecl === "namespace") {
66
+ context.report({
67
+ node,
68
+ messageId: "useFunction",
69
+ fix(fixer) {
70
+ const callee = arrayNode.callee;
71
+ const objText = sourceCode.getText(callee.object);
72
+ return fixer.replaceText(arrayNode, `z.array(${objText})`);
73
+ }
74
+ });
75
+ return;
76
+ }
77
+ context.report({
78
+ node,
79
+ messageId: "useFunction"
80
+ });
81
+ }
82
+ }
83
+ };
84
+ }
85
+ });
86
+ //#endregion
87
+ exports.arrayStyle = arrayStyle;
@@ -0,0 +1,86 @@
1
+ import { createZodPluginRule } from "../utils/create-plugin-rule.mjs";
2
+ import { createZodSchemaImportTrack, zodImportScope } from "@eslint-zod/utils";
3
+ //#region src/rules/array-style.ts
4
+ const ZOD_ARRAY_STYLES = ["function", "method"];
5
+ const defaultOptions = { style: "function" };
6
+ const { trackZodSchemaImports } = createZodSchemaImportTrack(zodImportScope);
7
+ const arrayStyle = createZodPluginRule({
8
+ name: "array-style",
9
+ meta: {
10
+ type: "suggestion",
11
+ fixable: "code",
12
+ docs: { description: "Enforce consistent Zod array style" },
13
+ messages: {
14
+ useFunction: "Use z.array(schema) instead of schema.array().",
15
+ useMethod: "Use schema.array() instead of z.array(schema)."
16
+ },
17
+ schema: [{
18
+ type: "object",
19
+ properties: { style: {
20
+ description: "Decides which style for zod array function",
21
+ type: "string",
22
+ enum: ZOD_ARRAY_STYLES
23
+ } },
24
+ additionalProperties: false
25
+ }]
26
+ },
27
+ defaultOptions: [defaultOptions],
28
+ create(context, [{ style }]) {
29
+ const { sourceCode } = context;
30
+ const { importDeclarationListener, detectZodSchemaRootNode, collectZodChainMethods } = trackZodSchemaImports();
31
+ return {
32
+ ImportDeclaration: importDeclarationListener,
33
+ CallExpression(node) {
34
+ const zodSchema = detectZodSchemaRootNode(node);
35
+ if (!zodSchema) return;
36
+ const { schemaDecl, schemaType } = zodSchema;
37
+ if (style === "method") {
38
+ if (schemaType === "array") {
39
+ if (schemaDecl === "namespace") {
40
+ context.report({
41
+ node,
42
+ messageId: "useMethod",
43
+ fix(fixer) {
44
+ const arrayCall = collectZodChainMethods(node).find((c) => c.name === "array");
45
+ if (!arrayCall) return null;
46
+ const arg = arrayCall.node.arguments.at(0);
47
+ if (!arg) return null;
48
+ const argText = sourceCode.getText(arg);
49
+ return fixer.replaceText(arrayCall.node, `${argText}.array()`);
50
+ }
51
+ });
52
+ return;
53
+ }
54
+ context.report({
55
+ node,
56
+ messageId: "useMethod"
57
+ });
58
+ }
59
+ return;
60
+ }
61
+ const arrayMethod = collectZodChainMethods(node).find((it) => it.name === "array" && it.node.arguments.length === 0);
62
+ if (arrayMethod) {
63
+ const arrayNode = arrayMethod.node;
64
+ if (schemaDecl === "namespace") {
65
+ context.report({
66
+ node,
67
+ messageId: "useFunction",
68
+ fix(fixer) {
69
+ const callee = arrayNode.callee;
70
+ const objText = sourceCode.getText(callee.object);
71
+ return fixer.replaceText(arrayNode, `z.array(${objText})`);
72
+ }
73
+ });
74
+ return;
75
+ }
76
+ context.report({
77
+ node,
78
+ messageId: "useFunction"
79
+ });
80
+ }
81
+ }
82
+ };
83
+ }
84
+ });
85
+ //#endregion
86
+ export { arrayStyle };
@@ -0,0 +1,58 @@
1
+ require("../_virtual/_rolldown/runtime.cjs");
2
+ const require_create_plugin_rule = require("../utils/create-plugin-rule.cjs");
3
+ let _eslint_zod_utils = require("@eslint-zod/utils");
4
+ //#region src/rules/consistent-import-source.ts
5
+ const consistentImportSource = require_create_plugin_rule.createZodPluginRule({
6
+ name: "consistent-import-source",
7
+ meta: {
8
+ hasSuggestions: true,
9
+ type: "suggestion",
10
+ docs: { description: "Enforce consistent source from Zod imports" },
11
+ messages: {
12
+ sourceNotAllowed: "\"{{source}}\" is not allowed. Available values are: {{sources}}",
13
+ replaceSource: "Replace \"{{invalid}}\" with \"{{valid}}\""
14
+ },
15
+ schema: [{
16
+ type: "object",
17
+ properties: { sources: {
18
+ type: "array",
19
+ description: "An array of allowed Zod import sources.",
20
+ items: {
21
+ type: "string",
22
+ enum: [..._eslint_zod_utils.zodImportScope.sources]
23
+ },
24
+ minItems: 1,
25
+ uniqueItems: true
26
+ } },
27
+ additionalProperties: false
28
+ }]
29
+ },
30
+ defaultOptions: [{ sources: ["zod"] }],
31
+ create(context, [{ sources }]) {
32
+ return { ImportDeclaration(node) {
33
+ const sourceValue = node.source.value;
34
+ if (!_eslint_zod_utils.zodImportScope.isAllowed(sourceValue)) return;
35
+ if (sources.includes(sourceValue)) return;
36
+ context.report({
37
+ node,
38
+ messageId: "sourceNotAllowed",
39
+ data: {
40
+ source: sourceValue,
41
+ sources: sources.map((s) => `"${s}"`).join(", ")
42
+ },
43
+ suggest: sources.map((it) => ({
44
+ messageId: "replaceSource",
45
+ data: {
46
+ valid: it,
47
+ invalid: sourceValue
48
+ },
49
+ fix(fixer) {
50
+ return fixer.replaceText(node.source, node.source.raw.replace(sourceValue, it));
51
+ }
52
+ }))
53
+ });
54
+ } };
55
+ }
56
+ });
57
+ //#endregion
58
+ exports.consistentImportSource = consistentImportSource;