eslint-plugin-crisp 1.6.4 → 1.6.6

package/package.json

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

package/rules/header-comments-check.js

@@ -2,6 +2,12 @@ const COMMENT_HEADER_FORMAT = (section) => {
   return `/**************************************************************************\n * ${section.toUpperCase()}\n ***************************************************************************/`;
 };
 
+const HEADER_COMMENT_REGEX = /^\*+\n \* [A-Z][A-Z0-9 _:-]*\n \*+$/;
+
+function isHeaderComment(comment) {
+  return comment.type === "Block" && HEADER_COMMENT_REGEX.test(comment.value);
+}
+
 function isTypeComment(comment) {
   if (comment.type !== "Block" || !comment.value.startsWith("*")) {
     return false;
@@ -109,7 +115,7 @@ export default {
       category: "Best Practices",
       recommended: false,
     },
-    fixable: null,
+    fixable: "whitespace",
   },
 
   create(context) {
@@ -224,6 +230,30 @@ export default {
       }
     }
 
+    // Checks that a header comment block is followed by a blank line
+    function checkBlankLineAfterHeaders() {
+      for (const comment of allBlockComments) {
+        if (!isHeaderComment(comment)) {
+          continue;
+        }
+
+        const next = sourceCode.getTokenAfter(comment, { includeComments: true });
+
+        if (!next || next.loc.start.line - comment.loc.end.line >= 2) {
+          continue;
+        }
+
+        const isOnNextLine = next.loc.start.line - comment.loc.end.line === 1;
+
+        context.report({
+          loc: comment.loc,
+          message: "Header comment block must be followed by a blank line",
+
+          fix: isOnNextLine ? (fixer) => fixer.insertTextAfter(comment, "\n") : null,
+        });
+      }
+    }
+
     return {
       ":statement": (node) => {
         if (node.parent.type !== "Program") {
@@ -256,6 +286,9 @@ export default {
 
         // Check type comments group
         checkTypeCommentsGroup();
+
+        // Check blank line after header comments
+        checkBlankLineAfterHeaders();
       }
     };
   }

package/tests/rules/header-comments-check.test.js

@@ -12,17 +12,17 @@ ruleTester.run("header-comments-check", rule, {
   valid: [
     {
       filename: "/project/src/example.js",
-      code: `${header("IMPORTS")}\nimport value from "package";`
+      code: `${header("IMPORTS")}\n\nimport value from "package";`
     },
     {
       filename: "/project/src/example.ts",
-      code: `${header("CONSTANTS")}\nconst MAX_RETRIES = 3;\n\n${header("INSTANCES")}\nconst pattern = /value/;`
+      code: `${header("CONSTANTS")}\n\nconst MAX_RETRIES = 3;\n\n${header("INSTANCES")}\n\nconst pattern = /value/;`
     },
     {
       filename: "/project/src/example.js",
       code:
-        `${header("TYPES")}\n/** @typedef {string} Identifier */\n\n` +
-        `${header("EXPORTS")}\nexport default {};`
+        `${header("TYPES")}\n\n/** @typedef {string} Identifier */\n\n` +
+        `${header("EXPORTS")}\n\nexport default {};`
     },
     {
       filename: "/project/src/example.js",
@@ -30,12 +30,12 @@ ruleTester.run("header-comments-check", rule, {
     },
     {
       filename: "/project/src/example.js",
-      code: `${header("MIXIN TO MANAGE HANDOFF")}\nexport default {};`
+      code: `${header("MIXIN TO MANAGE HANDOFF")}\n\nexport default {};`
     },
     {
       filename: "/project/src/example.js",
       code:
-        `${header("IMPORTS")}\nimport first from "first";\n` +
+        `${header("IMPORTS")}\n\nimport first from "first";\n` +
         "import second from \"second\";"
     },
     {
@@ -84,6 +84,26 @@ ruleTester.run("header-comments-check", rule, {
           message: "Type comments group must be preceded by a 'TYPES' comment block"
         }
       ]
+    },
+    {
+      filename: "/project/src/example.js",
+      code: `${header("CONSTANTS")}\nconst MAX_RETRIES = 3;`,
+      output: `${header("CONSTANTS")}\n\nconst MAX_RETRIES = 3;`,
+      errors: [
+        {
+          message: "Header comment block must be followed by a blank line"
+        }
+      ]
+    },
+    {
+      filename: "/project/src/example.js",
+      code: `${header("IMPORTS")}\n// NPM\nimport value from "package";`,
+      output: `${header("IMPORTS")}\n\n// NPM\nimport value from "package";`,
+      errors: [
+        {
+          message: "Header comment block must be followed by a blank line"
+        }
+      ]
     }
   ]
 });