@nest-boot/eslint-plugin 5.1.1

package/.eslintrc.js

@@ -0,0 +1,19 @@
+"use strict";
+
+module.exports = {
+  root: true,
+  extends: [
+    "eslint:recommended",
+    "plugin:eslint-plugin/recommended",
+    "plugin:node/recommended",
+  ],
+  env: {
+    node: true,
+  },
+  overrides: [
+    {
+      files: ["tests/**/*.js"],
+      env: { mocha: true },
+    },
+  ],
+};

package/README.md

@@ -0,0 +1,45 @@
+# eslint-plugin-nest-boot
+
+Nest Boot 定制规则
+
+## Installation
+
+You'll first need to install [ESLint](https://eslint.org/):
+
+```sh
+npm i eslint --save-dev
+```
+
+Next, install `eslint-plugin-nest-boot`:
+
+```sh
+npm install eslint-plugin-nest-boot --save-dev
+```
+
+## Usage
+
+Add `nest-boot` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+
+```json
+{
+  "plugins": ["nest-boot"]
+}
+```
+
+Then configure the rules you want to use under the rules section.
+
+```json
+{
+  "rules": {
+    "nest-boot/rule-name": 2
+  }
+}
+```
+
+## Rules
+
+<!-- begin auto-generated rules list -->
+
+TODO: Run eslint-doc-generator to generate the rules list.
+
+<!-- end auto-generated rules list -->

package/docs/rules/entity-property-no-optional-or-non-null-assertion.md

@@ -0,0 +1,31 @@
+# 实体字段不能使用可选属性和非空断言 (`entity-property-no-optional-or-non-null-assertion`)
+
+Please describe the origin of the rule here.
+
+## Rule Details
+
+This rule aims to...
+
+Examples of **incorrect** code for this rule:
+
+```js
+// fill me in
+```
+
+Examples of **correct** code for this rule:
+
+```js
+// fill me in
+```
+
+### Options
+
+If there are any options, describe them here. Otherwise, delete this section.
+
+## When Not To Use It
+
+Give a short description of when it would be appropriate to turn off this rule.
+
+## Further Reading
+
+If there are other links that describe the issue this rule addresses, please include them here in a bulleted list.

package/docs/rules/entity-property-nullable-type.md

@@ -0,0 +1,31 @@
+# 实体字段可为空时属性类型 (`entity-property-nullable-type`)
+
+Please describe the origin of the rule here.
+
+## Rule Details
+
+This rule aims to...
+
+Examples of **incorrect** code for this rule:
+
+```js
+// fill me in
+```
+
+Examples of **correct** code for this rule:
+
+```js
+// fill me in
+```
+
+### Options
+
+If there are any options, describe them here. Otherwise, delete this section.
+
+## When Not To Use It
+
+Give a short description of when it would be appropriate to turn off this rule.
+
+## Further Reading
+
+If there are other links that describe the issue this rule addresses, please include them here in a bulleted list.

package/lib/index.js

