eslint-plugin-zod-mini 0.1.0 → 1.0.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.
- package/README.md +35 -27
- package/package.json +38 -38
- package/dist/_virtual/_rolldown/runtime.cjs +0 -23
- package/dist/index.cjs +0 -62
- package/dist/index.d.cts +0 -22
- package/dist/index.d.mts +0 -23
- package/dist/index.mjs +0 -62
- package/dist/meta.cjs +0 -12
- package/dist/meta.mjs +0 -9
- package/dist/rules/consistent-import-source.cjs +0 -61
- package/dist/rules/consistent-import-source.mjs +0 -60
- package/dist/rules/consistent-import.cjs +0 -153
- package/dist/rules/consistent-import.mjs +0 -152
- package/dist/rules/consistent-object-schema-type.cjs +0 -82
- package/dist/rules/consistent-object-schema-type.mjs +0 -81
- package/dist/rules/consistent-schema-output-type-style.cjs +0 -70
- package/dist/rules/consistent-schema-output-type-style.mjs +0 -69
- package/dist/rules/consistent-schema-var-name.cjs +0 -76
- package/dist/rules/consistent-schema-var-name.mjs +0 -75
- package/dist/rules/no-any-schema.cjs +0 -63
- package/dist/rules/no-any-schema.mjs +0 -62
- package/dist/rules/no-empty-custom-schema.cjs +0 -36
- package/dist/rules/no-empty-custom-schema.mjs +0 -36
- package/dist/rules/no-unknown-schema.cjs +0 -31
- package/dist/rules/no-unknown-schema.mjs +0 -31
- package/dist/rules/prefer-meta.cjs +0 -46
- package/dist/rules/prefer-meta.mjs +0 -45
- package/dist/rules/prefer-namespace-import.cjs +0 -117
- package/dist/rules/prefer-namespace-import.mjs +0 -116
- package/dist/rules/require-brand-type-parameter.cjs +0 -49
- package/dist/rules/require-brand-type-parameter.mjs +0 -49
- package/dist/rules/require-error-message.cjs +0 -85
- package/dist/rules/require-error-message.mjs +0 -84
- package/dist/rules/require-schema-suffix.cjs +0 -69
- package/dist/rules/require-schema-suffix.mjs +0 -68
- package/dist/rules/schema-error-property-style.cjs +0 -96
- package/dist/rules/schema-error-property-style.mjs +0 -94
- package/dist/src/index.d.ts +0 -21
- package/dist/src/index.js +0 -56
- package/dist/src/meta.d.ts +0 -3
- package/dist/src/meta.js +0 -8
- package/dist/src/rules/consistent-import-source.d.ts +0 -11
- package/dist/src/rules/consistent-import-source.js +0 -64
- package/dist/src/rules/consistent-import-source.spec.d.ts +0 -1
- package/dist/src/rules/consistent-import-source.spec.js +0 -103
- package/dist/src/rules/consistent-import.d.ts +0 -12
- package/dist/src/rules/consistent-import.js +0 -176
- package/dist/src/rules/consistent-import.spec.d.ts +0 -1
- package/dist/src/rules/consistent-import.spec.js +0 -194
- package/dist/src/rules/consistent-object-schema-type.d.ts +0 -13
- package/dist/src/rules/consistent-object-schema-type.js +0 -82
- package/dist/src/rules/consistent-object-schema-type.spec.d.ts +0 -1
- package/dist/src/rules/consistent-object-schema-type.spec.js +0 -138
- package/dist/src/rules/consistent-schema-output-type-style.d.ts +0 -12
- package/dist/src/rules/consistent-schema-output-type-style.js +0 -81
- package/dist/src/rules/consistent-schema-output-type-style.spec.d.ts +0 -1
- package/dist/src/rules/consistent-schema-output-type-style.spec.js +0 -128
- package/dist/src/rules/consistent-schema-var-name.d.ts +0 -10
- package/dist/src/rules/consistent-schema-var-name.js +0 -86
- package/dist/src/rules/consistent-schema-var-name.spec.d.ts +0 -1
- package/dist/src/rules/consistent-schema-var-name.spec.js +0 -130
- package/dist/src/rules/no-any-schema.d.ts +0 -6
- package/dist/src/rules/no-any-schema.js +0 -65
- package/dist/src/rules/no-any-schema.spec.d.ts +0 -1
- package/dist/src/rules/no-any-schema.spec.js +0 -155
- package/dist/src/rules/no-empty-custom-schema.d.ts +0 -5
- package/dist/src/rules/no-empty-custom-schema.js +0 -43
- package/dist/src/rules/no-empty-custom-schema.spec.d.ts +0 -1
- package/dist/src/rules/no-empty-custom-schema.spec.js +0 -97
- package/dist/src/rules/no-unknown-schema.d.ts +0 -5
- package/dist/src/rules/no-unknown-schema.js +0 -33
- package/dist/src/rules/no-unknown-schema.spec.d.ts +0 -1
- package/dist/src/rules/no-unknown-schema.spec.js +0 -75
- package/dist/src/rules/prefer-meta.d.ts +0 -5
- package/dist/src/rules/prefer-meta.js +0 -51
- package/dist/src/rules/prefer-meta.spec.d.ts +0 -1
- package/dist/src/rules/prefer-meta.spec.js +0 -118
- package/dist/src/rules/prefer-namespace-import.d.ts +0 -5
- package/dist/src/rules/prefer-namespace-import.js +0 -146
- package/dist/src/rules/prefer-namespace-import.spec.d.ts +0 -1
- package/dist/src/rules/prefer-namespace-import.spec.js +0 -100
- package/dist/src/rules/require-brand-type-parameter.d.ts +0 -6
- package/dist/src/rules/require-brand-type-parameter.js +0 -58
- package/dist/src/rules/require-brand-type-parameter.spec.d.ts +0 -1
- package/dist/src/rules/require-brand-type-parameter.spec.js +0 -157
- package/dist/src/rules/require-error-message.d.ts +0 -5
- package/dist/src/rules/require-error-message.js +0 -103
- package/dist/src/rules/require-error-message.spec.d.ts +0 -1
- package/dist/src/rules/require-error-message.spec.js +0 -161
- package/dist/src/rules/require-schema-suffix.d.ts +0 -9
- package/dist/src/rules/require-schema-suffix.js +0 -79
- package/dist/src/rules/require-schema-suffix.spec.d.ts +0 -1
- package/dist/src/rules/require-schema-suffix.spec.js +0 -131
- package/dist/src/rules/schema-error-property-style.d.ts +0 -10
- package/dist/src/rules/schema-error-property-style.js +0 -102
- package/dist/src/rules/schema-error-property-style.spec.d.ts +0 -1
- package/dist/src/rules/schema-error-property-style.spec.js +0 -134
- package/dist/src/utils/create-plugin-rule.d.ts +0 -8
- package/dist/src/utils/create-plugin-rule.js +0 -3
- package/dist/tests/setup.d.ts +0 -1
- package/dist/tests/setup.js +0 -12
- package/dist/tsconfig.tsbuildinfo +0 -1
- package/dist/tsdown.config.d.ts +0 -2
- package/dist/tsdown.config.js +0 -11
- package/dist/utils/create-plugin-rule.cjs +0 -6
- package/dist/utils/create-plugin-rule.mjs +0 -6
- package/dist/vitest.config.d.ts +0 -2
- package/dist/vitest.config.js +0 -7
package/README.md
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
# eslint-plugin-zod-mini
|
|
2
2
|
|
|
3
|
-
[![CI][CIBadge]][CIURL]
|
|
3
|
+
[![CI Status][CIBadge]][CIURL]
|
|
4
4
|
[![Code style: prettier][CodeStyleBadge]][CodeStyleURL]
|
|
5
5
|
[![Lint: eslint][lintBadge]][lintURL]
|
|
6
|
-
[![
|
|
7
|
-
[![
|
|
6
|
+
[![Open on npmx][npmVersionBadge]][npmVersionURL]
|
|
7
|
+
[![Open issue tracker][issuesBadge]][issuesURL]
|
|
8
8
|
|
|
9
|
-
[CIBadge]: https://img.shields.io/github/actions/workflow/status/marcalexiei/eslint-
|
|
10
|
-
[CIURL]: https://github.com/marcalexiei/eslint-
|
|
9
|
+
[CIBadge]: https://img.shields.io/github/actions/workflow/status/marcalexiei/eslint-zod/ci.yml?style=for-the-badge&logo=github&event=push&label=CI
|
|
10
|
+
[CIURL]: https://github.com/marcalexiei/eslint-zod/actions/workflows/CI.yml/badge.svg
|
|
11
11
|
[CodeStyleBadge]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge&logo=prettier
|
|
12
12
|
[CodeStyleURL]: https://prettier.io
|
|
13
13
|
[npmVersionBadge]: https://img.shields.io/npm/v/eslint-plugin-zod-mini.svg?style=for-the-badge&logo=npm
|
|
14
|
-
[npmVersionURL]: https://
|
|
14
|
+
[npmVersionURL]: https://npmx.dev/package/eslint-plugin-zod-mini
|
|
15
15
|
[lintBadge]: https://img.shields.io/badge/lint-eslint-3A33D1?logo=eslint&style=for-the-badge
|
|
16
16
|
[lintURL]: https://eslint.org
|
|
17
|
-
[issuesBadge]: https://img.shields.io/github/issues/marcalexiei/eslint-
|
|
18
|
-
[issuesURL]: https://github.com/marcalexiei/eslint-
|
|
17
|
+
[issuesBadge]: https://img.shields.io/github/issues/marcalexiei/eslint-zod.svg?style=for-the-badge
|
|
18
|
+
[issuesURL]: https://github.com/marcalexiei/eslint-zod/issues
|
|
19
19
|
|
|
20
20
|
[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`).
|
|
21
21
|
|
|
@@ -29,25 +29,22 @@ 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
|
-
|
|
35
|
-
|
|
|
36
|
-
|
|
|
37
|
-
| [consistent-import](docs/rules/consistent-import.md)
|
|
38
|
-
| [consistent-
|
|
39
|
-
| [consistent-
|
|
40
|
-
| [consistent-schema-
|
|
41
|
-
| [
|
|
42
|
-
| [no-
|
|
43
|
-
| [no-
|
|
44
|
-
| [
|
|
45
|
-
| [
|
|
46
|
-
| [
|
|
47
|
-
| [
|
|
48
|
-
| [require-error-message](docs/rules/require-error-message.md) | Enforce that custom refinements include an error message | ✅ | 🔧 | | |
|
|
49
|
-
| [require-schema-suffix](docs/rules/require-schema-suffix.md) | Require schema suffix when declaring a Zod Mini schema | | | | ❌ |
|
|
50
|
-
| [schema-error-property-style](docs/rules/schema-error-property-style.md) | Enforce consistent style for error messages in Zod Mini schema validation (using ESQuery patterns) | | | | |
|
|
32
|
+
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
|
|
33
|
+
|
|
34
|
+
| Name | Description | 💼 | 🔧 | 💡 |
|
|
35
|
+
| :--------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------- | :-- | :-- | :-- |
|
|
36
|
+
| [consistent-import](docs/rules/consistent-import.md) | Enforce a consistent import style for Zod Mini | ✅ | 🔧 | |
|
|
37
|
+
| [consistent-import-source](docs/rules/consistent-import-source.md) | Enforce consistent source from Zod Mini imports | | | 💡 |
|
|
38
|
+
| [consistent-object-schema-type](docs/rules/consistent-object-schema-type.md) | Enforce consistent usage of Zod Mini schema methods | | | 💡 |
|
|
39
|
+
| [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 | | 🔧 | |
|
|
40
|
+
| [consistent-schema-var-name](docs/rules/consistent-schema-var-name.md) | Enforce a consistent naming convention for Zod Mini schema variables | ✅ | | |
|
|
41
|
+
| [no-any-schema](docs/rules/no-any-schema.md) | Disallow usage of `z.any()` in Zod Mini schemas | ✅ | | 💡 |
|
|
42
|
+
| [no-empty-custom-schema](docs/rules/no-empty-custom-schema.md) | Disallow usage of `z.custom()` without arguments | ✅ | | |
|
|
43
|
+
| [no-unknown-schema](docs/rules/no-unknown-schema.md) | Disallow usage of `z.unknown()` in Zod Mini schemas | | | |
|
|
44
|
+
| [prefer-meta](docs/rules/prefer-meta.md) | Enforce usage of `z.meta()` over `z.describe()` | ✅ | 🔧 | |
|
|
45
|
+
| [require-brand-type-parameter](docs/rules/require-brand-type-parameter.md) | Require type parameter on `.brand()` functions | ✅ | | 💡 |
|
|
46
|
+
| [require-error-message](docs/rules/require-error-message.md) | Enforce that custom refinements include an error message | ✅ | 🔧 | |
|
|
47
|
+
| [schema-error-property-style](docs/rules/schema-error-property-style.md) | Enforce consistent style for error messages in Zod Mini schema validation (using ESQuery patterns) | | | |
|
|
51
48
|
|
|
52
49
|
<!-- end auto-generated rules list -->
|
|
53
50
|
|
|
@@ -147,3 +144,14 @@ export default defineConfig({
|
|
|
147
144
|
},
|
|
148
145
|
});
|
|
149
146
|
```
|
|
147
|
+
|
|
148
|
+
## Zod peer dependency version
|
|
149
|
+
|
|
150
|
+
`eslint-plugin-zod-mini` is designed for projects that use `zod@^4` (specifically `zod/mini`).
|
|
151
|
+
While the plugin analyzes Zod Mini schemas in your code,
|
|
152
|
+
it doesn't import or depend on Zod at runtime.
|
|
153
|
+
To document this relationship without forcing installation,
|
|
154
|
+
Zod is declared as an optional peer dependency in the plugin's `package.json`.
|
|
155
|
+
|
|
156
|
+
If your project uses Zod Mini, the plugin will automatically lint your schemas.
|
|
157
|
+
If you're not using Zod (for example, in a separate ESLint workspace), you don't need to install it.
|
package/package.json
CHANGED
|
@@ -1,17 +1,32 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "eslint-plugin-zod-mini",
|
|
3
|
-
"version": "
|
|
4
|
-
"type": "module",
|
|
3
|
+
"version": "1.0.0",
|
|
5
4
|
"description": "ESLint plugin that adds custom linting rules to enforce best practices when using Zod Mini",
|
|
6
|
-
"
|
|
7
|
-
"
|
|
5
|
+
"keywords": [
|
|
6
|
+
"eslint",
|
|
7
|
+
"eslint-plugin",
|
|
8
|
+
"eslintplugin",
|
|
9
|
+
"zod",
|
|
10
|
+
"zod-mini"
|
|
11
|
+
],
|
|
12
|
+
"homepage": "https://github.com/marcalexiei/eslint-zod#readme",
|
|
13
|
+
"bugs": {
|
|
14
|
+
"url": "https://github.com/marcalexiei/eslint-zod/issues"
|
|
8
15
|
},
|
|
9
|
-
"
|
|
10
|
-
|
|
16
|
+
"license": "MIT",
|
|
17
|
+
"author": "Marco Pasqualetti @marcalexiei",
|
|
18
|
+
"repository": {
|
|
19
|
+
"type": "git",
|
|
20
|
+
"url": "https://github.com/marcalexiei/eslint-zod",
|
|
21
|
+
"directory": "plugins/eslint-plugin-zod-mini"
|
|
11
22
|
},
|
|
23
|
+
"files": [
|
|
24
|
+
"dist"
|
|
25
|
+
],
|
|
26
|
+
"type": "module",
|
|
12
27
|
"main": "./dist/index.cjs",
|
|
13
|
-
"types": "./dist/index.d.cts",
|
|
14
28
|
"module": "./dist/index.mjs",
|
|
29
|
+
"types": "./dist/index.d.cts",
|
|
15
30
|
"exports": {
|
|
16
31
|
".": {
|
|
17
32
|
"import": "./dist/index.mjs",
|
|
@@ -19,30 +34,23 @@
|
|
|
19
34
|
},
|
|
20
35
|
"./package.json": "./package.json"
|
|
21
36
|
},
|
|
22
|
-
"
|
|
23
|
-
|
|
24
|
-
"url": "https://github.com/marcalexiei/eslint-plugin-zod/issues"
|
|
25
|
-
},
|
|
26
|
-
"keywords": [
|
|
27
|
-
"eslint",
|
|
28
|
-
"eslintplugin",
|
|
29
|
-
"eslint-plugin",
|
|
30
|
-
"zod",
|
|
31
|
-
"zod-mini"
|
|
32
|
-
],
|
|
33
|
-
"files": [
|
|
34
|
-
"dist"
|
|
35
|
-
],
|
|
36
|
-
"author": "Marco Pasqualetti @marcalexiei",
|
|
37
|
-
"license": "MIT",
|
|
38
|
-
"repository": {
|
|
39
|
-
"type": "git",
|
|
40
|
-
"url": "https://github.com/marcalexiei/eslint-plugin-zod"
|
|
37
|
+
"publishConfig": {
|
|
38
|
+
"access": "public"
|
|
41
39
|
},
|
|
42
40
|
"dependencies": {
|
|
43
41
|
"@typescript-eslint/utils": "^8.57.0",
|
|
44
42
|
"esquery": "^1.6.0",
|
|
45
|
-
"@eslint-zod/utils": "
|
|
43
|
+
"@eslint-zod/utils": "1.0.0"
|
|
44
|
+
},
|
|
45
|
+
"devDependencies": {
|
|
46
|
+
"@marcalexiei/prettier-config": "1.1.4",
|
|
47
|
+
"@types/esquery": "1.5.4",
|
|
48
|
+
"@typescript-eslint/rule-tester": "8.59.2",
|
|
49
|
+
"dedent": "1.7.2",
|
|
50
|
+
"eslint-doc-generator": "3.3.2",
|
|
51
|
+
"prettier": "3.8.3",
|
|
52
|
+
"tsdown": "0.21.10",
|
|
53
|
+
"vitest": "4.1.5"
|
|
46
54
|
},
|
|
47
55
|
"peerDependencies": {
|
|
48
56
|
"eslint": "^9 || ^10",
|
|
@@ -60,21 +68,13 @@
|
|
|
60
68
|
"optional": true
|
|
61
69
|
}
|
|
62
70
|
},
|
|
63
|
-
"
|
|
64
|
-
"
|
|
65
|
-
"@types/esquery": "1.5.4",
|
|
66
|
-
"@typescript-eslint/rule-tester": "8.59.2",
|
|
67
|
-
"dedent": "1.7.2",
|
|
68
|
-
"eslint-doc-generator": "3.3.2",
|
|
69
|
-
"prettier": "3.8.3",
|
|
70
|
-
"tsdown": "0.21.10",
|
|
71
|
-
"vitest": "4.1.5"
|
|
71
|
+
"engines": {
|
|
72
|
+
"node": "^20 || ^22 || >=24"
|
|
72
73
|
},
|
|
73
74
|
"scripts": {
|
|
74
75
|
"build": "tsdown",
|
|
75
76
|
"build:docs": "pnpm run build && eslint-doc-generator",
|
|
76
77
|
"lint:docs": "eslint-doc-generator --check",
|
|
77
|
-
"test": "vitest"
|
|
78
|
-
"test:dev": "vitest --typecheck=false"
|
|
78
|
+
"test": "vitest"
|
|
79
79
|
}
|
|
80
80
|
}
|
|
@@ -1,23 +0,0 @@
|
|
|
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
DELETED
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
const require_meta = require("./meta.cjs");
|
|
2
|
-
const require_consistent_import_source = require("./rules/consistent-import-source.cjs");
|
|
3
|
-
const require_consistent_import = require("./rules/consistent-import.cjs");
|
|
4
|
-
const require_consistent_object_schema_type = require("./rules/consistent-object-schema-type.cjs");
|
|
5
|
-
const require_consistent_schema_output_type_style = require("./rules/consistent-schema-output-type-style.cjs");
|
|
6
|
-
const require_consistent_schema_var_name = require("./rules/consistent-schema-var-name.cjs");
|
|
7
|
-
const require_no_any_schema = require("./rules/no-any-schema.cjs");
|
|
8
|
-
const require_no_empty_custom_schema = require("./rules/no-empty-custom-schema.cjs");
|
|
9
|
-
const require_no_unknown_schema = require("./rules/no-unknown-schema.cjs");
|
|
10
|
-
const require_prefer_meta = require("./rules/prefer-meta.cjs");
|
|
11
|
-
const require_prefer_namespace_import = require("./rules/prefer-namespace-import.cjs");
|
|
12
|
-
const require_require_brand_type_parameter = require("./rules/require-brand-type-parameter.cjs");
|
|
13
|
-
const require_require_error_message = require("./rules/require-error-message.cjs");
|
|
14
|
-
const require_require_schema_suffix = require("./rules/require-schema-suffix.cjs");
|
|
15
|
-
const require_schema_error_property_style = require("./rules/schema-error-property-style.cjs");
|
|
16
|
-
//#region src/index.ts
|
|
17
|
-
const eslintPluginZodMini = {
|
|
18
|
-
meta: {
|
|
19
|
-
name: require_meta.PLUGIN_NAME,
|
|
20
|
-
version: require_meta.PLUGIN_VERSION
|
|
21
|
-
},
|
|
22
|
-
rules: {
|
|
23
|
-
"consistent-import": require_consistent_import.consistentImport,
|
|
24
|
-
"consistent-import-source": require_consistent_import_source.consistentImportSource,
|
|
25
|
-
"consistent-object-schema-type": require_consistent_object_schema_type.consistentObjectSchemaType,
|
|
26
|
-
"consistent-schema-output-type-style": require_consistent_schema_output_type_style.consistentSchemaOutputTypeStyle,
|
|
27
|
-
"consistent-schema-var-name": require_consistent_schema_var_name.consistentSchemaVarName,
|
|
28
|
-
"no-any-schema": require_no_any_schema.noAnySchema,
|
|
29
|
-
"no-empty-custom-schema": require_no_empty_custom_schema.noEmptyCustomSchema,
|
|
30
|
-
"no-unknown-schema": require_no_unknown_schema.noUnknownSchema,
|
|
31
|
-
"prefer-meta": require_prefer_meta.preferMeta,
|
|
32
|
-
"prefer-namespace-import": require_prefer_namespace_import.preferNamespaceImport,
|
|
33
|
-
"require-brand-type-parameter": require_require_brand_type_parameter.requireBrandTypeParameter,
|
|
34
|
-
"require-error-message": require_require_error_message.requireErrorMessage,
|
|
35
|
-
"require-schema-suffix": require_require_schema_suffix.requireSchemaSuffix,
|
|
36
|
-
"schema-error-property-style": require_schema_error_property_style.schemaErrorPropertyStyle
|
|
37
|
-
}
|
|
38
|
-
};
|
|
39
|
-
const recommendedConfig = {
|
|
40
|
-
name: `${require_meta.PLUGIN_NAME}/recommended`,
|
|
41
|
-
files: ["**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}"],
|
|
42
|
-
plugins: { "zod-mini": eslintPluginZodMini },
|
|
43
|
-
rules: {
|
|
44
|
-
"zod-mini/consistent-import": "error",
|
|
45
|
-
"zod-mini/consistent-schema-var-name": "error",
|
|
46
|
-
"zod-mini/no-any-schema": "error",
|
|
47
|
-
"zod-mini/no-empty-custom-schema": "error",
|
|
48
|
-
"zod-mini/prefer-meta": "error",
|
|
49
|
-
"zod-mini/require-brand-type-parameter": "error",
|
|
50
|
-
"zod-mini/require-error-message": "error"
|
|
51
|
-
}
|
|
52
|
-
};
|
|
53
|
-
var src_default = {
|
|
54
|
-
...eslintPluginZodMini,
|
|
55
|
-
configs: { recommended: recommendedConfig }
|
|
56
|
-
};
|
|
57
|
-
/**
|
|
58
|
-
* why `satisfies`?
|
|
59
|
-
* @see https://github.com/marcalexiei/eslint-plugin-zod/issues/49
|
|
60
|
-
*/
|
|
61
|
-
//#endregion
|
|
62
|
-
module.exports = src_default;
|
package/dist/index.d.cts
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
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;
|
package/dist/index.d.mts
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
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
DELETED
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
import { PLUGIN_NAME, PLUGIN_VERSION } from "./meta.mjs";
|
|
2
|
-
import { consistentImportSource } from "./rules/consistent-import-source.mjs";
|
|
3
|
-
import { consistentImport } from "./rules/consistent-import.mjs";
|
|
4
|
-
import { consistentObjectSchemaType } from "./rules/consistent-object-schema-type.mjs";
|
|
5
|
-
import { consistentSchemaOutputTypeStyle } from "./rules/consistent-schema-output-type-style.mjs";
|
|
6
|
-
import { consistentSchemaVarName } from "./rules/consistent-schema-var-name.mjs";
|
|
7
|
-
import { noAnySchema } from "./rules/no-any-schema.mjs";
|
|
8
|
-
import { noEmptyCustomSchema } from "./rules/no-empty-custom-schema.mjs";
|
|
9
|
-
import { noUnknownSchema } from "./rules/no-unknown-schema.mjs";
|
|
10
|
-
import { preferMeta } from "./rules/prefer-meta.mjs";
|
|
11
|
-
import { preferNamespaceImport } from "./rules/prefer-namespace-import.mjs";
|
|
12
|
-
import { requireBrandTypeParameter } from "./rules/require-brand-type-parameter.mjs";
|
|
13
|
-
import { requireErrorMessage } from "./rules/require-error-message.mjs";
|
|
14
|
-
import { requireSchemaSuffix } from "./rules/require-schema-suffix.mjs";
|
|
15
|
-
import { schemaErrorPropertyStyle } from "./rules/schema-error-property-style.mjs";
|
|
16
|
-
//#region src/index.ts
|
|
17
|
-
const eslintPluginZodMini = {
|
|
18
|
-
meta: {
|
|
19
|
-
name: PLUGIN_NAME,
|
|
20
|
-
version: PLUGIN_VERSION
|
|
21
|
-
},
|
|
22
|
-
rules: {
|
|
23
|
-
"consistent-import": consistentImport,
|
|
24
|
-
"consistent-import-source": consistentImportSource,
|
|
25
|
-
"consistent-object-schema-type": consistentObjectSchemaType,
|
|
26
|
-
"consistent-schema-output-type-style": consistentSchemaOutputTypeStyle,
|
|
27
|
-
"consistent-schema-var-name": consistentSchemaVarName,
|
|
28
|
-
"no-any-schema": noAnySchema,
|
|
29
|
-
"no-empty-custom-schema": noEmptyCustomSchema,
|
|
30
|
-
"no-unknown-schema": noUnknownSchema,
|
|
31
|
-
"prefer-meta": preferMeta,
|
|
32
|
-
"prefer-namespace-import": preferNamespaceImport,
|
|
33
|
-
"require-brand-type-parameter": requireBrandTypeParameter,
|
|
34
|
-
"require-error-message": requireErrorMessage,
|
|
35
|
-
"require-schema-suffix": requireSchemaSuffix,
|
|
36
|
-
"schema-error-property-style": schemaErrorPropertyStyle
|
|
37
|
-
}
|
|
38
|
-
};
|
|
39
|
-
const recommendedConfig = {
|
|
40
|
-
name: `${PLUGIN_NAME}/recommended`,
|
|
41
|
-
files: ["**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}"],
|
|
42
|
-
plugins: { "zod-mini": eslintPluginZodMini },
|
|
43
|
-
rules: {
|
|
44
|
-
"zod-mini/consistent-import": "error",
|
|
45
|
-
"zod-mini/consistent-schema-var-name": "error",
|
|
46
|
-
"zod-mini/no-any-schema": "error",
|
|
47
|
-
"zod-mini/no-empty-custom-schema": "error",
|
|
48
|
-
"zod-mini/prefer-meta": "error",
|
|
49
|
-
"zod-mini/require-brand-type-parameter": "error",
|
|
50
|
-
"zod-mini/require-error-message": "error"
|
|
51
|
-
}
|
|
52
|
-
};
|
|
53
|
-
var src_default = {
|
|
54
|
-
...eslintPluginZodMini,
|
|
55
|
-
configs: { recommended: recommendedConfig }
|
|
56
|
-
};
|
|
57
|
-
/**
|
|
58
|
-
* why `satisfies`?
|
|
59
|
-
* @see https://github.com/marcalexiei/eslint-plugin-zod/issues/49
|
|
60
|
-
*/
|
|
61
|
-
//#endregion
|
|
62
|
-
export { src_default as default };
|
package/dist/meta.cjs
DELETED
|
@@ -1,12 +0,0 @@
|
|
|
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, homepage } = JSON.parse((0, node_fs.readFileSync)(new URL("../package.json", require("url").pathToFileURL(__filename).href), "utf8"));
|
|
5
|
-
const PLUGIN_HOMEPAGE = homepage.replace(/#[^#]*$/, "");
|
|
6
|
-
function getRuleURL(ruleID) {
|
|
7
|
-
return `${PLUGIN_HOMEPAGE}/blob/v${PLUGIN_VERSION}/docs/rules/${ruleID}.md`;
|
|
8
|
-
}
|
|
9
|
-
//#endregion
|
|
10
|
-
exports.PLUGIN_NAME = PLUGIN_NAME;
|
|
11
|
-
exports.PLUGIN_VERSION = PLUGIN_VERSION;
|
|
12
|
-
exports.getRuleURL = getRuleURL;
|
package/dist/meta.mjs
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { readFileSync } from "node:fs";
|
|
2
|
-
//#region src/meta.ts
|
|
3
|
-
const { name: PLUGIN_NAME, version: PLUGIN_VERSION, homepage } = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
|
|
4
|
-
const PLUGIN_HOMEPAGE = homepage.replace(/#[^#]*$/, "");
|
|
5
|
-
function getRuleURL(ruleID) {
|
|
6
|
-
return `${PLUGIN_HOMEPAGE}/blob/v${PLUGIN_VERSION}/docs/rules/${ruleID}.md`;
|
|
7
|
-
}
|
|
8
|
-
//#endregion
|
|
9
|
-
export { PLUGIN_NAME, PLUGIN_VERSION, getRuleURL };
|
|
@@ -1,61 +0,0 @@
|
|
|
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.createZodMiniPluginRule({
|
|
6
|
-
name: "consistent-import-source",
|
|
7
|
-
meta: {
|
|
8
|
-
hasSuggestions: true,
|
|
9
|
-
type: "suggestion",
|
|
10
|
-
docs: {
|
|
11
|
-
zodImportAllowedSource: "zod-mini",
|
|
12
|
-
description: "Enforce consistent source from Zod Mini imports"
|
|
13
|
-
},
|
|
14
|
-
messages: {
|
|
15
|
-
sourceNotAllowed: "\"{{source}}\" is not allowed. Available values are: {{sources}}",
|
|
16
|
-
replaceSource: "Replace \"{{invalid}}\" with \"{{valid}}\""
|
|
17
|
-
},
|
|
18
|
-
schema: [{
|
|
19
|
-
type: "object",
|
|
20
|
-
properties: { sources: {
|
|
21
|
-
type: "array",
|
|
22
|
-
description: "An array of allowed Zod import sources.",
|
|
23
|
-
items: {
|
|
24
|
-
type: "string",
|
|
25
|
-
enum: [..._eslint_zod_utils.ZOD_IMPORT_SOURCES]
|
|
26
|
-
},
|
|
27
|
-
minItems: 1,
|
|
28
|
-
uniqueItems: true
|
|
29
|
-
} },
|
|
30
|
-
additionalProperties: false
|
|
31
|
-
}]
|
|
32
|
-
},
|
|
33
|
-
defaultOptions: [{ sources: ["zod/mini"] }],
|
|
34
|
-
create(context, [{ sources }]) {
|
|
35
|
-
return { ImportDeclaration(node) {
|
|
36
|
-
const sourceValue = node.source.value;
|
|
37
|
-
if (!sourceValue.startsWith("zod")) return;
|
|
38
|
-
if (sources.includes(sourceValue)) return;
|
|
39
|
-
context.report({
|
|
40
|
-
node,
|
|
41
|
-
messageId: "sourceNotAllowed",
|
|
42
|
-
data: {
|
|
43
|
-
source: sourceValue,
|
|
44
|
-
sources: sources.map((s) => `"${s}"`).join(", ")
|
|
45
|
-
},
|
|
46
|
-
suggest: sources.map((it) => ({
|
|
47
|
-
messageId: "replaceSource",
|
|
48
|
-
data: {
|
|
49
|
-
valid: it,
|
|
50
|
-
invalid: sourceValue
|
|
51
|
-
},
|
|
52
|
-
fix(fixer) {
|
|
53
|
-
return fixer.replaceText(node.source, node.source.raw.replace(sourceValue, it));
|
|
54
|
-
}
|
|
55
|
-
}))
|
|
56
|
-
});
|
|
57
|
-
} };
|
|
58
|
-
}
|
|
59
|
-
});
|
|
60
|
-
//#endregion
|
|
61
|
-
exports.consistentImportSource = consistentImportSource;
|
|
@@ -1,60 +0,0 @@
|
|
|
1
|
-
import { createZodMiniPluginRule } from "../utils/create-plugin-rule.mjs";
|
|
2
|
-
import { ZOD_IMPORT_SOURCES } from "@eslint-zod/utils";
|
|
3
|
-
//#region src/rules/consistent-import-source.ts
|
|
4
|
-
const consistentImportSource = createZodMiniPluginRule({
|
|
5
|
-
name: "consistent-import-source",
|
|
6
|
-
meta: {
|
|
7
|
-
hasSuggestions: true,
|
|
8
|
-
type: "suggestion",
|
|
9
|
-
docs: {
|
|
10
|
-
zodImportAllowedSource: "zod-mini",
|
|
11
|
-
description: "Enforce consistent source from Zod Mini imports"
|
|
12
|
-
},
|
|
13
|
-
messages: {
|
|
14
|
-
sourceNotAllowed: "\"{{source}}\" is not allowed. Available values are: {{sources}}",
|
|
15
|
-
replaceSource: "Replace \"{{invalid}}\" with \"{{valid}}\""
|
|
16
|
-
},
|
|
17
|
-
schema: [{
|
|
18
|
-
type: "object",
|
|
19
|
-
properties: { sources: {
|
|
20
|
-
type: "array",
|
|
21
|
-
description: "An array of allowed Zod import sources.",
|
|
22
|
-
items: {
|
|
23
|
-
type: "string",
|
|
24
|
-
enum: [...ZOD_IMPORT_SOURCES]
|
|
25
|
-
},
|
|
26
|
-
minItems: 1,
|
|
27
|
-
uniqueItems: true
|
|
28
|
-
} },
|
|
29
|
-
additionalProperties: false
|
|
30
|
-
}]
|
|
31
|
-
},
|
|
32
|
-
defaultOptions: [{ sources: ["zod/mini"] }],
|
|
33
|
-
create(context, [{ sources }]) {
|
|
34
|
-
return { ImportDeclaration(node) {
|
|
35
|
-
const sourceValue = node.source.value;
|
|
36
|
-
if (!sourceValue.startsWith("zod")) return;
|
|
37
|
-
if (sources.includes(sourceValue)) return;
|
|
38
|
-
context.report({
|
|
39
|
-
node,
|
|
40
|
-
messageId: "sourceNotAllowed",
|
|
41
|
-
data: {
|
|
42
|
-
source: sourceValue,
|
|
43
|
-
sources: sources.map((s) => `"${s}"`).join(", ")
|
|
44
|
-
},
|
|
45
|
-
suggest: sources.map((it) => ({
|
|
46
|
-
messageId: "replaceSource",
|
|
47
|
-
data: {
|
|
48
|
-
valid: it,
|
|
49
|
-
invalid: sourceValue
|
|
50
|
-
},
|
|
51
|
-
fix(fixer) {
|
|
52
|
-
return fixer.replaceText(node.source, node.source.raw.replace(sourceValue, it));
|
|
53
|
-
}
|
|
54
|
-
}))
|
|
55
|
-
});
|
|
56
|
-
} };
|
|
57
|
-
}
|
|
58
|
-
});
|
|
59
|
-
//#endregion
|
|
60
|
-
export { consistentImportSource };
|