eslint-plugin-crisp 1.4.13 → 1.4.15

package/index.js

@@ -17,6 +17,7 @@ import ruleImportGroupOrder from "./rules/import-group-order.js";
 import ruleJsdocAlignParams from "./rules/jsdoc-align-params.js";
 import ruleJsdocCheckIndentation from "./rules/jsdoc-check-indentation.js";
 import ruleJsdocCheckOptionalParams from "./rules/jsdoc-check-optional-params.js";
+import ruleJsdocDescriptionMultiline from "./rules/jsdoc-description-multiline.js";
 import ruleJsdocEnforceAccess from "./rules/jsdoc-enforce-access.js";
 import ruleJsdocEnforceClassdesc from "./rules/jsdoc-enforce-classdesc.js";
 import ruleJsdocNoParamReturn from "./rules/jsdoc-no-param-return.js";
@@ -83,6 +84,7 @@ const plugin = {
     "jsdoc-align-params": ruleJsdocAlignParams,
     "jsdoc-check-indentation": ruleJsdocCheckIndentation,
     "jsdoc-check-optional-params": ruleJsdocCheckOptionalParams,
+    "jsdoc-description-multiline": ruleJsdocDescriptionMultiline,
     "jsdoc-enforce-access": ruleJsdocEnforceAccess,
     "jsdoc-enforce-classdesc": ruleJsdocEnforceClassdesc,
     "jsdoc-no-param-return": ruleJsdocNoParamReturn,

package/package.json

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

package/recommended-ts.js

@@ -184,6 +184,7 @@ export default function configRecommendedTS(pluginCrisp) {
 
         // Crisp JSDoc rules
         "crisp/jsdoc-description-length": "error",
+        "crisp/jsdoc-description-multiline": "error",
         "crisp/jsdoc-no-param-return": "error",
 
         // General JSDoc rules

package/rules/jsdoc-description-multiline.js

@@ -0,0 +1,45 @@
+import iterateJsdoc from "eslint-plugin-jsdoc/iterateJsdoc.js";
+
+export default iterateJsdoc.default(({
+  context,
+  indent,
+  jsdocNode,
+  sourceCode
+}) => {
+  if (jsdocNode.loc.start.line !== jsdocNode.loc.end.line) {
+    return;
+  }
+
+  const description = sourceCode
+    .getText(jsdocNode)
+    .slice(3, -2)
+    .trim();
+
+  // Keep empty and tag-only JSDoc comments unchanged.
+  if (!description || description.startsWith("@")) {
+    return;
+  }
+
+  context.report({
+    node: jsdocNode,
+    messageId: "multiline",
+    fix(fixer) {
+      return fixer.replaceText(
+        jsdocNode,
+        `/**\n${indent} * ${description}\n${indent} */`
+      );
+    }
+  });
+}, {
+  meta: {
+    type: "layout",
+    docs: {
+      description: "Enforce multiline formatting for function JSDoc descriptions."
+    },
+    fixable: "whitespace",
+    schema: [],
+    messages: {
+      multiline: "Function JSDoc descriptions must use multiline formatting."
+    }
+  }
+});