@checkdigit/eslint-plugin 7.2.0-PR.66-49d4 → 7.2.0-PR.79-490a

package/README.md

@@ -13,12 +13,12 @@ Copyright (c) 2021-2024 [Check Digit, LLC](https://checkdigit.com)
 - `@checkdigit/require-assert-predicate-rejects-throws`
 - `@checkdigit/object-literal-response`
 - `@checkdigit/no-test-import`
-- `@checkdigit/no-side-effects`
 - `@checkdigit/no-promise-instance-method`
 - `@checkdigit/invalid-json-stringify`
 - `@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

@@ -14,7 +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 noSideEffects from "./no-side-effects.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";
@@ -25,11 +25,11 @@ 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,
   "no-wallaby-comment": noWallabyComment,
-  "no-side-effects": noSideEffects,
   "regular-expression-comment": regexComment,
   "require-assert-predicate-rejects-throws": requireAssertPredicateRejectsThrows,
   "object-literal-response": objectLiteralResponse,
@@ -51,11 +51,11 @@ 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",
       "@checkdigit/no-wallaby-comment": "error",
-      "@checkdigit/no-side-effects": ["error", { excludedIdentifiers: ["assert", "debug", "log", "promisify"] }],
       "@checkdigit/regular-expression-comment": "error",
       "@checkdigit/require-assert-predicate-rejects-throws": "error",
       "@checkdigit/object-literal-response": "error",
@@ -75,11 +75,11 @@ 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",
       "@checkdigit/no-wallaby-comment": "off",
-      "@checkdigit/no-side-effects": "error",
       "@checkdigit/regular-expression-comment": "error",
       "@checkdigit/require-assert-predicate-rejects-throws": "error",
       "@checkdigit/object-literal-response": "error",
@@ -97,4 +97,4 @@ var src_default = pluginToExport;
 export {
   src_default as default
 };
-//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2luZGV4LnRzIl0sCiAgIm1hcHBpbmdzIjogIjtBQVVBLE9BQU8sd0JBQXdCLFVBQVUsa0NBQWtDO0FBQzNFLE9BQU8sdUJBQXVCLFVBQVUsaUNBQWlDO0FBQ3pFLE9BQU8sa0JBQWtCLFVBQVUsNEJBQTRCO0FBQy9ELE9BQU8sMkJBQTJCLFVBQVUscUNBQXFDO0FBQ2pGLE9BQU87QUFBQSxFQUNMLFVBQVU7QUFBQSxPQUNMO0FBQ1AsT0FBTztBQUFBLEVBQ0wsVUFBVTtBQUFBLE9BQ0w7QUFDUCxPQUFPO0FBQUEsRUFDTCxVQUFVO0FBQUEsT0FDTDtBQUNQLE9BQU8scUJBQXFCO0FBQzVCLE9BQU8sbUJBQW1CO0FBQzFCLE9BQU8sbUJBQW1CO0FBQzFCLE9BQU8sa0JBQWtCO0FBQ3pCLE9BQU8sWUFBWTtBQUNuQixPQUFPLHNCQUFzQjtBQUM3QixPQUFPLDJCQUEyQjtBQUNsQyxPQUFPLGtCQUFrQjtBQUN6QixPQUFPLHlDQUF5QztBQUNoRCxPQUFPLHlCQUF5QjtBQUVoQyxJQUFNLFFBQXNEO0FBQUEsRUFDMUQscUJBQXFCO0FBQUEsRUFDckIsbUJBQW1CO0FBQUEsRUFDbkIsV0FBVztBQUFBLEVBQ1gseUJBQXlCO0FBQUEsRUFDekIsa0JBQWtCO0FBQUEsRUFDbEIsc0JBQXNCO0FBQUEsRUFDdEIsbUJBQW1CO0FBQUEsRUFDbkIsOEJBQThCO0FBQUEsRUFDOUIsMkNBQTJDO0FBQUEsRUFDM0MsMkJBQTJCO0FBQUEsRUFDM0IsQ0FBQywwQkFBMEIsR0FBRztBQUFBLEVBQzlCLENBQUMsNkJBQTZCLEdBQUc7QUFBQSxFQUNqQyxDQUFDLG9CQUFvQixHQUFHO0FBQUEsRUFDeEIsQ0FBQyxnQ0FBZ0MsR0FBRztBQUFBLEVBQ3BDLENBQUMscUNBQXFDLEdBQUc7QUFBQSxFQUN6QyxDQUFDLHlCQUF5QixHQUFHO0FBQUEsRUFDN0IsQ0FBQyxnQ0FBZ0MsR0FBRztBQUN0QztBQUVBLElBQU0sU0FBcUM7QUFBQSxFQUN6QztBQUNGO0FBRUEsSUFBTSxVQUFzRDtBQUFBLEVBQzFELEtBQUs7QUFBQSxJQUNILFNBQVM7QUFBQSxNQUNQLGVBQWU7QUFBQSxJQUNqQjtBQUFBLElBQ0EsT0FBTztBQUFBLE1BQ0wsK0JBQStCO0FBQUEsTUFDL0IsaUNBQWlDO0FBQUEsTUFDakMsdUJBQXVCO0FBQUEsTUFDdkIscUNBQXFDO0FBQUEsTUFDckMsa0NBQWtDO0FBQUEsTUFDbEMsK0JBQStCLENBQUMsU0FBUyxFQUFFLHFCQUFxQixDQUFDLFVBQVUsU0FBUyxPQUFPLFdBQVcsRUFBRSxDQUFDO0FBQUEsTUFDekcsMENBQTBDO0FBQUEsTUFDMUMsdURBQXVEO0FBQUEsTUFDdkQsdUNBQXVDO0FBQUEsTUFDdkMsOEJBQThCO0FBQUEsTUFDOUIsQ0FBQyxlQUFlLDBCQUEwQixFQUFFLEdBQUc7QUFBQSxNQUMvQyxDQUFDLGVBQWUsNkJBQTZCLEVBQUUsR0FBRztBQUFBLE1BQ2xELENBQUMsZUFBZSxvQkFBb0IsRUFBRSxHQUFHO0FBQUEsTUFDekMsQ0FBQyxlQUFlLGdDQUFnQyxFQUFFLEdBQUc7QUFBQSxNQUNyRCxDQUFDLGVBQWUscUNBQXFDLEVBQUUsR0FBRztBQUFBLE1BQzFELENBQUMsZUFBZSx5QkFBeUIsRUFBRSxHQUFHO0FBQUEsTUFDOUMsQ0FBQyxlQUFlLGdDQUFnQyxFQUFFLEdBQUc7QUFBQSxJQUN2RDtBQUFBLEVBQ0Y7QUFBQSxFQUNBLGFBQWE7QUFBQSxJQUNYLFNBQVM7QUFBQSxNQUNQLGVBQWU7QUFBQSxJQUNqQjtBQUFBLElBQ0EsT0FBTztBQUFBLE1BQ0wsK0JBQStCO0FBQUEsTUFDL0IsaUNBQWlDO0FBQUEsTUFDakMsdUJBQXVCO0FBQUEsTUFDdkIscUNBQXFDO0FBQUEsTUFDckMsa0NBQWtDO0FBQUEsTUFDbEMsK0JBQStCO0FBQUEsTUFDL0IsMENBQTBDO0FBQUEsTUFDMUMsdURBQXVEO0FBQUEsTUFDdkQsdUNBQXVDO0FBQUEsTUFDdkMsOEJBQThCO0FBQUEsTUFDOUIsQ0FBQyxlQUFlLDBCQUEwQixFQUFFLEdBQUc7QUFBQSxNQUMvQyxDQUFDLGVBQWUsNkJBQTZCLEVBQUUsR0FBRztBQUFBLElBQ3BEO0FBQUEsRUFDRjtBQUNGO0FBRUEsSUFBTSxpQkFBNkM7QUFBQSxFQUNqRCxHQUFHO0FBQUEsRUFDSDtBQUNGO0FBQ0EsSUFBTyxjQUFROyIsCiAgIm5hbWVzIjogW10KfQo=
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2luZGV4LnRzIl0sCiAgIm1hcHBpbmdzIjogIjtBQVVBLE9BQU8sd0JBQXdCLFVBQVUsa0NBQWtDO0FBQzNFLE9BQU8sdUJBQXVCLFVBQVUsaUNBQWlDO0FBQ3pFLE9BQU8sa0JBQWtCLFVBQVUsNEJBQTRCO0FBQy9ELE9BQU8sMkJBQTJCLFVBQVUscUNBQXFDO0FBQ2pGLE9BQU87QUFBQSxFQUNMLFVBQVU7QUFBQSxPQUNMO0FBQ1AsT0FBTztBQUFBLEVBQ0wsVUFBVTtBQUFBLE9BQ0w7QUFDUCxPQUFPO0FBQUEsRUFDTCxVQUFVO0FBQUEsT0FDTDtBQUNQLE9BQU8scUJBQXFCO0FBQzVCLE9BQU8sbUJBQW1CO0FBQzFCLE9BQU8sWUFBWTtBQUNuQixPQUFPLGtCQUFrQjtBQUN6QixPQUFPLFlBQVk7QUFDbkIsT0FBTyxzQkFBc0I7QUFDN0IsT0FBTywyQkFBMkI7QUFDbEMsT0FBTyxrQkFBa0I7QUFDekIsT0FBTyx5Q0FBeUM7QUFDaEQsT0FBTyx5QkFBeUI7QUFFaEMsSUFBTSxRQUFzRDtBQUFBLEVBQzFELHFCQUFxQjtBQUFBLEVBQ3JCLG1CQUFtQjtBQUFBLEVBQ25CLFdBQVc7QUFBQSxFQUNYLFdBQVc7QUFBQSxFQUNYLHlCQUF5QjtBQUFBLEVBQ3pCLGtCQUFrQjtBQUFBLEVBQ2xCLHNCQUFzQjtBQUFBLEVBQ3RCLDhCQUE4QjtBQUFBLEVBQzlCLDJDQUEyQztBQUFBLEVBQzNDLDJCQUEyQjtBQUFBLEVBQzNCLENBQUMsMEJBQTBCLEdBQUc7QUFBQSxFQUM5QixDQUFDLDZCQUE2QixHQUFHO0FBQUEsRUFDakMsQ0FBQyxvQkFBb0IsR0FBRztBQUFBLEVBQ3hCLENBQUMsZ0NBQWdDLEdBQUc7QUFBQSxFQUNwQyxDQUFDLHFDQUFxQyxHQUFHO0FBQUEsRUFDekMsQ0FBQyx5QkFBeUIsR0FBRztBQUFBLEVBQzdCLENBQUMsZ0NBQWdDLEdBQUc7QUFDdEM7QUFFQSxJQUFNLFNBQXFDO0FBQUEsRUFDekM7QUFDRjtBQUVBLElBQU0sVUFBc0Q7QUFBQSxFQUMxRCxLQUFLO0FBQUEsSUFDSCxTQUFTO0FBQUEsTUFDUCxlQUFlO0FBQUEsSUFDakI7QUFBQSxJQUNBLE9BQU87QUFBQSxNQUNMLCtCQUErQjtBQUFBLE1BQy9CLHVCQUF1QjtBQUFBLE1BQ3ZCLGlDQUFpQztBQUFBLE1BQ2pDLHVCQUF1QjtBQUFBLE1BQ3ZCLHFDQUFxQztBQUFBLE1BQ3JDLGtDQUFrQztBQUFBLE1BQ2xDLDBDQUEwQztBQUFBLE1BQzFDLHVEQUF1RDtBQUFBLE1BQ3ZELHVDQUF1QztBQUFBLE1BQ3ZDLDhCQUE4QjtBQUFBLE1BQzlCLENBQUMsZUFBZSwwQkFBMEIsRUFBRSxHQUFHO0FBQUEsTUFDL0MsQ0FBQyxlQUFlLDZCQUE2QixFQUFFLEdBQUc7QUFBQSxNQUNsRCxDQUFDLGVBQWUsb0JBQW9CLEVBQUUsR0FBRztBQUFBLE1BQ3pDLENBQUMsZUFBZSxnQ0FBZ0MsRUFBRSxHQUFHO0FBQUEsTUFDckQsQ0FBQyxlQUFlLHFDQUFxQyxFQUFFLEdBQUc7QUFBQSxNQUMxRCxDQUFDLGVBQWUseUJBQXlCLEVBQUUsR0FBRztBQUFBLE1BQzlDLENBQUMsZUFBZSxnQ0FBZ0MsRUFBRSxHQUFHO0FBQUEsSUFDdkQ7QUFBQSxFQUNGO0FBQUEsRUFDQSxhQUFhO0FBQUEsSUFDWCxTQUFTO0FBQUEsTUFDUCxlQUFlO0FBQUEsSUFDakI7QUFBQSxJQUNBLE9BQU87QUFBQSxNQUNMLCtCQUErQjtBQUFBLE1BQy9CLHVCQUF1QjtBQUFBLE1BQ3ZCLGlDQUFpQztBQUFBLE1BQ2pDLHVCQUF1QjtBQUFBLE1BQ3ZCLHFDQUFxQztBQUFBLE1BQ3JDLGtDQUFrQztBQUFBLE1BQ2xDLDBDQUEwQztBQUFBLE1BQzFDLHVEQUF1RDtBQUFBLE1BQ3ZELHVDQUF1QztBQUFBLE1BQ3ZDLDhCQUE4QjtBQUFBLE1BQzlCLENBQUMsZUFBZSwwQkFBMEIsRUFBRSxHQUFHO0FBQUEsTUFDL0MsQ0FBQyxlQUFlLDZCQUE2QixFQUFFLEdBQUc7QUFBQSxJQUNwRDtBQUFBLEVBQ0Y7QUFDRjtBQUVBLElBQU0saUJBQTZDO0FBQUEsRUFDakQsR0FBRztBQUFBLEVBQ0g7QUFDRjtBQUNBLElBQU8sY0FBUTsiLAogICJuYW1lcyI6IFtdCn0K

package/dist-mjs/no-enum.mjs

@@ -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

@@ -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

@@ -1 +1 @@
-{"name":"@checkdigit/eslint-plugin","version":"7.2.0-PR.66-49d4","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

@@ -23,7 +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 noSideEffects from './no-side-effects';
+import noEnum from './no-enum';
 import noTestImport from './no-test-import';
 import noUuid from './no-uuid';
 import noWallabyComment from './no-wallaby-comment';
@@ -35,11 +35,11 @@ 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,
   'no-wallaby-comment': noWallabyComment,
-  'no-side-effects': noSideEffects,
   'regular-expression-comment': regexComment,
   'require-assert-predicate-rejects-throws': requireAssertPredicateRejectsThrows,
   'object-literal-response': objectLiteralResponse,
@@ -63,11 +63,11 @@ 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',
       '@checkdigit/no-wallaby-comment': 'error',
-      '@checkdigit/no-side-effects': ['error', { excludedIdentifiers: ['assert', 'debug', 'log', 'promisify'] }],
       '@checkdigit/regular-expression-comment': 'error',
       '@checkdigit/require-assert-predicate-rejects-throws': 'error',
       '@checkdigit/object-literal-response': 'error',
@@ -87,11 +87,11 @@ 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',
       '@checkdigit/no-wallaby-comment': 'off',
-      '@checkdigit/no-side-effects': 'error',
       '@checkdigit/regular-expression-comment': 'error',
       '@checkdigit/require-assert-predicate-rejects-throws': 'error',
       '@checkdigit/object-literal-response': 'error',

package/src/no-enum.ts

@@ -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;

package/dist-mjs/no-side-effects.mjs

@@ -1,68 +0,0 @@
-// src/no-side-effects.ts
-import { ESLintUtils } from "@typescript-eslint/utils";
-import { TSESTree } from "@typescript-eslint/typescript-estree";
-var ruleId = "no-side-effects";
-var NO_SIDE_EFFECTS = "NO_SIDE_EFFECTS";
-function isExpressionStatement(node) {
-  return node.type === TSESTree.AST_NODE_TYPES.ExpressionStatement;
-}
-function isAwaitExpression(statement) {
-  return isExpressionStatement(statement) && statement.expression.type === TSESTree.AST_NODE_TYPES.AwaitExpression;
-}
-function isCallExpressionCalleeMemberExpression(statement, excludedIdentifiers) {
-  return isExpressionStatement(statement) && statement.expression.type === TSESTree.AST_NODE_TYPES.CallExpression && statement.expression.callee.type === TSESTree.AST_NODE_TYPES.MemberExpression && statement.expression.callee.object.type === TSESTree.AST_NODE_TYPES.Identifier && !excludedIdentifiers.includes(statement.expression.callee.object.name);
-}
-function isVariableDeclarationAwaitExpression(node) {
-  return node.type === TSESTree.AST_NODE_TYPES.VariableDeclaration && node.declarations.length > 0 && node.declarations[0]?.init?.type === TSESTree.AST_NODE_TYPES.AwaitExpression;
-}
-function isVariableDeclarationCallExpression(node, excludedIdentifiers) {
-  return node.type === TSESTree.AST_NODE_TYPES.VariableDeclaration && node.declarations.length > 0 && node.declarations[0]?.init?.type === TSESTree.AST_NODE_TYPES.CallExpression && (node.declarations[0].init.callee.type === TSESTree.AST_NODE_TYPES.Identifier && !excludedIdentifiers.includes(node.declarations[0].init.callee.name) || node.declarations[0].init.callee.type === TSESTree.AST_NODE_TYPES.MemberExpression);
-}
-var createRule = ESLintUtils.RuleCreator((name) => name);
-var rule = createRule({
-  name: ruleId,
-  meta: {
-    type: "problem",
-    docs: {
-      description: "Ensure no side effects can occur at the module-level"
-    },
-    schema: [
-      {
-        type: "object",
-        properties: {
-          excludedIdentifiers: {
-            type: "array",
-            items: { type: "string" }
-          }
-        },
-        additionalProperties: false
-      }
-    ],
-    messages: {
-      [NO_SIDE_EFFECTS]: "No side effects can occur at the module-level"
-    }
-  },
-  defaultOptions: [{ excludedIdentifiers: [""] }],
-  create(context) {
-    const options = context.options[0];
-    const excludedIdentifiers = options.excludedIdentifiers.length > 0 ? options.excludedIdentifiers : [];
-    return {
-      Program(node) {
-        node.body.forEach((statement) => {
-          if (isAwaitExpression(statement) || isCallExpressionCalleeMemberExpression(statement, excludedIdentifiers) || isVariableDeclarationAwaitExpression(statement) || isVariableDeclarationCallExpression(statement, excludedIdentifiers)) {
-            context.report({
-              node: statement,
-              messageId: NO_SIDE_EFFECTS
-            });
-          }
-        });
-      }
-    };
-  }
-});
-var no_side_effects_default = rule;
-export {
-  no_side_effects_default as default,
-  ruleId
-};
-//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL25vLXNpZGUtZWZmZWN0cy50cyJdLAogICJtYXBwaW5ncyI6ICI7QUFRQSxTQUFTLG1CQUFtQjtBQUM1QixTQUFTLGdCQUFnQjtBQU1sQixJQUFNLFNBQVM7QUFDdEIsSUFBTSxrQkFBa0I7QUFHeEIsU0FBUyxzQkFBc0IsTUFBMkQ7QUFDeEYsU0FBTyxLQUFLLFNBQVMsU0FBUyxlQUFlO0FBQy9DO0FBR0EsU0FBUyxrQkFBa0IsV0FBbUM7QUFDNUQsU0FBTyxzQkFBc0IsU0FBUyxLQUFLLFVBQVUsV0FBVyxTQUFTLFNBQVMsZUFBZTtBQUNuRztBQUdBLFNBQVMsdUNBQXVDLFdBQTBCLHFCQUF3QztBQUNoSCxTQUNFLHNCQUFzQixTQUFTLEtBQy9CLFVBQVUsV0FBVyxTQUFTLFNBQVMsZUFBZSxrQkFDdEQsVUFBVSxXQUFXLE9BQU8sU0FBUyxTQUFTLGVBQWUsb0JBQzdELFVBQVUsV0FBVyxPQUFPLE9BQU8sU0FBUyxTQUFTLGVBQWUsY0FDcEUsQ0FBQyxvQkFBb0IsU0FBUyxVQUFVLFdBQVcsT0FBTyxPQUFPLElBQUk7QUFFekU7QUFHQSxTQUFTLHFDQUFxQyxNQUE4QjtBQUMxRSxTQUNFLEtBQUssU0FBUyxTQUFTLGVBQWUsdUJBQ3RDLEtBQUssYUFBYSxTQUFTLEtBQzNCLEtBQUssYUFBYSxDQUFDLEdBQUcsTUFBTSxTQUFTLFNBQVMsZUFBZTtBQUVqRTtBQUdBLFNBQVMsb0NBQW9DLE1BQXFCLHFCQUF3QztBQUN4RyxTQUNFLEtBQUssU0FBUyxTQUFTLGVBQWUsdUJBQ3RDLEtBQUssYUFBYSxTQUFTLEtBQzNCLEtBQUssYUFBYSxDQUFDLEdBQUcsTUFBTSxTQUFTLFNBQVMsZUFBZSxtQkFDM0QsS0FBSyxhQUFhLENBQUMsRUFBRSxLQUFLLE9BQU8sU0FBUyxTQUFTLGVBQWUsY0FDbEUsQ0FBQyxvQkFBb0IsU0FBUyxLQUFLLGFBQWEsQ0FBQyxFQUFFLEtBQUssT0FBTyxJQUFJLEtBQ25FLEtBQUssYUFBYSxDQUFDLEVBQUUsS0FBSyxPQUFPLFNBQVMsU0FBUyxlQUFlO0FBRXhFO0FBRUEsSUFBTSxhQUF5RCxZQUFZLFlBQVksQ0FBQyxTQUFTLElBQUk7QUFFckcsSUFBTSxPQUFzQyxXQUFXO0FBQUEsRUFDckQsTUFBTTtBQUFBLEVBQ04sTUFBTTtBQUFBLElBQ0osTUFBTTtBQUFBLElBQ04sTUFBTTtBQUFBLE1BQ0osYUFBYTtBQUFBLElBQ2Y7QUFBQSxJQUNBLFFBQVE7QUFBQSxNQUNOO0FBQUEsUUFDRSxNQUFNO0FBQUEsUUFDTixZQUFZO0FBQUEsVUFDVixxQkFBcUI7QUFBQSxZQUNuQixNQUFNO0FBQUEsWUFDTixPQUFPLEVBQUUsTUFBTSxTQUFTO0FBQUEsVUFDMUI7QUFBQSxRQUNGO0FBQUEsUUFDQSxzQkFBc0I7QUFBQSxNQUN4QjtBQUFBLElBQ0Y7QUFBQSxJQUNBLFVBQVU7QUFBQSxNQUNSLENBQUMsZUFBZSxHQUFHO0FBQUEsSUFDckI7QUFBQSxFQUNGO0FBQUEsRUFDQSxnQkFBZ0IsQ0FBQyxFQUFFLHFCQUFxQixDQUFDLEVBQUUsRUFBRSxDQUFDO0FBQUEsRUFDOUMsT0FBTyxTQUFTO0FBQ2QsVUFBTSxVQUF1QixRQUFRLFFBQVEsQ0FBQztBQUM5QyxVQUFNLHNCQUFzQixRQUFRLG9CQUFvQixTQUFTLElBQUksUUFBUSxzQkFBc0IsQ0FBQztBQUVwRyxXQUFPO0FBQUEsTUFDTCxRQUFRLE1BQXdCO0FBQzlCLGFBQUssS0FBSyxRQUFRLENBQUMsY0FBYztBQUMvQixjQUNFLGtCQUFrQixTQUFTLEtBQzNCLHVDQUF1QyxXQUFXLG1CQUFtQixLQUNyRSxxQ0FBcUMsU0FBUyxLQUM5QyxvQ0FBb0MsV0FBVyxtQkFBbUIsR0FDbEU7QUFDQSxvQkFBUSxPQUFPO0FBQUEsY0FDYixNQUFNO0FBQUEsY0FDTixXQUFXO0FBQUEsWUFDYixDQUFDO0FBQUEsVUFDSDtBQUFBLFFBQ0YsQ0FBQztBQUFBLE1BQ0g7QUFBQSxJQUNGO0FBQUEsRUFDRjtBQUNGLENBQUM7QUFFRCxJQUFPLDBCQUFROyIsCiAgIm5hbWVzIjogW10KfQo=

package/dist-types/no-side-effects.d.ts

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

package/src/no-side-effects.ts

@@ -1,111 +0,0 @@
-// no-side-effects.ts
-
-/*
- * Copyright (c) 2022-2024 Check Digit, LLC
- *
- * This code is licensed under the MIT license (see LICENSE.txt for details).
- */
-
-import { ESLintUtils } from '@typescript-eslint/utils';
-import { TSESTree } from '@typescript-eslint/typescript-estree';
-
-interface RuleOptions {
-  excludedIdentifiers: string[];
-}
-
-export const ruleId = 'no-side-effects';
-const NO_SIDE_EFFECTS = 'NO_SIDE_EFFECTS';
-
-// Type guard to check if a node is an ExpressionStatement
-function isExpressionStatement(node: TSESTree.Node): node is TSESTree.ExpressionStatement {
-  return node.type === TSESTree.AST_NODE_TYPES.ExpressionStatement;
-}
-
-// Type guard to check if a node is an AwaitExpression
-function isAwaitExpression(statement: TSESTree.Node): boolean {
-  return isExpressionStatement(statement) && statement.expression.type === TSESTree.AST_NODE_TYPES.AwaitExpression;
-}
-
-// To check if it is a call expression with a member expression i.e. module.method()
-function isCallExpressionCalleeMemberExpression(statement: TSESTree.Node, excludedIdentifiers: string[]): boolean {
-  return (
-    isExpressionStatement(statement) &&
-    statement.expression.type === TSESTree.AST_NODE_TYPES.CallExpression &&
-    statement.expression.callee.type === TSESTree.AST_NODE_TYPES.MemberExpression &&
-    statement.expression.callee.object.type === TSESTree.AST_NODE_TYPES.Identifier &&
-    !excludedIdentifiers.includes(statement.expression.callee.object.name)
-  );
-}
-
-// To check if it is a variable declaration with an await expression i.e. const configuration = await someFunction();
-function isVariableDeclarationAwaitExpression(node: TSESTree.Node): boolean {
-  return (
-    node.type === TSESTree.AST_NODE_TYPES.VariableDeclaration &&
-    node.declarations.length > 0 &&
-    node.declarations[0]?.init?.type === TSESTree.AST_NODE_TYPES.AwaitExpression
-  );
-}
-
-// To check if it is a variable declaration with a call expression
-function isVariableDeclarationCallExpression(node: TSESTree.Node, excludedIdentifiers: string[]): boolean {
-  return (
-    node.type === TSESTree.AST_NODE_TYPES.VariableDeclaration &&
-    node.declarations.length > 0 &&
-    node.declarations[0]?.init?.type === TSESTree.AST_NODE_TYPES.CallExpression &&
-    ((node.declarations[0].init.callee.type === TSESTree.AST_NODE_TYPES.Identifier &&
-      !excludedIdentifiers.includes(node.declarations[0].init.callee.name)) ||
-      node.declarations[0].init.callee.type === TSESTree.AST_NODE_TYPES.MemberExpression)
-  );
-}
-
-const createRule: ReturnType<typeof ESLintUtils.RuleCreator> = ESLintUtils.RuleCreator((name) => name);
-
-const rule: ReturnType<typeof createRule> = createRule({
-  name: ruleId,
-  meta: {
-    type: 'problem',
-    docs: {
-      description: 'Ensure no side effects can occur at the module-level',
-    },
-    schema: [
-      {
-        type: 'object',
-        properties: {
-          excludedIdentifiers: {
-            type: 'array',
-            items: { type: 'string' },
-          },
-        },
-        additionalProperties: false,
-      },
-    ],
-    messages: {
-      [NO_SIDE_EFFECTS]: 'No side effects can occur at the module-level',
-    },
-  },
-  defaultOptions: [{ excludedIdentifiers: [''] }],
-  create(context) {
-    const options: RuleOptions = context.options[0] as RuleOptions;
-    const excludedIdentifiers = options.excludedIdentifiers.length > 0 ? options.excludedIdentifiers : [];
-
-    return {
-      Program(node: TSESTree.Program) {
-        node.body.forEach((statement) => {
-          if (
-            isAwaitExpression(statement) ||
-            isCallExpressionCalleeMemberExpression(statement, excludedIdentifiers) ||
-            isVariableDeclarationAwaitExpression(statement) ||
-            isVariableDeclarationCallExpression(statement, excludedIdentifiers)
-          ) {
-            context.report({
-              node: statement,
-              messageId: NO_SIDE_EFFECTS,
-            });
-          }
-        });
-      },
-    };
-  },
-});
-
-export default rule;