@checkdigit/eslint-plugin 7.3.0 → 7.4.0

package/README.md

@@ -14,6 +14,7 @@ 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`

package/dist-mjs/index.mjs

@@ -15,6 +15,7 @@ import requireTypeOutOfTypeOnlyImports, {
 import noServeRuntime, { ruleId as noServeRuntimeRuleId } from "./agent/no-serve-runtime.mjs";
 import filePathComment from "./file-path-comment.mjs";
 import noCardNumbers from "./no-card-numbers.mjs";
+import noSideEffects from "./no-side-effects.mjs";
 import noRandomV4UUID from "./no-random-v4-uuid.mjs";
 import noTestImport from "./no-test-import.mjs";
 import noUuid from "./no-uuid.mjs";
@@ -31,6 +32,7 @@ var rules = {
   "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,
@@ -58,6 +60,7 @@ var configs = {
       "@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",
@@ -83,6 +86,7 @@ var configs = {
       "@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",
@@ -100,4 +104,4 @@ var src_default = pluginToExport;
 export {
   src_default as default
 };
-//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2luZGV4LnRzIl0sCiAgIm1hcHBpbmdzIjogIjtBQVVBLE9BQU8sd0JBQXdCLFVBQVUsa0NBQWtDO0FBQzNFLE9BQU8sdUJBQXVCLFVBQVUsaUNBQWlDO0FBQ3pFLE9BQU8sa0JBQWtCLFVBQVUsNEJBQTRCO0FBQy9ELE9BQU8sMkJBQTJCLFVBQVUscUNBQXFDO0FBQ2pGLE9BQU87QUFBQSxFQUNMLFVBQVU7QUFBQSxPQUNMO0FBQ1AsT0FBTztBQUFBLEVBQ0wsVUFBVTtBQUFBLE9BQ0w7QUFDUCxPQUFPO0FBQUEsRUFDTCxVQUFVO0FBQUEsT0FDTDtBQUNQLE9BQU8sa0JBQWtCLFVBQVUsNEJBQTRCO0FBQy9ELE9BQU8scUJBQXFCO0FBQzVCLE9BQU8sbUJBQW1CO0FBQzFCLE9BQU8sb0JBQW9CO0FBQzNCLE9BQU8sa0JBQWtCO0FBQ3pCLE9BQU8sWUFBWTtBQUNuQixPQUFPLHNCQUFzQjtBQUM3QixPQUFPLDJCQUEyQjtBQUNsQyxPQUFPLGtCQUFrQjtBQUN6QixPQUFPLHlDQUF5QztBQUNoRCxPQUFPLHlCQUF5QjtBQUVoQyxJQUFNLFFBQXNEO0FBQUEsRUFDMUQscUJBQXFCO0FBQUEsRUFDckIsbUJBQW1CO0FBQUEsRUFDbkIscUJBQXFCO0FBQUEsRUFDckIsV0FBVztBQUFBLEVBQ1gseUJBQXlCO0FBQUEsRUFDekIsa0JBQWtCO0FBQUEsRUFDbEIsc0JBQXNCO0FBQUEsRUFDdEIsOEJBQThCO0FBQUEsRUFDOUIsMkNBQTJDO0FBQUEsRUFDM0MsMkJBQTJCO0FBQUEsRUFDM0IsQ0FBQywwQkFBMEIsR0FBRztBQUFBLEVBQzlCLENBQUMsNkJBQTZCLEdBQUc7QUFBQSxFQUNqQyxDQUFDLG9CQUFvQixHQUFHO0FBQUEsRUFDeEIsQ0FBQyxnQ0FBZ0MsR0FBRztBQUFBLEVBQ3BDLENBQUMscUNBQXFDLEdBQUc7QUFBQSxFQUN6QyxDQUFDLHlCQUF5QixHQUFHO0FBQUEsRUFDN0IsQ0FBQyxnQ0FBZ0MsR0FBRztBQUFBLEVBQ3BDLENBQUMsb0JBQW9CLEdBQUc7QUFDMUI7QUFFQSxJQUFNLFNBQXFDO0FBQUEsRUFDekM7QUFDRjtBQUVBLElBQU0sVUFBc0Q7QUFBQSxFQUMxRCxLQUFLO0FBQUEsSUFDSCxTQUFTO0FBQUEsTUFDUCxlQUFlO0FBQUEsSUFDakI7QUFBQSxJQUNBLE9BQU87QUFBQSxNQUNMLCtCQUErQjtBQUFBLE1BQy9CLGlDQUFpQztBQUFBLE1BQ2pDLGlDQUFpQztBQUFBLE1BQ2pDLHVCQUF1QjtBQUFBLE1BQ3ZCLHFDQUFxQztBQUFBLE1BQ3JDLGtDQUFrQztBQUFBLE1BQ2xDLDBDQUEwQztBQUFBLE1BQzFDLHVEQUF1RDtBQUFBLE1BQ3ZELHVDQUF1QztBQUFBLE1BQ3ZDLDhCQUE4QjtBQUFBLE1BQzlCLENBQUMsZUFBZSwwQkFBMEIsRUFBRSxHQUFHO0FBQUEsTUFDL0MsQ0FBQyxlQUFlLDZCQUE2QixFQUFFLEdBQUc7QUFBQSxNQUNsRCxDQUFDLGVBQWUsb0JBQW9CLEVBQUUsR0FBRztBQUFBLE1BQ3pDLENBQUMsZUFBZSxnQ0FBZ0MsRUFBRSxHQUFHO0FBQUEsTUFDckQsQ0FBQyxlQUFlLHFDQUFxQyxFQUFFLEdBQUc7QUFBQSxNQUMxRCxDQUFDLGVBQWUseUJBQXlCLEVBQUUsR0FBRztBQUFBLE1BQzlDLENBQUMsZUFBZSxnQ0FBZ0MsRUFBRSxHQUFHO0FBQUEsTUFDckQsQ0FBQyxlQUFlLG9CQUFvQixFQUFFLEdBQUc7QUFBQSxJQUMzQztBQUFBLEVBQ0Y7QUFBQSxFQUNBLGFBQWE7QUFBQSxJQUNYLFNBQVM7QUFBQSxNQUNQLGVBQWU7QUFBQSxJQUNqQjtBQUFBLElBQ0EsT0FBTztBQUFBLE1BQ0wsK0JBQStCO0FBQUEsTUFDL0IsaUNBQWlDO0FBQUEsTUFDakMsaUNBQWlDO0FBQUEsTUFDakMsdUJBQXVCO0FBQUEsTUFDdkIscUNBQXFDO0FBQUEsTUFDckMsa0NBQWtDO0FBQUEsTUFDbEMsMENBQTBDO0FBQUEsTUFDMUMsdURBQXVEO0FBQUEsTUFDdkQsdUNBQXVDO0FBQUEsTUFDdkMsOEJBQThCO0FBQUEsTUFDOUIsQ0FBQyxlQUFlLDBCQUEwQixFQUFFLEdBQUc7QUFBQSxNQUMvQyxDQUFDLGVBQWUsNkJBQTZCLEVBQUUsR0FBRztBQUFBLElBQ3BEO0FBQUEsRUFDRjtBQUNGO0FBRUEsSUFBTSxpQkFBNkM7QUFBQSxFQUNqRCxHQUFHO0FBQUEsRUFDSDtBQUNGO0FBQ0EsSUFBTyxjQUFROyIsCiAgIm5hbWVzIjogW10KfQo=
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2luZGV4LnRzIl0sCiAgIm1hcHBpbmdzIjogIjtBQVVBLE9BQU8sd0JBQXdCLFVBQVUsa0NBQWtDO0FBQzNFLE9BQU8sdUJBQXVCLFVBQVUsaUNBQWlDO0FBQ3pFLE9BQU8sa0JBQWtCLFVBQVUsNEJBQTRCO0FBQy9ELE9BQU8sMkJBQTJCLFVBQVUscUNBQXFDO0FBQ2pGLE9BQU87QUFBQSxFQUNMLFVBQVU7QUFBQSxPQUNMO0FBQ1AsT0FBTztBQUFBLEVBQ0wsVUFBVTtBQUFBLE9BQ0w7QUFDUCxPQUFPO0FBQUEsRUFDTCxVQUFVO0FBQUEsT0FDTDtBQUNQLE9BQU8sa0JBQWtCLFVBQVUsNEJBQTRCO0FBQy9ELE9BQU8scUJBQXFCO0FBQzVCLE9BQU8sbUJBQW1CO0FBQzFCLE9BQU8sbUJBQW1CO0FBQzFCLE9BQU8sb0JBQW9CO0FBQzNCLE9BQU8sa0JBQWtCO0FBQ3pCLE9BQU8sWUFBWTtBQUNuQixPQUFPLHNCQUFzQjtBQUM3QixPQUFPLDJCQUEyQjtBQUNsQyxPQUFPLGtCQUFrQjtBQUN6QixPQUFPLHlDQUF5QztBQUNoRCxPQUFPLHlCQUF5QjtBQUVoQyxJQUFNLFFBQXNEO0FBQUEsRUFDMUQscUJBQXFCO0FBQUEsRUFDckIsbUJBQW1CO0FBQUEsRUFDbkIscUJBQXFCO0FBQUEsRUFDckIsV0FBVztBQUFBLEVBQ1gseUJBQXlCO0FBQUEsRUFDekIsa0JBQWtCO0FBQUEsRUFDbEIsc0JBQXNCO0FBQUEsRUFDdEIsbUJBQW1CO0FBQUEsRUFDbkIsOEJBQThCO0FBQUEsRUFDOUIsMkNBQTJDO0FBQUEsRUFDM0MsMkJBQTJCO0FBQUEsRUFDM0IsQ0FBQywwQkFBMEIsR0FBRztBQUFBLEVBQzlCLENBQUMsNkJBQTZCLEdBQUc7QUFBQSxFQUNqQyxDQUFDLG9CQUFvQixHQUFHO0FBQUEsRUFDeEIsQ0FBQyxnQ0FBZ0MsR0FBRztBQUFBLEVBQ3BDLENBQUMscUNBQXFDLEdBQUc7QUFBQSxFQUN6QyxDQUFDLHlCQUF5QixHQUFHO0FBQUEsRUFDN0IsQ0FBQyxnQ0FBZ0MsR0FBRztBQUFBLEVBQ3BDLENBQUMsb0JBQW9CLEdBQUc7QUFDMUI7QUFFQSxJQUFNLFNBQXFDO0FBQUEsRUFDekM7QUFDRjtBQUVBLElBQU0sVUFBc0Q7QUFBQSxFQUMxRCxLQUFLO0FBQUEsSUFDSCxTQUFTO0FBQUEsTUFDUCxlQUFlO0FBQUEsSUFDakI7QUFBQSxJQUNBLE9BQU87QUFBQSxNQUNMLCtCQUErQjtBQUFBLE1BQy9CLGlDQUFpQztBQUFBLE1BQ2pDLGlDQUFpQztBQUFBLE1BQ2pDLHVCQUF1QjtBQUFBLE1BQ3ZCLHFDQUFxQztBQUFBLE1BQ3JDLGtDQUFrQztBQUFBLE1BQ2xDLCtCQUErQixDQUFDLFNBQVMsRUFBRSxxQkFBcUIsQ0FBQyxVQUFVLFNBQVMsT0FBTyxXQUFXLEVBQUUsQ0FBQztBQUFBLE1BQ3pHLDBDQUEwQztBQUFBLE1BQzFDLHVEQUF1RDtBQUFBLE1BQ3ZELHVDQUF1QztBQUFBLE1BQ3ZDLDhCQUE4QjtBQUFBLE1BQzlCLENBQUMsZUFBZSwwQkFBMEIsRUFBRSxHQUFHO0FBQUEsTUFDL0MsQ0FBQyxlQUFlLDZCQUE2QixFQUFFLEdBQUc7QUFBQSxNQUNsRCxDQUFDLGVBQWUsb0JBQW9CLEVBQUUsR0FBRztBQUFBLE1BQ3pDLENBQUMsZUFBZSxnQ0FBZ0MsRUFBRSxHQUFHO0FBQUEsTUFDckQsQ0FBQyxlQUFlLHFDQUFxQyxFQUFFLEdBQUc7QUFBQSxNQUMxRCxDQUFDLGVBQWUseUJBQXlCLEVBQUUsR0FBRztBQUFBLE1BQzlDLENBQUMsZUFBZSxnQ0FBZ0MsRUFBRSxHQUFHO0FBQUEsTUFDckQsQ0FBQyxlQUFlLG9CQUFvQixFQUFFLEdBQUc7QUFBQSxJQUMzQztBQUFBLEVBQ0Y7QUFBQSxFQUNBLGFBQWE7QUFBQSxJQUNYLFNBQVM7QUFBQSxNQUNQLGVBQWU7QUFBQSxJQUNqQjtBQUFBLElBQ0EsT0FBTztBQUFBLE1BQ0wsK0JBQStCO0FBQUEsTUFDL0IsaUNBQWlDO0FBQUEsTUFDakMsaUNBQWlDO0FBQUEsTUFDakMsdUJBQXVCO0FBQUEsTUFDdkIscUNBQXFDO0FBQUEsTUFDckMsa0NBQWtDO0FBQUEsTUFDbEMsK0JBQStCO0FBQUEsTUFDL0IsMENBQTBDO0FBQUEsTUFDMUMsdURBQXVEO0FBQUEsTUFDdkQsdUNBQXVDO0FBQUEsTUFDdkMsOEJBQThCO0FBQUEsTUFDOUIsQ0FBQyxlQUFlLDBCQUEwQixFQUFFLEdBQUc7QUFBQSxNQUMvQyxDQUFDLGVBQWUsNkJBQTZCLEVBQUUsR0FBRztBQUFBLElBQ3BEO0FBQUEsRUFDRjtBQUNGO0FBRUEsSUFBTSxpQkFBNkM7QUFBQSxFQUNqRCxHQUFHO0FBQUEsRUFDSDtBQUNGO0FBQ0EsSUFBTyxjQUFROyIsCiAgIm5hbWVzIjogW10KfQo=

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

@@ -0,0 +1,68 @@
+// 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

@@ -0,0 +1,5 @@
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkdigit/eslint-plugin",
-  "version": "7.3.0",
+  "version": "7.4.0",
   "description": "Check Digit eslint plugins",
   "keywords": [
     "eslint",

package/src/index.ts

@@ -24,6 +24,7 @@ import requireTypeOutOfTypeOnlyImports, {
 import noServeRuntime, { ruleId as noServeRuntimeRuleId } from './agent/no-serve-runtime';
 import filePathComment from './file-path-comment';
 import noCardNumbers from './no-card-numbers';
+import noSideEffects from './no-side-effects';
 import noRandomV4UUID from './no-random-v4-uuid';
 import noTestImport from './no-test-import';
 import noUuid from './no-uuid';
@@ -41,6 +42,7 @@ const rules: Record<string, TSESLint.LooseRuleDefinition> = {
   '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,
@@ -70,6 +72,7 @@ const configs: Record<string, TSESLint.FlatConfig.Config> = {
       '@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',
@@ -95,6 +98,7 @@ const configs: Record<string, TSESLint.FlatConfig.Config> = {
       '@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-side-effects.ts

@@ -0,0 +1,111 @@
+// 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;