feat(check-alignment): add innerIndent integer option; fixes #1351 (#1471)

Author: brettz9

docs/rules/check-alignment.md

@@ -117,6 +117,27 @@ export const myVar = {/**
   myProperty: 'hello'
 }
 // Message: Expected JSDoc block to be aligned.
+
+/**
+ * @param {Number} foo
+* @access private
+*/
+function quux (foo) {
+  // with spaces
+}
+// "jsdoc/check-alignment": ["error"|"warn", {"innerIndent":0}]
+// Message: Expected JSDoc block to be aligned.
+
+/**
+Some desc.
+@param {Number} foo
+@access private
+ */
+function quux (foo) {
+  // with spaces
+}
+// "jsdoc/check-alignment": ["error"|"warn", {"innerIndent":0}]
+// Message: Expected JSDoc block to be aligned.
 ````
 
 
@@ -172,5 +193,24 @@ function quux (foo) {
   // with spaces
 }
 // Settings: {"jsdoc":{"ignorePrivate":true}}
+
+/**
+* @param {Number} foo
+* @access private
+*/
+function quux (foo) {
+  // with spaces
+}
+// "jsdoc/check-alignment": ["error"|"warn", {"innerIndent":0}]
+
+/**
+Some desc.
+@param {Number} foo
+@access private
+*/
+function quux (foo) {
+  // with spaces
+}
+// "jsdoc/check-alignment": ["error"|"warn", {"innerIndent":0}]
 ````
 

src/rules/checkAlignment.js

@@ -1,48 +1,53 @@
 import iterateJsdoc from '../iterateJsdoc.js';
 
-/**
- * @param {string} string
- * @returns {string}
- */
-const trimStart = (string) => {
-  return string.replace(/^\s+/v, '');
-};
-
 export default iterateJsdoc(({
+  context,
   indent,
   jsdocNode,
   report,
   sourceCode,
 }) => {
+  const {
+    innerIndent = 1,
+  } = context.options[0] || {};
+
   // `indent` is whitespace from line 1 (`/**`), so slice and account for "/".
-  const indentLevel = indent.length + 1;
+  const indentLevel = indent.length + innerIndent;
   const sourceLines = sourceCode.getText(jsdocNode).split('\n')
     .slice(1)
-    .map((line) => {
-      return line.split('*')[0];
+    .map((line, number) => {
+      return {
+        line: line.split('*')[0],
+        number,
+      };
     })
-    .filter((line) => {
-      return !trimStart(line).length;
+    .filter(({
+      line,
+    }) => {
+      return !line.trimStart().length;
     });
 
   /** @type {import('eslint').Rule.ReportFixer} */
   const fix = (fixer) => {
     const replacement = sourceCode.getText(jsdocNode).split('\n')
       .map((line, index) => {
         // Ignore the first line and all lines not starting with `*`
-        const ignored = !index || trimStart(line.split('*')[0]).length;
+        const ignored = !index || line.split('*')[0].trimStart().length;
 
-        return ignored ? line : `${indent} ${trimStart(line)}`;
+        return ignored ? line : `${indent}${''.padStart(innerIndent, ' ')}${line.trimStart()}`;
       })
       .join('\n');
 
     return fixer.replaceText(jsdocNode, replacement);
   };
 
-  sourceLines.some((line, lineNum) => {
+  sourceLines.some(({
+    line,
+    number,
+  }) => {
     if (line.length !== indentLevel) {
       report('Expected JSDoc block to be aligned.', fix, {
-        line: lineNum + 1,
+        line: number + 1,
       });
 
       return true;
@@ -58,6 +63,17 @@ export default iterateJsdoc(({
       url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-alignment.md#repos-sticky-header',
     },
     fixable: 'code',
+    schema: [
+      {
+        additionalProperties: false,
+        properties: {
+          innerIndent: {
+            default: 1,
+            type: 'integer',
+          },
+        },
+      },
+    ],
     type: 'layout',
   },
 });

test/rules/assertions/checkAlignment.js

@@ -258,6 +258,70 @@ export const myVar = {/**
 }
 `,
     },
+    {
+      code: `
+        /**
+         * @param {Number} foo
+        * @access private
+        */
+        function quux (foo) {
+          // with spaces
+        }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Expected JSDoc block to be aligned.',
+        },
+      ],
+      options: [
+        {
+          innerIndent: 0,
+        },
+      ],
+      output: `
+        /**
+        * @param {Number} foo
+        * @access private
+        */
+        function quux (foo) {
+          // with spaces
+        }
+      `,
+    },
+    {
+      code: `
+        /**
+        Some desc.
+        @param {Number} foo
+        @access private
+         */
+        function quux (foo) {
+          // with spaces
+        }
+      `,
+      errors: [
+        {
+          line: 6,
+          message: 'Expected JSDoc block to be aligned.',
+        },
+      ],
+      options: [
+        {
+          innerIndent: 0,
+        },
+      ],
+      output: `
+        /**
+        Some desc.
+        @param {Number} foo
+        @access private
+        */
+        function quux (foo) {
+          // with spaces
+        }
+      `,
+    },
   ],
   valid: [
     {
@@ -328,5 +392,38 @@ export const myVar = {/**
         },
       },
     },
+    {
+      code: `
+        /**
+        * @param {Number} foo
+        * @access private
+        */
+        function quux (foo) {
+          // with spaces
+        }
+      `,
+      options: [
+        {
+          innerIndent: 0,
+        },
+      ],
+    },
+    {
+      code: `
+        /**
+        Some desc.
+        @param {Number} foo
+        @access private
+        */
+        function quux (foo) {
+          // with spaces
+        }
+      `,
+      options: [
+        {
+          innerIndent: 0,
+        },
+      ],
+    },
   ],
 });