Fix indentation with tabs

gajus · May 7, 2021 · ed1df26 · ed1df26
1 parent 65528e2
commit ed1df26
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 7 deletions.
diff --git a/src/alignTransform.js b/src/alignTransform.js
@@ -58,7 +58,7 @@ const space = (len) => {
   return ''.padStart(len, ' ');
 };
 
-const alignTransform = (tags) => {
+const alignTransform = (tags, indent) => {
   let intoTags = false;
   let width;
 
@@ -120,7 +120,7 @@ const alignTransform = (tags) => {
 
     // dangling '*/'
     if (tokens.end === Markers.end && isEmpty) {
-      tokens.start = space(width.start + 1);
+      tokens.start = indent + ' ';
 
       return {
         ...line,
@@ -131,16 +131,16 @@ const alignTransform = (tags) => {
     /* eslint-disable indent */
     switch (tokens.delimiter) {
       case Markers.start:
-        tokens.start = space(width.start);
+        tokens.start = indent;
         break;
       case Markers.delim:
-        tokens.start = space(width.start + 1);
+        tokens.start = indent + ' ';
         break;
       default:
         tokens.delimiter = '';
 
         // compensate delimiter
-        tokens.start = space(width.start + 2);
+        tokens.start = indent + '  ';
     }
     /* eslint-enable */
 

diff --git a/src/rules/checkLineAlignment.js b/src/rules/checkLineAlignment.js
@@ -6,7 +6,6 @@ import iterateJsdoc from '../iterateJsdoc';
 
 const {
   flow: commentFlow,
-  indent: commentIndent,
 } = transforms;
 
 const checkNotAlignedPerTag = (utils, tag) => {
@@ -105,7 +104,7 @@ const checkAlignment = ({
   tags,
   utils,
 }) => {
-  const transform = commentFlow(alignTransform(tags), commentIndent(indent.length));
+  const transform = commentFlow(alignTransform(tags, indent));
   const transformedJsdoc = transform(jsdoc);
 
   const comment = '/*' + jsdocNode.value + '*/';

diff --git a/test/rules/assertions/checkLineAlignment.js b/test/rules/assertions/checkLineAlignment.js
@@ -29,6 +29,37 @@ export default {
         const fn = ( lorem, sit ) => {}
       `,
     },
+    /* eslint-disable no-tabs */
+    {
+      code: `
+				/**
+				 * With tabs.
+				 *
+				 * @param {string} lorem Description.
+				 * @param {int} sit Description multi words.
+				 */
+        const fn = ( lorem, sit ) => {}
+      `,
+      errors: [
+        {
+          message: 'Expected JSDoc block lines to be aligned.',
+          type: 'Block',
+        },
+      ],
+      options: [
+        'always',
+      ],
+      output: `
+				/**
+				 * With tabs.
+				 *
+				 * @param {string} lorem Description.
+				 * @param {int}    sit   Description multi words.
+				 */
+        const fn = ( lorem, sit ) => {}
+      `,
+    },
+    /* eslint-enable no-tabs */
     {
       code: `
         /**
@@ -845,6 +876,22 @@ export default {
         'always',
       ],
     },
+    /* eslint-disable no-tabs */
+    {
+      code: `
+				/**
+				 * With tabs.
+				 *
+				 * @param {string} lorem Description.
+				 * @param {int}    sit   Description multi words.
+				 */
+        const fn = ( lorem, sit ) => {}
+      `,
+      options: [
+        'always',
+      ],
+    },
+    /* eslint-enable no-tabs */
     {
       code: `
         /**