eslint-plugin-zod 1.0.0

package/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2022, Gajus Kuizinas (https://gajus.com/)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the Gajus Kuizinas (https://gajus.com/) nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL GAJUS KUIZINAS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,70 @@
+<a name="user-content-eslint-plugin-zod"></a>
+<a name="eslint-plugin-zod"></a>
+# eslint-plugin-zod
+
+[![Canonical Code Style](https://img.shields.io/badge/code%20style-canonical-blue.svg?style=flat-square)](https://github.com/gajus/canonical)
+[![NPM version](http://img.shields.io/npm/v/eslint-plugin-zod.svg?style=flat-square)](https://www.npmjs.org/package/eslint-plugin-zod)
+[![Twitter Follow](https://img.shields.io/twitter/follow/kuizinas.svg?style=social&label=Follow)](https://twitter.com/kuizinas)
+
+[Zod](https://github.com/colinhacks/zod) linting rules for ESLint.
+
+* [eslint-plugin-zod](#user-content-eslint-plugin-zod)
+    * [Installation](#user-content-eslint-plugin-zod-installation)
+    * [Configuration](#user-content-eslint-plugin-zod-configuration)
+    * [Rules](#user-content-eslint-plugin-zod-rules)
+        * [`require-strict`](#user-content-eslint-plugin-zod-rules-require-strict)
+
+
+<a name="user-content-eslint-plugin-zod-installation"></a>
+<a name="eslint-plugin-zod-installation"></a>
+## Installation
+
+1. Install [ESLint](https://www.github.com/eslint/eslint).
+1. Install [`eslint-plugin-zod`](https://github.com/gajus/eslint-plugin-zod) plugin.
+
+<!-- -->
+
+```sh
+npm install eslint --save-dev
+npm install eslint-plugin-zod --save-dev
+```
+
+<a name="user-content-eslint-plugin-zod-configuration"></a>
+<a name="eslint-plugin-zod-configuration"></a>
+## Configuration
+
+1. Add `plugins` section and specify `eslint-plugin-zod` as a plugin.
+1. Enable rules.
+
+<!-- -->
+
+```json
+{
+  "plugins": [
+    "zod"
+  ],
+  "rules": {
+    "zod/require-strict": [
+      2,
+    ],
+  }
+}
+
+```
+
+<a name="user-content-eslint-plugin-zod-rules"></a>
+<a name="eslint-plugin-zod-rules"></a>
+## Rules
+
+<!-- Rules are sorted alphabetically. -->
+
+<a name="user-content-eslint-plugin-zod-rules-require-strict"></a>
+<a name="eslint-plugin-zod-rules-require-strict"></a>
+### <code>require-strict</code>
+
+_The `--fix` option on the command line automatically fixes problems reported by this rule._
+
+Requires that objects are initialized with `.strict()`.
+
+
+

package/dist/src/index.d.ts

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

package/dist/src/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const requireStrict_1 = __importDefault(require("./rules/requireStrict"));
+const rules = {
+    'require-strict': requireStrict_1.default,
+};
+module.exports = {
+    rules,
+    rulesConfig: {
+        'require-strict': 0,
+    },
+};

package/dist/src/rules/requireStrict.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/requireStrict.js

@@ -0,0 +1,38 @@
+"use strict";
+const create = (context) => {
+    return {
+        CallExpression(node) {
+            var _a;
+            if (node.callee.object.name !== 'z') {
+                return;
+            }
+            if (node.callee.property.name !== 'object') {
+                return;
+            }
+            if (((_a = node.parent.property) === null || _a === void 0 ? void 0 : _a.name) !== 'strict') {
+                context.report({
+                    message: 'Add a strict() call to the schema.',
+                    node,
+                });
+            }
+        },
+    };
+};
+module.exports = {
+    create,
+    meta: {
+        docs: {
+            description: 'Requires that objects are initialized with .strict().',
+            url: 'https://github.com/gajus/eslint-plugin-zod#eslint-plugin-zod-rules-require-strict',
+        },
+        fixable: 'code',
+        schema: [
+            {
+                additionalProperties: false,
+                properties: {},
+                type: 'object',
+            },
+        ],
+        type: 'problem',
+    },
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "author": {
+    "email": "gajus@gajus.com",
+    "name": "Gajus Kuizinas",
+    "url": "http://gajus.com"
+  },
+  "description": "Zod linting rules for ESLint.",
+  "devDependencies": {
+    "@semantic-release/commit-analyzer": "^9.0.2",
+    "@semantic-release/github": "^8.0.6",
+    "@semantic-release/npm": "^9.0.1",
+    "@types/mocha": "^10.0.0",
+    "@types/node": "^18.11.9",
+    "eslint": "^8.27.0",
+    "eslint-config-canonical": "37.0.3",
+    "gitdown": "^3.1.5",
+    "glob": "^8.0.3",
+    "lodash": "^4.17.21",
+    "mocha": "^10.1.0",
+    "semantic-release": "^19.0.5",
+    "tsx": "^3.12.1",
+    "typescript": "^4.9.3"
+  },
+  "engines": {
+    "node": ">=12"
+  },
+  "keywords": [
+    "eslint",
+    "plugin",
+    "zod"
+  ],
+  "license": "BSD-3-Clause",
+  "main": "./dist/src/index.js",
+  "name": "eslint-plugin-zod",
+  "peerDependencies": {
+    "eslint": ">=8.1.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gajus/eslint-plugin-zod"
+  },
+  "scripts": {
+    "build": "npm run documentation && tsc",
+    "documentation": "gitdown ./.README/README.md --output-file ./README.md && npm run documentation-add-assertions",
+    "documentation-add-assertions": "tsx ./bin/readmeAssertions",
+    "lint": "eslint ./src ./test && tsc --noEmit",
+    "test": "mocha --require tsx test/**/*"
+  },
+  "version": "1.0.0"
+}

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "module": "commonjs",
+    "lib": [
+      "es2021"
+    ],
+    "moduleResolution": "node",
+    "noImplicitAny": false,
+    "noImplicitReturns": true,
+    "useUnknownInCatchVariables": false,
+    "outDir": "dist",
+    "skipLibCheck": true,
+    "strict": true,
+    "target": "es2018"
+  },
+  "exclude": [
+    "dist",
+    "node_modules"
+  ],
+  "include": [
+    "bin",
+    "src",
+    "test"
+  ]
+}