fix(check-line-alignment): add multiline type workaround (#744); fi…

…xes part of #743 Workaround for recursive fixing of multiline type alignment Co-authored-by: Renatho De Carli Rosa <renatho@automattic.com> Co-authored-by: Brett Zamir <brettz9@yahoo.com>
gajus · May 19, 2021 · 9928298 · 9928298
1 parent d39292f
commit 9928298
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 41 deletions.
diff --git a/README.md b/README.md
@@ -2320,15 +2320,6 @@ const fn = ( lorem, sit ) => {}
 const fn = ( lorem, sit ) => {}
 // "jsdoc/check-line-alignment": ["error"|"warn", "never",{"customSpacings":{"postName":3}}]
 // Message: Expected JSDoc block lines to not be aligned.
-
-/**
- * @param {{
- * ids: number[]
- * }} params
- */
-const myMethod = ({ids}) => {}
-// "jsdoc/check-line-alignment": ["error"|"warn", "always"]
-// Message: Expected JSDoc block lines to be aligned.
 ````
 
 The following patterns are not considered problems:
@@ -2576,6 +2567,14 @@ const fn = ( lorem, sit ) => {}
  */
 const fn = ( lorem, sit ) => {}
 // "jsdoc/check-line-alignment": ["error"|"warn", "never",{"customSpacings":{"postDelimiter":2,"postTag":3,"postType":2}}]
+
+/**
+ * @param {{
+ *        ids: number[]
+ *        }}            params
+ */
+const fn = ({ids}) => {}
+// "jsdoc/check-line-alignment": ["error"|"warn", "always"]
 ````
 
 

diff --git a/src/alignTransform.js b/src/alignTransform.js
@@ -101,6 +101,11 @@ const alignTransform = ({
       }
     }
 
+    // Todo: Avoid fixing alignment of blocks with multiline wrapping of type
+    if (tokens.tag === '' && tokens.type) {
+      return tokens;
+    }
+
     const spacings = {
       postDelimiter: customSpacings?.postDelimiter || 1,
       postName: customSpacings?.postName || 1,

diff --git a/test/rules/assertions/checkLineAlignment.js b/test/rules/assertions/checkLineAlignment.js
@@ -1057,38 +1057,6 @@ export default {
       const fn = ( lorem, sit ) => {}
       `,
     },
-    {
-      /* eslint-disable no-tabs */
-      code: `
-				/**
-				 * @param {{
-				 * ids: number[]
-				 * }} params
-				 */
-				const myMethod = ({ids}) => {}
-			`,
-      errors: [
-        {
-          line: 2,
-          message: 'Expected JSDoc block lines to be aligned.',
-          type: 'Block',
-        },
-      ],
-      options: ['always'],
-      output: `
-				/**
-				 * @param {{
-				 *        ids: number[]
-				 *        }}            params
-				 */
-				const myMethod = ({ids}) => {}
-			`,
-      /* eslint-enable no-tabs */
-      parser: require.resolve('@babel/eslint-parser'),
-      parserOptions: {
-        ecmaVersion: 2_021,
-      },
-    },
   ],
   valid: [
     {
@@ -1467,5 +1435,16 @@ export default {
         },
       }],
     },
+    {
+      code: `
+        /**
+         * @param {{
+         *        ids: number[]
+         *        }}            params
+         */
+        const fn = ({ids}) => {}
+      `,
+      options: ['always'],
+    },
   ],
 };