eslint-plugin-crisp 1.3.6 → 1.4.0

package/package.json

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

package/recommended.js

@@ -94,7 +94,7 @@ export default function configRecommended(pluginCrisp) {
         "linebreak-style": ["error", "unix"],
         "max-len": ["error", {
           "code": 80,
-          "ignorePattern": "^\\*\\* \@import"
+          "ignorePattern": "^\\/\\*\\* \@import"
         }],
         "no-console": "warn",
         "no-debugger": "warn",

package/rules/align-comments.js

@@ -11,7 +11,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode();
     const processedComments = new Set();
 
     function checkNode(node) {

package/rules/enforce-optional.js

@@ -1,3 +1,7 @@
+// Pre-compiled patterns for exclusion checks (avoid creating regex in loop)
+const OBJECT_METHODS_PATTERN = /Object\.(keys|values|entries)\(/;
+const ARRAY_METHODS_PATTERN = /Array\.(from)\(/;
+
 export default {
   meta: {
     type: "problem",
@@ -10,7 +14,7 @@ export default {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode();
 
     const patterns = [
       // Search for `foo && foo.` or `foo && foo[`
@@ -44,8 +48,8 @@ export default {
 
             if (
               index === 1 &&
-                (/Object\.(keys|values|entries)\(/.test(match[1]) ||
-                /Array\.(from)\(/.test(match[1]))
+                (OBJECT_METHODS_PATTERN.test(match[1]) ||
+                ARRAY_METHODS_PATTERN.test(match[1]))
             ) {
               // Ignore `Object.keys(foo || {})` (and others) as it cannot be \
               //   safely transformed to optional chaining

package/rules/header-check.js

@@ -1,4 +1,3 @@
-import fs from "fs";
 import path from "path";
 
 export default {
@@ -29,10 +28,9 @@ export default {
       Program(node) {
         const options = context.options[0] || {};
         const fileName = context.getFilename();
+        const sourceCode = context.sourceCode || context.getSourceCode();
 
-        let fileContent = fs.readFileSync(path.resolve(fileName), "utf8");
-
-        fileContent = fileContent.trim();
+        let fileContent = sourceCode.getText().trim();
 
         // Determine the file extension
         const fileExtension = path.extname(fileName);

package/rules/header-comments-check.js

@@ -20,6 +20,12 @@ export default {
     let lastNode = null;
     let groupStart = null;
 
+    // Cache all block comments once at start (sorted by position for fast lookup)
+    const sourceCode = context.sourceCode || context.getSourceCode();
+    const allBlockComments = sourceCode.getAllComments()
+      .filter(c => c.type === "Block")
+      .sort((a, b) => a.range[0] - b.range[0]);
+
     // This function formats the section string into a comment block header
     const COMMENT_HEADER_FORMAT = (section) => {
       return `/**************************************************************************\n * ${section.toUpperCase()}\n ***************************************************************************/`;
@@ -79,9 +85,17 @@ export default {
         return;
       }
 
-      // Find the nearest Block Comment before the startNode
-      const tokens = context.getSourceCode().getTokensBefore(startNode, {includeComments: true});
-      const comment = tokens.reverse().find(token => token.type === "Block");
+      // Find the nearest Block Comment before the startNode (using cached comments)
+      const nodeStart = startNode.range[0];
+      let comment = null;
+
+      for (let i = allBlockComments.length - 1; i >= 0; i--) {
+        if (allBlockComments[i].range[1] < nodeStart) {
+          comment = allBlockComments[i];
+
+          break;
+        }
+      }
 
       // Different types of nodes require different comment blocks
       switch (nodeType) {

package/rules/import-group-comment.js

@@ -20,6 +20,11 @@ export default {
   create(context) {
     const customGroups = context.options[0] || {};  // Get custom groups from options
 
+    // Pre-compile custom regexes once instead of on every import
+    const compiledCustomGroups = Object.entries(customGroups).map(
+      ([regexStr, group]) => [new RegExp(regexStr), group]
+    );
+
     let currentGroupComment = null;
 
     // Extract the directory name from the file path
@@ -29,10 +34,10 @@ export default {
     }
 
     function extractGroupFromPath(path, filePath) {
-      // Check custom regexes first
-      for (const regexStr in customGroups) {
-        if (new RegExp(regexStr).test(path)) {
-          return customGroups[regexStr];
+      // Check custom regexes first (using pre-compiled patterns)
+      for (const [regex, group] of compiledCustomGroups) {
+        if (regex.test(path)) {
+          return group;
         }
       }
 

package/rules/jsdoc-enforce-access.js

@@ -1,3 +1,6 @@
+// Pre-compiled regex for access modifier check
+const ACCESS_MODIFIER_PATTERN = /@(public|protected|private)/;
+
 export default {
   meta: {
     type: "problem",
@@ -9,14 +12,16 @@ export default {
   },
 
   create: function(context) {
-    function checkNodeForJSDoc(node, context) {
-      const comments = context.getSourceCode().getCommentsBefore(node);
+    const sourceCode = context.sourceCode || context.getSourceCode();
+
+    function checkNodeForJSDoc(node) {
+      const comments = sourceCode.getCommentsBefore(node);
 
       if (comments.length > 0) {
         const lastComment = comments[comments.length - 1];
 
         if (lastComment.type === "Block" && lastComment.value.startsWith("*")) {
-          if (!/@(public|protected|private)/.test(lastComment.value)) {
+          if (!ACCESS_MODIFIER_PATTERN.test(lastComment.value)) {
             context.report({
               node,
               message: "JSDoc comment should contain @public, @protected or @private",
@@ -33,20 +38,20 @@ export default {
       Property(node) {
         if (node.value.type === "FunctionExpression" ||
         node.value.type === "ArrowFunctionExpression") {
-          checkNodeForJSDoc(node, context);
+          checkNodeForJSDoc(node);
         }
       },
 
       MethodDefinition(node) {
-        checkNodeForJSDoc(node, context);
+        checkNodeForJSDoc(node);
       },
 
       FunctionDeclaration(node) {
-        checkNodeForJSDoc(node, context);
+        checkNodeForJSDoc(node);
       },
 
       FunctionExpression(node) {
-        checkNodeForJSDoc(node, context);
+        checkNodeForJSDoc(node);
       },
     };
   }

package/rules/methods-ordering.js

@@ -1,15 +1,19 @@
 import doctrine from "doctrine";
 
+// Pre-compiled regex for section comment matching
+const SECTION_COMMENT_PATTERN = /--> (.*) <--/;
+
 export default {
   create(context) {
     let methodOrder = []; // Keep track of method order
+    const sourceCode = context.sourceCode || context.getSourceCode();
 
     return {
       MethodDefinition(node) {
-        const commentsBefore = context.getSourceCode().getCommentsBefore(node);
+        const commentsBefore = sourceCode.getCommentsBefore(node);
 
         // Check if there is a comment matching `--> {VALUE} <--` before the node
-        const nodeComment = commentsBefore.find(comment => comment.type === "Line" && /--> (.*) <--/.test(comment.value));
+        const nodeComment = commentsBefore.find(comment => comment.type === "Line" && SECTION_COMMENT_PATTERN.test(comment.value));
 
         // Reset methodOrder if a matching comment was found
         if (nodeComment) {

package/rules/no-snake-case.js

@@ -1,3 +1,6 @@
+// Pre-compiled regex for constant naming check
+const UPPER_SNAKE_CASE_PATTERN = /^[A-Z][A-Z0-9_]*$/;
+
 export default {
   meta: {
     type: "suggestion",
@@ -26,7 +29,7 @@ export default {
       }
 
       // Allow UPPER_SNAKE_CASE for constants
-      if (isConstant && cleanName === cleanName.toUpperCase() && /^[A-Z][A-Z0-9_]*$/.test(cleanName)) {
+      if (isConstant && cleanName === cleanName.toUpperCase() && UPPER_SNAKE_CASE_PATTERN.test(cleanName)) {
         return false;
       }
 

package/rules/one-space-after-operator.js

@@ -23,7 +23,7 @@ export default {
     ]
   },
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode();
     const config = context.options[0] || {};
     const checkColon = config.checkColon !== false;
 

package/rules/vue-ref-case.js

@@ -1,5 +1,8 @@
 import utils from "eslint-plugin-vue/dist/utils/index.js";
 
+// Pre-compiled regex for snake_case ref validation
+const SNAKE_CASE_REF_PATTERN = /^[a-z]+(_[a-z]+)*$/;
+
 export default {
   meta: {
     type: "layout",
@@ -18,7 +21,7 @@ export default {
         if (node.value && node.value.type === "VLiteral") {
           const refValue = node.value.value;
 
-          if (refValue && !/^[a-z]+(_[a-z]+)*$/.test(refValue)) {
+          if (refValue && !SNAKE_CASE_REF_PATTERN.test(refValue)) {
             context.report({
               node,
               message: "Ref attribute \"{{refValue}}\" should be snake-cased.",