@blumintinc/eslint-plugin-blumint 1.13.0 → 1.15.0

package/lib/rules/enforce-dynamic-file-naming.js

@@ -3,76 +3,101 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RULE_NAME = void 0;
-const createRule_1 = require("../utils/createRule");
+exports.DYNAMIC_RULES_LABEL = exports.REQUIRE_DYNAMIC_FIREBASE_IMPORTS_RULE = exports.RULE_NAME = void 0;
 const path_1 = __importDefault(require("path"));
+const createRule_1 = require("../utils/createRule");
 exports.RULE_NAME = 'enforce-dynamic-file-naming';
+const ENFORCE_DYNAMIC_IMPORTS_RULE = '@blumintinc/blumint/enforce-dynamic-imports';
+exports.REQUIRE_DYNAMIC_FIREBASE_IMPORTS_RULE = '@blumintinc/blumint/require-dynamic-firebase-imports';
+exports.DYNAMIC_RULES_LABEL = `${ENFORCE_DYNAMIC_IMPORTS_RULE} or ${exports.REQUIRE_DYNAMIC_FIREBASE_IMPORTS_RULE}`;
+const SHORTHAND_DISABLE_NEXT_LINE = /\bednl\b/;
+const SHORTHAND_DISABLE_LINE = /\bedl\b/;
+const DISABLE_NEXT_LINE_TOKEN = 'eslint-disable-next-line';
+const DISABLE_LINE_TOKEN = 'eslint-disable-line';
+const DISABLE_BLOCK_PATTERN = /\beslint-disable\b(?!-)/;
+const disabledRuleNameFrom = (commentText) => {
+    const mentionsEnforceDynamicImports = commentText.includes(ENFORCE_DYNAMIC_IMPORTS_RULE);
+    const mentionsRequireDynamicFirebaseImports = commentText.includes(exports.REQUIRE_DYNAMIC_FIREBASE_IMPORTS_RULE);
+    if (mentionsEnforceDynamicImports && mentionsRequireDynamicFirebaseImports) {
+        return exports.DYNAMIC_RULES_LABEL;
+    }
+    if (mentionsEnforceDynamicImports) {
+        return ENFORCE_DYNAMIC_IMPORTS_RULE;
+    }
+    if (mentionsRequireDynamicFirebaseImports) {
+        return exports.REQUIRE_DYNAMIC_FIREBASE_IMPORTS_RULE;
+    }
+    return null;
+};
 exports.default = (0, createRule_1.createRule)({
     name: exports.RULE_NAME,
     meta: {
         type: 'suggestion',
         docs: {
-            description: 'Enforce .dynamic.ts(x) file naming when @blumintinc/blumint/enforce-dynamic-imports or @blumintinc/blumint/require-dynamic-firebase-imports rule is disabled',
+            description: `Enforce .dynamic.ts(x) file naming when ${exports.DYNAMIC_RULES_LABEL} rule is disabled`,
             recommended: 'error',
         },
         schema: [],
         messages: {
-            requireDynamicExtension: 'Files with disabled @blumintinc/blumint/enforce-dynamic-imports or @blumintinc/blumint/require-dynamic-firebase-imports rule must use .dynamic.ts(x) extension',
-            requireDisableDirective: 'Files with .dynamic.ts(x) extension must have at least one @blumintinc/blumint/enforce-dynamic-imports or @blumintinc/blumint/require-dynamic-firebase-imports disable directive',
+            requireDynamicExtension: 'File "{{fileName}}" disables "{{ruleName}}" but keeps the standard {{extension}} extension, hiding that dynamic-import safeguards are bypassed. Rename to "{{suggestedName}}" (or another *.dynamic.ts/tsx name) so the exception is visible and static-import hotspots stay easy to audit.',
+            requireDisableDirective: 'File "{{fileName}}" uses the ".dynamic" suffix that signals dynamic-import rules are disabled, but it lacks a disable directive for {{dynamicRulesLabel}}. Add the matching disable comment for the static import you need, or rename the file to "{{standardName}}" so the rules keep protecting other files.',
         },
     },
     defaultOptions: [],
     create(context) {
-        // Get the file path and name
         const filePath = context.getFilename();
         const fileName = path_1.default.basename(filePath);
-        // Check if the file is a TypeScript file (ends with .ts or .tsx)
-        // Ignore files with other extensions like .test.ts, .deprecated.ts, etc.
-        const isTypeScriptFile = /^[^.]+\.tsx?$/.test(fileName);
-        // Check if the file has .dynamic.ts or .dynamic.tsx extension
+        const isTypeScriptFile = fileName.endsWith('.ts') || fileName.endsWith('.tsx');
         const hasDynamicExtension = /\.dynamic\.tsx?$/.test(fileName);
-        // Skip if not a TypeScript file or has other extensions
         if (!isTypeScriptFile && !hasDynamicExtension) {
             return {};
         }
-        // Track if we found a disable directive for enforce-dynamic-imports
         let foundDisableDirective = false;
+        let disabledRuleName = null;
         return {
             Program() {
-                // Get the source code
                 const sourceCode = context.getSourceCode();
                 const comments = sourceCode.getAllComments();
-                // Check all comments for disable directives
                 for (const comment of comments) {
                     const commentText = comment.value.trim();
-                    // Check for inline disable directive for either rule
-                    if ((commentText.includes('eslint-disable-next-line') ||
-                        commentText.includes('ednl')) &&
-                        (commentText.includes('@blumintinc/blumint/enforce-dynamic-imports') ||
-                            commentText.includes('@blumintinc/blumint/require-dynamic-firebase-imports'))) {
-                        foundDisableDirective = true;
-                        break;
-                    }
-                    // Check for block disable directive for either rule
-                    if (commentText.includes('eslint-disable ') &&
-                        (commentText.includes('@blumintinc/blumint/enforce-dynamic-imports') ||
-                            commentText.includes('@blumintinc/blumint/require-dynamic-firebase-imports'))) {
+                    const disabledRuleNameForComment = disabledRuleNameFrom(commentText);
+                    const disablesTargetRule = disabledRuleNameForComment !== null;
+                    const inlineDisable = (commentText.includes(DISABLE_NEXT_LINE_TOKEN) ||
+                        commentText.includes(DISABLE_LINE_TOKEN) ||
+                        SHORTHAND_DISABLE_NEXT_LINE.test(commentText) ||
+                        SHORTHAND_DISABLE_LINE.test(commentText)) &&
+                        disablesTargetRule;
+                    const blockDisable = DISABLE_BLOCK_PATTERN.test(commentText) && disablesTargetRule;
+                    if (inlineDisable || blockDisable) {
                         foundDisableDirective = true;
+                        disabledRuleName = disabledRuleNameForComment;
                         break;
                     }
                 }
-                // If we found a disable directive but the file doesn't have .dynamic extension
                 if (foundDisableDirective && !hasDynamicExtension) {
+                    const suggestedName = fileName.replace(/\.tsx?$/, '.dynamic$&');
+                    const extension = path_1.default.extname(fileName);
                     context.report({
                         loc: { line: 1, column: 0 },
                         messageId: 'requireDynamicExtension',
+                        data: {
+                            fileName,
+                            ruleName: disabledRuleName ?? exports.DYNAMIC_RULES_LABEL,
+                            extension,
+                            suggestedName,
+                        },
                     });
                 }
-                // If the file has .dynamic extension but no disable directive
                 if (hasDynamicExtension && !foundDisableDirective) {
+                    const standardName = fileName.replace(/\.dynamic(?=\.tsx?$)/, '');
                     context.report({
                         loc: { line: 1, column: 0 },
                         messageId: 'requireDisableDirective',
+                        data: {
+                            fileName,
+                            standardName,
+                            dynamicRulesLabel: exports.DYNAMIC_RULES_LABEL,
+                        },
                     });
                 }
             },

package/lib/rules/enforce-dynamic-firebase-imports.d.ts

@@ -1,4 +1,5 @@
 import { TSESTree } from '@typescript-eslint/utils';
-export declare const enforceFirebaseImports: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"noDynamicImport", never[], {
+declare const enforceFirebaseImports: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"noDynamicImport", never[], {
     ImportDeclaration(node: TSESTree.ImportDeclaration): void;
 }>;
+export default enforceFirebaseImports;

package/lib/rules/enforce-dynamic-firebase-imports.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.enforceFirebaseImports = void 0;
 const createRule_1 = require("../utils/createRule");
-exports.enforceFirebaseImports = (0, createRule_1.createRule)({
+const enforceFirebaseImports = (0, createRule_1.createRule)({
     name: 'enforce-dynamic-firebase-imports',
     meta: {
         type: 'problem',
@@ -112,6 +111,7 @@ exports.enforceFirebaseImports = (0, createRule_1.createRule)({
                     suggest: [
                         {
                             messageId: 'noDynamicImport',
+                            data: { importPath },
                             fix(fixer) {
                                 const replacement = buildReplacement({
                                     allowSideEffectFix: true,
@@ -127,4 +127,5 @@ exports.enforceFirebaseImports = (0, createRule_1.createRule)({
         };
     },
 });
+exports.default = enforceFirebaseImports;
 //# sourceMappingURL=enforce-dynamic-firebase-imports.js.map

package/lib/rules/enforce-early-destructuring.d.ts

@@ -0,0 +1,2 @@
+import { TSESLint } from '@typescript-eslint/utils';
+export declare const enforceEarlyDestructuring: TSESLint.RuleModule<"hoistDestructuring", [], TSESLint.RuleListener>;