npm - @checkdigit/eslint-plugin - Versions diffs - 7.1.0 → 7.2.0-PR.79-490a - Mend

@checkdigit/eslint-plugin 7.1.0 → 7.2.0-PR.79-490a

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 (7) hide show

package/README.md CHANGED Viewed

@@ -18,6 +18,7 @@ Copyright (c) 2021-2024 [Check Digit, LLC](https://checkdigit.com)
 - `@checkdigit/no-full-response`
 - `@checkdigit/require-resolve-full-response`
 - `@checkdigit/require-type-out-of-type-only-imports`
+- `@checkdigit/no-enum`
 ## Configurations

package/dist-mjs/index.mjs CHANGED Viewed

@@ -14,6 +14,7 @@ import requireTypeOutOfTypeOnlyImports, {
 } from "./require-type-out-of-type-only-imports.mjs";
 import filePathComment from "./file-path-comment.mjs";
 import noCardNumbers from "./no-card-numbers.mjs";
+import noEnum from "./no-enum.mjs";
 import noTestImport from "./no-test-import.mjs";
 import noUuid from "./no-uuid.mjs";
 import noWallabyComment from "./no-wallaby-comment.mjs";
@@ -24,6 +25,7 @@ import requireStrictAssert from "./require-strict-assert.mjs";
 var rules = {
   "file-path-comment": filePathComment,
   "no-card-numbers": noCardNumbers,
+  "no-enum": noEnum,
   "no-uuid": noUuid,
   "require-strict-assert": requireStrictAssert,
   "no-test-import": noTestImport,
@@ -49,6 +51,7 @@ var configs = {
     },
     rules: {
       "@checkdigit/no-card-numbers": "error",
+      "@checkdigit/no-enum": "error",
       "@checkdigit/file-path-comment": "error",
       "@checkdigit/no-uuid": "error",
       "@checkdigit/require-strict-assert": "error",
@@ -72,6 +75,7 @@ var configs = {
     },
     rules: {
       "@checkdigit/no-card-numbers": "error",
+      "@checkdigit/no-enum": "error",
       "@checkdigit/file-path-comment": "off",
       "@checkdigit/no-uuid": "error",
       "@checkdigit/require-strict-assert": "error",
@@ -93,4 +97,4 @@ var src_default = pluginToExport;
 export {
   src_default as default
 };
-//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2luZGV4LnRzIl0sCiAgIm1hcHBpbmdzIjogIjtBQVVBLE9BQU8sd0JBQXdCLFVBQVUsa0NBQWtDO0FBQzNFLE9BQU8sdUJBQXVCLFVBQVUsaUNBQWlDO0FBQ3pFLE9BQU8sa0JBQWtCLFVBQVUsNEJBQTRCO0FBQy9ELE9BQU8sMkJBQTJCLFVBQVUscUNBQXFDO0FBQ2pGLE9BQU87QUFBQSxFQUNMLFVBQVU7QUFBQSxPQUNMO0FBQ1AsT0FBTztBQUFBLEVBQ0wsVUFBVTtBQUFBLE9BQ0w7QUFDUCxPQUFPO0FBQUEsRUFDTCxVQUFVO0FBQUEsT0FDTDtBQUNQLE9BQU8scUJBQXFCO0FBQzVCLE9BQU8sbUJBQW1CO0FBQzFCLE9BQU8sa0JBQWtCO0FBQ3pCLE9BQU8sWUFBWTtBQUNuQixPQUFPLHNCQUFzQjtBQUM3QixPQUFPLDJCQUEyQjtBQUNsQyxPQUFPLGtCQUFrQjtBQUN6QixPQUFPLHlDQUF5QztBQUNoRCxPQUFPLHlCQUF5QjtBQUVoQyxJQUFNLFFBQXNEO0FBQUEsRUFDMUQscUJBQXFCO0FBQUEsRUFDckIsbUJBQW1CO0FBQUEsRUFDbkIsV0FBVztBQUFBLEVBQ1gseUJBQXlCO0FBQUEsRUFDekIsa0JBQWtCO0FBQUEsRUFDbEIsc0JBQXNCO0FBQUEsRUFDdEIsOEJBQThCO0FBQUEsRUFDOUIsMkNBQTJDO0FBQUEsRUFDM0MsMkJBQTJCO0FBQUEsRUFDM0IsQ0FBQywwQkFBMEIsR0FBRztBQUFBLEVBQzlCLENBQUMsNkJBQTZCLEdBQUc7QUFBQSxFQUNqQyxDQUFDLG9CQUFvQixHQUFHO0FBQUEsRUFDeEIsQ0FBQyxnQ0FBZ0MsR0FBRztBQUFBLEVBQ3BDLENBQUMscUNBQXFDLEdBQUc7QUFBQSxFQUN6QyxDQUFDLHlCQUF5QixHQUFHO0FBQUEsRUFDN0IsQ0FBQyxnQ0FBZ0MsR0FBRztBQUN0QztBQUVBLElBQU0sU0FBcUM7QUFBQSxFQUN6QztBQUNGO0FBRUEsSUFBTSxVQUFzRDtBQUFBLEVBQzFELEtBQUs7QUFBQSxJQUNILFNBQVM7QUFBQSxNQUNQLGVBQWU7QUFBQSxJQUNqQjtBQUFBLElBQ0EsT0FBTztBQUFBLE1BQ0wsK0JBQStCO0FBQUEsTUFDL0IsaUNBQWlDO0FBQUEsTUFDakMsdUJBQXVCO0FBQUEsTUFDdkIscUNBQXFDO0FBQUEsTUFDckMsa0NBQWtDO0FBQUEsTUFDbEMsMENBQTBDO0FBQUEsTUFDMUMsdURBQXVEO0FBQUEsTUFDdkQsdUNBQXVDO0FBQUEsTUFDdkMsOEJBQThCO0FBQUEsTUFDOUIsQ0FBQyxlQUFlLDBCQUEwQixFQUFFLEdBQUc7QUFBQSxNQUMvQyxDQUFDLGVBQWUsNkJBQTZCLEVBQUUsR0FBRztBQUFBLE1BQ2xELENBQUMsZUFBZSxvQkFBb0IsRUFBRSxHQUFHO0FBQUEsTUFDekMsQ0FBQyxlQUFlLGdDQUFnQyxFQUFFLEdBQUc7QUFBQSxNQUNyRCxDQUFDLGVBQWUscUNBQXFDLEVBQUUsR0FBRztBQUFBLE1BQzFELENBQUMsZUFBZSx5QkFBeUIsRUFBRSxHQUFHO0FBQUEsTUFDOUMsQ0FBQyxlQUFlLGdDQUFnQyxFQUFFLEdBQUc7QUFBQSxJQUN2RDtBQUFBLEVBQ0Y7QUFBQSxFQUNBLGFBQWE7QUFBQSxJQUNYLFNBQVM7QUFBQSxNQUNQLGVBQWU7QUFBQSxJQUNqQjtBQUFBLElBQ0EsT0FBTztBQUFBLE1BQ0wsK0JBQStCO0FBQUEsTUFDL0IsaUNBQWlDO0FBQUEsTUFDakMsdUJBQXVCO0FBQUEsTUFDdkIscUNBQXFDO0FBQUEsTUFDckMsa0NBQWtDO0FBQUEsTUFDbEMsMENBQTBDO0FBQUEsTUFDMUMsdURBQXVEO0FBQUEsTUFDdkQsdUNBQXVDO0FBQUEsTUFDdkMsOEJBQThCO0FBQUEsTUFDOUIsQ0FBQyxlQUFlLDBCQUEwQixFQUFFLEdBQUc7QUFBQSxNQUMvQyxDQUFDLGVBQWUsNkJBQTZCLEVBQUUsR0FBRztBQUFBLElBQ3BEO0FBQUEsRUFDRjtBQUNGO0FBRUEsSUFBTSxpQkFBNkM7QUFBQSxFQUNqRCxHQUFHO0FBQUEsRUFDSDtBQUNGO0FBQ0EsSUFBTyxjQUFROyIsCiAgIm5hbWVzIjogW10KfQo=
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2luZGV4LnRzIl0sCiAgIm1hcHBpbmdzIjogIjtBQVVBLE9BQU8sd0JBQXdCLFVBQVUsa0NBQWtDO0FBQzNFLE9BQU8sdUJBQXVCLFVBQVUsaUNBQWlDO0FBQ3pFLE9BQU8sa0JBQWtCLFVBQVUsNEJBQTRCO0FBQy9ELE9BQU8sMkJBQTJCLFVBQVUscUNBQXFDO0FBQ2pGLE9BQU87QUFBQSxFQUNMLFVBQVU7QUFBQSxPQUNMO0FBQ1AsT0FBTztBQUFBLEVBQ0wsVUFBVTtBQUFBLE9BQ0w7QUFDUCxPQUFPO0FBQUEsRUFDTCxVQUFVO0FBQUEsT0FDTDtBQUNQLE9BQU8scUJBQXFCO0FBQzVCLE9BQU8sbUJBQW1CO0FBQzFCLE9BQU8sWUFBWTtBQUNuQixPQUFPLGtCQUFrQjtBQUN6QixPQUFPLFlBQVk7QUFDbkIsT0FBTyxzQkFBc0I7QUFDN0IsT0FBTywyQkFBMkI7QUFDbEMsT0FBTyxrQkFBa0I7QUFDekIsT0FBTyx5Q0FBeUM7QUFDaEQsT0FBTyx5QkFBeUI7QUFFaEMsSUFBTSxRQUFzRDtBQUFBLEVBQzFELHFCQUFxQjtBQUFBLEVBQ3JCLG1CQUFtQjtBQUFBLEVBQ25CLFdBQVc7QUFBQSxFQUNYLFdBQVc7QUFBQSxFQUNYLHlCQUF5QjtBQUFBLEVBQ3pCLGtCQUFrQjtBQUFBLEVBQ2xCLHNCQUFzQjtBQUFBLEVBQ3RCLDhCQUE4QjtBQUFBLEVBQzlCLDJDQUEyQztBQUFBLEVBQzNDLDJCQUEyQjtBQUFBLEVBQzNCLENBQUMsMEJBQTBCLEdBQUc7QUFBQSxFQUM5QixDQUFDLDZCQUE2QixHQUFHO0FBQUEsRUFDakMsQ0FBQyxvQkFBb0IsR0FBRztBQUFBLEVBQ3hCLENBQUMsZ0NBQWdDLEdBQUc7QUFBQSxFQUNwQyxDQUFDLHFDQUFxQyxHQUFHO0FBQUEsRUFDekMsQ0FBQyx5QkFBeUIsR0FBRztBQUFBLEVBQzdCLENBQUMsZ0NBQWdDLEdBQUc7QUFDdEM7QUFFQSxJQUFNLFNBQXFDO0FBQUEsRUFDekM7QUFDRjtBQUVBLElBQU0sVUFBc0Q7QUFBQSxFQUMxRCxLQUFLO0FBQUEsSUFDSCxTQUFTO0FBQUEsTUFDUCxlQUFlO0FBQUEsSUFDakI7QUFBQSxJQUNBLE9BQU87QUFBQSxNQUNMLCtCQUErQjtBQUFBLE1BQy9CLHVCQUF1QjtBQUFBLE1BQ3ZCLGlDQUFpQztBQUFBLE1BQ2pDLHVCQUF1QjtBQUFBLE1BQ3ZCLHFDQUFxQztBQUFBLE1BQ3JDLGtDQUFrQztBQUFBLE1BQ2xDLDBDQUEwQztBQUFBLE1BQzFDLHVEQUF1RDtBQUFBLE1BQ3ZELHVDQUF1QztBQUFBLE1BQ3ZDLDhCQUE4QjtBQUFBLE1BQzlCLENBQUMsZUFBZSwwQkFBMEIsRUFBRSxHQUFHO0FBQUEsTUFDL0MsQ0FBQyxlQUFlLDZCQUE2QixFQUFFLEdBQUc7QUFBQSxNQUNsRCxDQUFDLGVBQWUsb0JBQW9CLEVBQUUsR0FBRztBQUFBLE1BQ3pDLENBQUMsZUFBZSxnQ0FBZ0MsRUFBRSxHQUFHO0FBQUEsTUFDckQsQ0FBQyxlQUFlLHFDQUFxQyxFQUFFLEdBQUc7QUFBQSxNQUMxRCxDQUFDLGVBQWUseUJBQXlCLEVBQUUsR0FBRztBQUFBLE1BQzlDLENBQUMsZUFBZSxnQ0FBZ0MsRUFBRSxHQUFHO0FBQUEsSUFDdkQ7QUFBQSxFQUNGO0FBQUEsRUFDQSxhQUFhO0FBQUEsSUFDWCxTQUFTO0FBQUEsTUFDUCxlQUFlO0FBQUEsSUFDakI7QUFBQSxJQUNBLE9BQU87QUFBQSxNQUNMLCtCQUErQjtBQUFBLE1BQy9CLHVCQUF1QjtBQUFBLE1BQ3ZCLGlDQUFpQztBQUFBLE1BQ2pDLHVCQUF1QjtBQUFBLE1BQ3ZCLHFDQUFxQztBQUFBLE1BQ3JDLGtDQUFrQztBQUFBLE1BQ2xDLDBDQUEwQztBQUFBLE1BQzFDLHVEQUF1RDtBQUFBLE1BQ3ZELHVDQUF1QztBQUFBLE1BQ3ZDLDhCQUE4QjtBQUFBLE1BQzlCLENBQUMsZUFBZSwwQkFBMEIsRUFBRSxHQUFHO0FBQUEsTUFDL0MsQ0FBQyxlQUFlLDZCQUE2QixFQUFFLEdBQUc7QUFBQSxJQUNwRDtBQUFBLEVBQ0Y7QUFDRjtBQUVBLElBQU0saUJBQTZDO0FBQUEsRUFDakQsR0FBRztBQUFBLEVBQ0g7QUFDRjtBQUNBLElBQU8sY0FBUTsiLAogICJuYW1lcyI6IFtdCn0K

package/dist-mjs/no-enum.mjs ADDED Viewed

@@ -0,0 +1,52 @@
+// src/no-enum.ts
+import { ESLintUtils, TSESTree } from "@typescript-eslint/utils";
+var ruleId = "no-enum";
+var NO_ENUM = "NO_ENUM";
+var createRule = ESLintUtils.RuleCreator((name) => name);
+function isJsonSchemaProperty(node) {
+  if (!node) {
+    return false;
+  }
+  if (node.type === TSESTree.AST_NODE_TYPES.Property && node.key.type === TSESTree.AST_NODE_TYPES.Identifier && node.key.name === "properties") {
+    return true;
+  }
+  return isJsonSchemaProperty(node.parent);
+}
+var rule = createRule({
+  name: ruleId,
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Disallow the use of `enum` in TypeScript"
+    },
+    schema: [],
+    messages: {
+      [NO_ENUM]: "Avoid using `enum` in TypeScript."
+    }
+  },
+  defaultOptions: [],
+  create(context) {
+    return {
+      TSEnumDeclaration(node) {
+        context.report({
+          node,
+          messageId: NO_ENUM
+        });
+      },
+      Property(node) {
+        if (node.key.type === TSESTree.AST_NODE_TYPES.Identifier && node.key.name === "enum" && node.value.type === TSESTree.AST_NODE_TYPES.ArrayExpression && !isJsonSchemaProperty(node.parent)) {
+          context.report({
+            node,
+            messageId: NO_ENUM
+          });
+        }
+      }
+    };
+  }
+});
+var no_enum_default = rule;
+export {
+  no_enum_default as default,
+  ruleId
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL25vLWVudW0udHMiXSwKICAibWFwcGluZ3MiOiAiO0FBUUEsU0FBUyxhQUFhLGdCQUFnQjtBQUUvQixJQUFNLFNBQVM7QUFDdEIsSUFBTSxVQUFVO0FBRWhCLElBQU0sYUFBYSxZQUFZLFlBQVksQ0FBQyxTQUFTLElBQUk7QUFFekQsU0FBUyxxQkFBcUIsTUFBK0I7QUFDM0QsTUFBSSxDQUFDLE1BQU07QUFDVCxXQUFPO0FBQUEsRUFDVDtBQUNBLE1BQ0UsS0FBSyxTQUFTLFNBQVMsZUFBZSxZQUN0QyxLQUFLLElBQUksU0FBUyxTQUFTLGVBQWUsY0FDMUMsS0FBSyxJQUFJLFNBQVMsY0FDbEI7QUFDQSxXQUFPO0FBQUEsRUFDVDtBQUNBLFNBQU8scUJBQXFCLEtBQUssTUFBTTtBQUN6QztBQUVBLElBQU0sT0FBK0MsV0FBVztBQUFBLEVBQzlELE1BQU07QUFBQSxFQUNOLE1BQU07QUFBQSxJQUNKLE1BQU07QUFBQSxJQUNOLE1BQU07QUFBQSxNQUNKLGFBQWE7QUFBQSxJQUNmO0FBQUEsSUFDQSxRQUFRLENBQUM7QUFBQSxJQUNULFVBQVU7QUFBQSxNQUNSLENBQUMsT0FBTyxHQUFHO0FBQUEsSUFDYjtBQUFBLEVBQ0Y7QUFBQSxFQUNBLGdCQUFnQixDQUFDO0FBQUEsRUFDakIsT0FBTyxTQUFTO0FBQ2QsV0FBTztBQUFBLE1BQ0wsa0JBQWtCLE1BQWtDO0FBQ2xELGdCQUFRLE9BQU87QUFBQSxVQUNiO0FBQUEsVUFDQSxXQUFXO0FBQUEsUUFDYixDQUFDO0FBQUEsTUFDSDtBQUFBLE1BQ0EsU0FBUyxNQUF5QjtBQUNoQyxZQUNFLEtBQUssSUFBSSxTQUFTLFNBQVMsZUFBZSxjQUMxQyxLQUFLLElBQUksU0FBUyxVQUNsQixLQUFLLE1BQU0sU0FBUyxTQUFTLGVBQWUsbUJBQzVDLENBQUMscUJBQXFCLEtBQUssTUFBTSxHQUNqQztBQUNBLGtCQUFRLE9BQU87QUFBQSxZQUNiO0FBQUEsWUFDQSxXQUFXO0FBQUEsVUFDYixDQUFDO0FBQUEsUUFDSDtBQUFBLE1BQ0Y7QUFBQSxJQUNGO0FBQUEsRUFDRjtBQUNGLENBQUM7QUFFRCxJQUFPLGtCQUFROyIsCiAgIm5hbWVzIjogW10KfQo=

package/dist-types/no-enum.d.ts ADDED Viewed

@@ -0,0 +1,5 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const ruleId = "no-enum";
+declare const NO_ENUM = "NO_ENUM";
+declare const rule: ESLintUtils.RuleModule<typeof NO_ENUM>;
+export default rule;

package/package.json CHANGED Viewed

@@ -1,96 +1 @@
-{
-  "name": "@checkdigit/eslint-plugin",
-  "version": "7.1.0",
-  "description": "Check Digit eslint plugins",
-  "keywords": [
-    "eslint",
-    "eslintplugin"
-  ],
-  "homepage": "https://github.com/checkdigit/eslint-plugin#readme",
-  "bugs": {
-    "url": "https://github.com/checkdigit/eslint-plugin/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/checkdigit/eslint-plugin"
-  },
-  "license": "MIT",
-  "author": "Check Digit, LLC",
-  "sideEffects": false,
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./dist-types/index.d.ts",
-      "import": "./dist-mjs/index.mjs",
-      "default": "./dist-mjs/index.mjs"
-    }
-  },
-  "files": [
-    "src",
-    "dist-types",
-    "dist-mjs",
-    "!src/**/test/**",
-    "!src/**/*.test.ts",
-    "!src/**/*.spec.ts",
-    "!dist-types/**/test/**",
-    "!dist-types/**/*.test.d.ts",
-    "!dist-types/**/*.spec.d.ts",
-    "!dist-mjs/**/test/**",
-    "!dist-mjs/**/*.test.mjs",
-    "!dist-mjs/**/*.spec.mjs",
-    "SECURITY.md"
-  ],
-  "scripts": {
-    "build:dist-mjs": "rimraf dist-mjs && npx builder --type=module --sourceMap --outDir=dist-mjs && node dist-mjs/index.mjs",
-    "build:dist-types": "rimraf dist-types && npx builder --type=types --outDir=dist-types",
-    "ci:compile": "tsc --noEmit",
-    "ci:coverage": "NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=true",
-    "ci:lint": "npm run lint",
-    "ci:style": "npm run prettier",
-    "ci:test": "NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=false",
-    "lint": "eslint --max-warnings 0 .",
-    "lint:fix": "eslint --max-warnings 0 --fix .",
-    "prepare": "",
-    "prepublishOnly": "npm run build:dist-types && npm run build:dist-mjs",
-    "prettier": "prettier --ignore-path .gitignore --list-different .",
-    "prettier:fix": "prettier --ignore-path .gitignore --write .",
-    "test": "npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style"
-  },
-  "prettier": "@checkdigit/prettier-config",
-  "jest": {
-    "preset": "@checkdigit/jest-config"
-  },
-  "dependencies": {
-    "@typescript-eslint/type-utils": "^8.10.0",
-    "@typescript-eslint/utils": "^8.10.0",
-    "ts-api-utils": "^1.3.0"
-  },
-  "devDependencies": {
-    "@checkdigit/jest-config": "^6.0.2",
-    "@checkdigit/prettier-config": "^5.5.1",
-    "@checkdigit/typescript-config": "^8.0.0",
-    "@eslint/js": "^9.13.0",
-    "@types/eslint": "^9.6.1",
-    "@types/eslint-config-prettier": "^6.11.3",
-    "@typescript-eslint/parser": "^8.10.0",
-    "@typescript-eslint/rule-tester": "^8.10.0",
-    "eslint": "^9.13.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-import-resolver-typescript": "^3.6.3",
-    "eslint-plugin-eslint-plugin": "^6.2.0",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-no-only-tests": "^3.3.0",
-    "eslint-plugin-no-secrets": "^1.0.2",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-sonarjs": "1.0.4",
-    "http-status-codes": "^2.3.0",
-    "rimraf": "^6.0.1",
-    "typescript-eslint": "^8.10.0"
-  },
-  "peerDependencies": {
-    "eslint": ">=9 <10"
-  },
-  "engines": {
-    "node": ">=20.17"
-  }
-}
+{"name":"@checkdigit/eslint-plugin","version":"7.2.0-PR.79-490a","description":"Check Digit eslint plugins","keywords":["eslint","eslintplugin"],"homepage":"https://github.com/checkdigit/eslint-plugin#readme","bugs":{"url":"https://github.com/checkdigit/eslint-plugin/issues"},"repository":{"type":"git","url":"https://github.com/checkdigit/eslint-plugin"},"license":"MIT","author":"Check Digit, LLC","sideEffects":false,"type":"module","exports":{".":{"types":"./dist-types/index.d.ts","import":"./dist-mjs/index.mjs","default":"./dist-mjs/index.mjs"}},"files":["src","dist-types","dist-mjs","!src/**/test/**","!src/**/*.test.ts","!src/**/*.spec.ts","!dist-types/**/test/**","!dist-types/**/*.test.d.ts","!dist-types/**/*.spec.d.ts","!dist-mjs/**/test/**","!dist-mjs/**/*.test.mjs","!dist-mjs/**/*.spec.mjs","SECURITY.md"],"scripts":{"build:dist-mjs":"rimraf dist-mjs && npx builder --type=module --sourceMap --outDir=dist-mjs && node dist-mjs/index.mjs","build:dist-types":"rimraf dist-types && npx builder --type=types --outDir=dist-types","ci:compile":"tsc --noEmit","ci:coverage":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=true","ci:lint":"npm run lint","ci:style":"npm run prettier","ci:test":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=false","lint":"eslint --max-warnings 0 .","lint:fix":"eslint --max-warnings 0 --fix .","prepare":"","prepublishOnly":"npm run build:dist-types && npm run build:dist-mjs","prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","test":"npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style"},"prettier":"@checkdigit/prettier-config","jest":{"preset":"@checkdigit/jest-config"},"dependencies":{"@typescript-eslint/type-utils":"^8.10.0","@typescript-eslint/utils":"^8.10.0","ts-api-utils":"^1.3.0"},"devDependencies":{"@checkdigit/jest-config":"^6.0.2","@checkdigit/prettier-config":"^5.5.1","@checkdigit/typescript-config":"^8.0.0","@eslint/js":"^9.13.0","@types/eslint":"^9.6.1","@types/eslint-config-prettier":"^6.11.3","@typescript-eslint/parser":"^8.10.0","@typescript-eslint/rule-tester":"^8.10.0","eslint":"^9.13.0","eslint-config-prettier":"^9.1.0","eslint-import-resolver-typescript":"^3.6.3","eslint-plugin-eslint-plugin":"^6.2.0","eslint-plugin-import":"^2.31.0","eslint-plugin-no-only-tests":"^3.3.0","eslint-plugin-no-secrets":"^1.0.2","eslint-plugin-node":"^11.1.0","eslint-plugin-sonarjs":"1.0.4","http-status-codes":"^2.3.0","rimraf":"^6.0.1","typescript-eslint":"^8.10.0"},"peerDependencies":{"eslint":">=9 <10"},"engines":{"node":">=20.17"}}

package/src/index.ts CHANGED Viewed

@@ -23,6 +23,7 @@ import requireTypeOutOfTypeOnlyImports, {
 } from './require-type-out-of-type-only-imports';
 import filePathComment from './file-path-comment';
 import noCardNumbers from './no-card-numbers';
+import noEnum from './no-enum';
 import noTestImport from './no-test-import';
 import noUuid from './no-uuid';
 import noWallabyComment from './no-wallaby-comment';
@@ -34,6 +35,7 @@ import requireStrictAssert from './require-strict-assert';
 const rules: Record<string, TSESLint.LooseRuleDefinition> = {
   'file-path-comment': filePathComment,
   'no-card-numbers': noCardNumbers,
+  'no-enum': noEnum,
   'no-uuid': noUuid,
   'require-strict-assert': requireStrictAssert,
   'no-test-import': noTestImport,
@@ -61,6 +63,7 @@ const configs: Record<string, TSESLint.FlatConfig.Config> = {
     },
     rules: {
       '@checkdigit/no-card-numbers': 'error',
+      '@checkdigit/no-enum': 'error',
       '@checkdigit/file-path-comment': 'error',
       '@checkdigit/no-uuid': 'error',
       '@checkdigit/require-strict-assert': 'error',
@@ -84,6 +87,7 @@ const configs: Record<string, TSESLint.FlatConfig.Config> = {
     },
     rules: {
       '@checkdigit/no-card-numbers': 'error',
+      '@checkdigit/no-enum': 'error',
       '@checkdigit/file-path-comment': 'off',
       '@checkdigit/no-uuid': 'error',
       '@checkdigit/require-strict-assert': 'error',

package/src/no-enum.ts ADDED Viewed

@@ -0,0 +1,68 @@
+// no-enum.ts
+/*
+ * Copyright (c) 2021-2024 Check Digit, LLC
+ *
+ * This code is licensed under the MIT license (see LICENSE.txt for details).
+ */
+import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';
+export const ruleId = 'no-enum';
+const NO_ENUM = 'NO_ENUM';
+const createRule = ESLintUtils.RuleCreator((name) => name);
+function isJsonSchemaProperty(node?: TSESTree.Node): boolean {
+  if (!node) {
+    return false;
+  }
+  if (
+    node.type === TSESTree.AST_NODE_TYPES.Property &&
+    node.key.type === TSESTree.AST_NODE_TYPES.Identifier &&
+    node.key.name === 'properties'
+  ) {
+    return true;
+  }
+  return isJsonSchemaProperty(node.parent);
+}
+const rule: ESLintUtils.RuleModule<typeof NO_ENUM> = createRule({
+  name: ruleId,
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Disallow the use of `enum` in TypeScript',
+    },
+    schema: [],
+    messages: {
+      [NO_ENUM]: 'Avoid using `enum` in TypeScript.',
+    },
+  },
+  defaultOptions: [],
+  create(context) {
+    return {
+      TSEnumDeclaration(node: TSESTree.TSEnumDeclaration) {
+        context.report({
+          node,
+          messageId: NO_ENUM,
+        });
+      },
+      Property(node: TSESTree.Property) {
+        if (
+          node.key.type === TSESTree.AST_NODE_TYPES.Identifier &&
+          node.key.name === 'enum' &&
+          node.value.type === TSESTree.AST_NODE_TYPES.ArrayExpression &&
+          !isJsonSchemaProperty(node.parent)
+        ) {
+          context.report({
+            node,
+            messageId: NO_ENUM,
+          });
+        }
+      },
+    };
+  },
+});
+export default rule;