docs(check-line-alignment): add example with multiline type; #743

gajus · May 18, 2021 · 4c6fda7 · 4c6fda7
1 parent 03d3f40
commit 4c6fda7
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2320,6 +2320,15 @@ 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:

diff --git a/test/rules/assertions/checkLineAlignment.js b/test/rules/assertions/checkLineAlignment.js
@@ -1057,6 +1057,38 @@ 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: [
     {