eslint-plugin-jsdoc 65.1.0 → 65.2.0

package/dist/rules.d.ts

@@ -7,6 +7,10 @@ export interface Rules {
     | []
     | [
         {
+          /**
+           * Whether to ignore empty and whitespace-only lines (e.g., to allow a formatter to handle)
+           */
+          ignoreEmptyLines?: boolean;
           /**
            * Set to 0 if you wish to avoid the normal requirement for an inner indentation of
            * one space. Defaults to 1 (one space of normal inner indentation).

package/package.json

@@ -163,5 +163,5 @@
     "test-cov": "TIMING=1 c8 --reporter text pnpm run test-no-cov",
     "test-index": "pnpm run test-no-cov test/rules/index.js"
   },
-  "version": "65.1.0"
+  "version": "65.2.0"
 }

package/src/rules/checkAlignment.js

@@ -8,6 +8,7 @@ export default iterateJsdoc(({
   sourceCode,
 }) => {
   const {
+    ignoreEmptyLines = false,
     innerIndent = 1,
   } = context.options[0] || {};
 
@@ -15,6 +16,9 @@ export default iterateJsdoc(({
   const indentLevel = indent.length + innerIndent;
   const sourceLines = sourceCode.getText(jsdocNode).split('\n')
     .slice(1)
+    .filter((line) => {
+      return !ignoreEmptyLines || line.trim();
+    })
     .map((line, number) => {
       return {
         line: line.split('*')[0],
@@ -67,6 +71,10 @@ export default iterateJsdoc(({
       {
         additionalProperties: false,
         properties: {
+          ignoreEmptyLines: {
+            description: 'Whether to ignore empty and whitespace-only lines (e.g., to allow a formatter to handle)',
+            type: 'boolean',
+          },
           innerIndent: {
             default: 1,
             description: `Set to 0 if you wish to avoid the normal requirement for an inner indentation of

package/src/rules.d.ts

@@ -7,6 +7,10 @@ export interface Rules {
     | []
     | [
         {
+          /**
+           * Whether to ignore empty and whitespace-only lines (e.g., to allow a formatter to handle)
+           */
+          ignoreEmptyLines?: boolean;
           /**
            * Set to 0 if you wish to avoid the normal requirement for an inner indentation of
            * one space. Defaults to 1 (one space of normal inner indentation).