eslint-plugin-crisp 1.7.7 → 1.7.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-crisp",
-  "version": "1.7.7",
+  "version": "1.7.9",
   "description": "Custom ESLint Rules for Crisp",
   "author": "Crisp IM SAS",
   "main": "index.js",

package/rules/logger-arguments.js

@@ -94,6 +94,63 @@ function isReference(node) {
   );
 }
 
+// Checks a fallback expression like `value || "none"` or `value ?? other`
+function isFallback(node) {
+  node = unwrapTransparentExpression(node);
+
+  if (
+    !node ||
+    node.type !== "LogicalExpression" ||
+    (node.operator !== "||" && node.operator !== "??")
+  ) {
+    return false;
+  }
+
+  const isOperandValid = (operand) => {
+    operand = unwrapTransparentExpression(operand);
+
+    return (
+      operand.type === "Literal" ||
+      isReference(operand) ||
+      isFallback(operand)
+    );
+  };
+
+  return isReference(node.left) || isFallback(node.left)
+    ? isOperandValid(node.right)
+    : false;
+}
+
+// Checks a logger argument value is a reference, a fallback or an object of those
+function isAllowedValue(node) {
+  return isReference(node) || isFallback(node) || isReferenceObject(node);
+}
+
+// Checks an inline object only contains references (no computed values)
+function isReferenceObject(node) {
+  node = unwrapTransparentExpression(node);
+
+  if (!node || node.type !== "ObjectExpression") {
+    return false;
+  }
+
+  return node.properties.every((property) => {
+    if (property.type === "SpreadElement") {
+      return isReference(property.argument);
+    }
+
+    if (property.type !== "Property" || property.kind !== "init") {
+      return false;
+    }
+
+    if (property.computed && !isReference(property.key)) {
+      return false;
+    }
+
+    return isAllowedValue(property.value);
+  });
+}
+
 export default {
   meta: {
     type: "suggestion",
@@ -107,7 +164,7 @@ export default {
       message:
         "Logger messages must be single-line, double-quoted string literals.",
       reference:
-        "Logger interpolation arguments must be references, not computed expressions."
+        "Logger interpolation arguments must be references, fallbacks (`||`, `??`) or inline objects of those, not computed expressions."
     }
   },
 
@@ -136,7 +193,7 @@ export default {
         }
 
         for (const value of values) {
-          if (!isReference(value)) {
+          if (!isAllowedValue(value)) {
             context.report({
               node: value,
               messageId: "reference"

package/tests/rules/logger-arguments.test.js

@@ -15,6 +15,13 @@ ruleTester.run("logger-arguments", rule, {
   value
 );`,
     "App.logger.info(\"This intentionally long logger message may exceed the usual source line length when necessary.\");",
+    "App.logger.debug(\"Loaded value: %s\", value || \"default\");",
+    "App.logger.debug(\"Loaded value: %s\", this.value ?? \"none\");",
+    "App.logger.debug(\"Loaded value: %s\", first || second || \"none\");",
+    "App.logger.debug(\"Loaded value: %s\", { user: userId || \"none\" });",
+    "App.logger.warn(\"Shutting down\", { bufferedCount });",
+    "App.logger.warn(\"Shutting down\", { count: this.count, ...meta });",
+    "App.logger.warn(\"Shutting down\", { nested: { bufferedCount } }, logMeta);",
     "App.logger.child({ namespace: \"worker\" });",
     "console.info(`Unrelated logger calls are ignored: ${value}`);"
   ],
@@ -77,7 +84,15 @@ ruleTester.run("logger-arguments", rule, {
       ]
     },
     {
-      code: "App.logger.debug(\"Loaded value: %s\", value || \"default\");",
+      code: "App.logger.debug(\"Loaded value: %s\", value || compute());",
+      errors: [
+        {
+          messageId: "reference"
+        }
+      ]
+    },
+    {
+      code: "App.logger.debug(\"Loaded value: %s\", value && \"default\");",
       errors: [
         {
           messageId: "reference"
@@ -93,7 +108,15 @@ ruleTester.run("logger-arguments", rule, {
       ]
     },
     {
-      code: "App.logger.debug(\"Loaded value: %s\", { value });",
+      code: "App.logger.debug(\"Loaded value: %s\", { value: value.trim() });",
+      errors: [
+        {
+          messageId: "reference"
+        }
+      ]
+    },
+    {
+      code: "App.logger.debug(\"Loaded value: %s\", { value: 3 });",
       errors: [
         {
           messageId: "reference"
@@ -109,7 +132,7 @@ ruleTester.run("logger-arguments", rule, {
       ]
     },
     {
-      code: "App.logger.debug(\"Values: %s / %s\", values.join(\", \"), fallback || \"none\");",
+      code: "App.logger.debug(\"Values: %s / %s\", values.join(\", \"), fallback || compute());",
       errors: [
         {
           messageId: "reference"