@blumintinc/eslint-plugin-blumint 0.1.18 → 0.1.20

package/docs/rules/dynamic-https-errors.md

@@ -0,0 +1,23 @@
+# Dynamic elements of errors should be in the 'details' field (`@blumintinc/blumint/dynamic-https-errors`)
+
+⚠️ This rule _warns_ in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
+
+This rule warns against the use of template literals in the `message` field of the `HttpsError` constructor, and suggests their use in the `details` field instead.
+
+## Rule Details
+
+Examples of **incorrect** code for this rule:
+
+```typescript
+throw new https.HttpsError('foo', `Error: ${bar}`, 'baz');
+throw new HttpsError('foo', `Error: ${bar}`, 'baz');
+```
+
+Examples of **correct** code for this rule:
+
+```typescript
+throw new https.HttpsError('foo', 'bar', 'baz');
+throw new https.HttpsError('foo', 'bar', `Details: ${baz}`);
+```

package/lib/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const array_methods_this_context_1 = require("./rules/array-methods-this-context");
+const dynamic_https_errors_1 = require("./rules/dynamic-https-errors");
 const export_if_in_doubt_1 = require("./rules/export-if-in-doubt");
 const extract_global_constants_1 = require("./rules/extract-global-constants");
 const generic_starts_with_t_1 = require("./rules/generic-starts-with-t");
@@ -17,7 +18,7 @@ const require_memo_1 = require("./rules/require-memo");
 module.exports = {
     meta: {
         name: '@blumintinc/eslint-plugin-blumint',
-        version: '0.1.18',
+        version: '0.1.20',
     },
     parseOptions: {
         ecmaVersion: 2020,
@@ -27,6 +28,7 @@ module.exports = {
             plugins: ['@blumintinc/blumint'],
             rules: {
                 '@blumintinc/blumint/array-methods-this-context': 'warn',
+                '@blumintinc/blumint/dynamic-https-errors': 'warn',
                 // '@blumintinc/blumint/export-if-in-doubt': 'warn',
                 // '@blumintinc/blumint/extract-global-constants': 'warn',
                 '@blumintinc/blumint/generic-starts-with-t': 'warn',
@@ -45,6 +47,7 @@ module.exports = {
     },
     rules: {
         'array-methods-this-context': array_methods_this_context_1.arrayMethodsThisContext,
+        'dynamic-https-errors': dynamic_https_errors_1.dynamicHttpsErrors,
         'export-if-in-doubt': export_if_in_doubt_1.exportIfInDoubt,
         'extract-global-constants': extract_global_constants_1.extractGlobalConstants,
         'generic-starts-with-t': generic_starts_with_t_1.genericStartsWithT,

package/lib/rules/dynamic-https-errors.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dynamicHttpsErrors = void 0;
+/* eslint-disable @blumintinc/blumint/extract-global-constants */
+const createRule_1 = require("../utils/createRule");
+const isHttpsErrorCall = (callee) => {
+    if (callee.type === 'MemberExpression') {
+        return (callee.object.type === 'Identifier' &&
+            callee.object.name === 'https' &&
+            callee.property.type === 'Identifier' &&
+            callee.property.name === 'HttpsError');
+    }
+    else if (callee.type === 'Identifier') {
+        return callee.name === 'HttpsError';
+    }
+    return false;
+};
+exports.dynamicHttpsErrors = (0, createRule_1.createRule)({
+    name: 'dynamic-https-errors',
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Dynamic error details should only be in the third argument of the HttpsError constructor. The second argument is hashed to produce a unique id.',
+            recommended: 'warn',
+        },
+        schema: [],
+        messages: {
+            dynamicHttpsErrors: 'Found dynamic error details in the second argument of the HttpsError constructor - the "message" field. This field is hashed to produce a unique id for error monitoring. Move any dynamic details to the third argument - the "details" field - to preserve the unique id and to monitor the error correctly.',
+        },
+    },
+    defaultOptions: [],
+    create(context) {
+        const checkForHttpsError = (node) => {
+            const callee = node.callee;
+            if (isHttpsErrorCall(callee)) {
+                const secondArg = node.arguments[1];
+                if (secondArg && secondArg.type === 'TemplateLiteral') {
+                    if (secondArg.expressions.length > 0) {
+                        context.report({
+                            node: secondArg,
+                            messageId: 'dynamicHttpsErrors',
+                        });
+                    }
+                }
+            }
+        };
+        return {
+            NewExpression(node) {
+                return checkForHttpsError(node);
+            },
+            CallExpression(node) {
+                return checkForHttpsError(node);
+            },
+        };
+    },
+});
+//# sourceMappingURL=dynamic-https-errors.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blumintinc/eslint-plugin-blumint",
-  "version": "0.1.18",
+  "version": "0.1.20",
   "description": "Custom eslint rules for use at BluMint",
   "keywords": [
     "eslint",