@@ -0,0 +1,22 @@
+/**
+ * @fileoverview Nest Boot 定制规则
+ * @author @nest-boot/eslint-plugin
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const requireIndex = require("requireindex");
+
+//------------------------------------------------------------------------------
+// Plugin Definition
+//------------------------------------------------------------------------------
+
+
+// import all rules in lib/rules
+module.exports.rules = requireIndex(__dirname + "/rules");
+
+
+

package/lib/rules/entity-property-no-optional-or-non-null-assertion.js

@@ -0,0 +1,58 @@
+/**
+ * @fileoverview 实体字段不能使用可选属性和非空断言
+ * @author 实体字段不能使用可选属性和非空断言
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: null, // `problem`, `suggestion`, or `layout`
+    docs: {
+      description: "实体字段不能使用可选属性和非空断言",
+      recommended: false,
+      url: null, // URL to the documentation page for this rule
+    },
+    fixable: null, // Or `code` or `whitespace`
+    schema: [], // Add a schema if the rule has options
+  },
+
+  create(context) {
+    return {
+      ClassDeclaration(node) {
+        // 检查是否有 @Entity 装饰器
+        if (
+          node.decorators &&
+          node.decorators.some(
+            (decorator) => decorator.expression.callee.name === "Entity",
+          )
+        ) {
+          // 遍历类属性
+          node.body.body.forEach((property) => {
+            // 检查是否有 @Property、@ManyToOne 或 @PrimaryKey 装饰器
+            if (
+              property.type === "PropertyDefinition" &&
+              property.decorators &&
+              property.decorators.some((decorator) => {
+                return ["Property", "ManyToOne", "PrimaryKey"].includes(
+                  decorator.expression.callee.name,
+                );
+              })
+            ) {
+              if (property.optional || property.definite) {
+                context.report({
+                  node: property,
+                  message: "实体属性不能有 ? 或 ! 断言。",
+                });
+              }
+            }
+          });
+        }
+      },
+    };
+  },
+};

package/lib/rules/entity-property-nullable-type.js

@@ -0,0 +1,88 @@
+/**
+ * @fileoverview 实体字段可为空时属性类型
+ * @author 实体字段可为空时属性类型
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: null, // `problem`, `suggestion`, or `layout`
+    docs: {
+      description: "实体字段可为空时属性类型",
+      recommended: false,
+      url: null, // URL to the documentation page for this rule
+    },
+    fixable: null, // Or `code` or `whitespace`
+    schema: [], // Add a schema if the rule has options
+  },
+
+  create(context) {
+    // variables should be defined here
+
+    //----------------------------------------------------------------------
+    // Helpers
+    //----------------------------------------------------------------------
+
+    // any helper functions should go here or else delete this section
+
+    //----------------------------------------------------------------------
+    // Public
+    //----------------------------------------------------------------------
+
+    return {
+      ClassDeclaration(node) {
+        // 检查是否有 @Entity 装饰器
+        if (
+          node.decorators &&
+          node.decorators.some(
+            (decorator) => decorator.expression.callee.name === "Entity",
+          )
+        ) {
+          // 遍历类属性
+          node.body.body.forEach((property) => {
+            // 检查是否有 @Property 装饰器
+            if (property.type === "PropertyDefinition" && property.decorators) {
+              const propertyDecorator = property.decorators.find(
+                (decorator) => decorator.expression.callee.name === "Property",
+              );
+
+              // 检查是否有 @Property(nullable: true) 装饰器
+              if (
+                propertyDecorator &&
+                propertyDecorator.expression.arguments[0] &&
+                propertyDecorator.expression.arguments[0].properties &&
+                propertyDecorator.expression.arguments[0].properties.some(
+                  (prop) =>
+                    prop.key.name === "nullable" &&
+                    prop.value.type === "Literal" &&
+                    prop.value.value === true,
+                )
+              ) {
+                // 检查属性类型是否包含 null
+                if (
+                  !property.typeAnnotation ||
+                  property.typeAnnotation.typeAnnotation.type !==
+                    "TSUnionType" ||
+                  !property.typeAnnotation.typeAnnotation.types.some(
+                    (type) => type.type === "TSNullKeyword",
+                  )
+                ) {
+                  context.report({
+                    node: property,
+                    message:
+                      "@Property({ nullable: true }) 属性类型需包含 null。",
+                  });
+                }
+              }
+            }
+          });
+        }
+      },
+    };
+  },
+};

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@nest-boot/eslint-plugin",
+  "version": "5.1.1",
+  "license": "MIT",
+  "main": "./lib/index.js",
+  "exports": "./lib/index.js",
+  "scripts": {
+    "lint": "npm-run-all \"lint:*\"",
+    "lint:eslint-docs": "npm-run-all \"update:eslint-docs -- --check\"",
+    "lint:js": "eslint .",
+    "test": "mocha tests --recursive",
+    "update:eslint-docs": "eslint-doc-generator"
+  },
+  "dependencies": {
+    "requireindex": "^1.2.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.19.0",
+    "eslint-doc-generator": "^1.0.0",
+    "eslint-plugin-eslint-plugin": "^5.0.0",
+    "eslint-plugin-node": "^11.1.0",
+    "mocha": "^10.0.0",
+    "npm-run-all": "^4.1.5"
+  },
+  "peerDependencies": {
+    "eslint": "^8.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  }
+}

package/tests/lib/rules/entity-property-no-optional-or-non-null-assertion.js

@@ -0,0 +1,31 @@
+/**
+ * @fileoverview 实体字段不能使用可选属性和非空断言
+ * @author 实体字段不能使用可选属性和非空断言
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require("../../../lib/rules/entity-property-no-optional-or-non-null-assertion"),
+  RuleTester = require("eslint").RuleTester;
+
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester();
+ruleTester.run("entity-property-no-optional-or-non-null-assertion", rule, {
+  valid: [
+    // give me some code that won't trigger a warning
+  ],
+
+  invalid: [
+    {
+      code: "",
+      errors: [{ message: "Fill me in.", type: "Me too" }],
+    },
+  ],
+});

package/tests/lib/rules/entity-property-nullable-type.js

@@ -0,0 +1,31 @@
+/**
+ * @fileoverview 实体字段可为空时属性类型
+ * @author 实体字段可为空时属性类型需要包含 null
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require("../../../lib/rules/entity-property-nullable-type"),
+  RuleTester = require("eslint").RuleTester;
+
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester();
+ruleTester.run("entity-property-nullable-type", rule, {
+  valid: [
+    // give me some code that won't trigger a warning
+  ],
+
+  invalid: [
+    {
+      code: "",
+      errors: [{ message: "Fill me in.", type: "Me too" }],
+    },
+  ],
+});