feat(check-line-alignment): add template to default tags (#1427)

remcohaszing · web-flow · commit 4c65cbe36ca0 · 2025-07-15T22:44:08.000+08:00
* feat(`check-line-alignment`): add `template` to default tags

The `@template` tag annotates TypeScript type arguments. It make sense
to treat it the same as `@param`.

* docs(`check-line-alignment`): document template tag

* docs(`check-line-alignment`): add `template` tag
diff --git a/.README/rules/check-line-alignment.md b/.README/rules/check-line-alignment.md
@@ -25,7 +25,7 @@ After the string, an options object is allowed with the following properties.
 ### `tags`
 
 Use this to change the tags which are sought for alignment changes. Defaults to an array of
-`['param', 'arg', 'argument', 'property', 'prop', 'returns', 'return']`.
+`['param', 'arg', 'argument', 'property', 'prop', 'returns', 'return', 'template']`.
 
 ### `customSpacings`
 
diff --git a/docs/rules/check-line-alignment.md b/docs/rules/check-line-alignment.md
@@ -43,7 +43,7 @@ After the string, an options object is allowed with the following properties.
 ### <code>tags</code>
 
 Use this to change the tags which are sought for alignment changes. Defaults to an array of
-`['param', 'arg', 'argument', 'property', 'prop', 'returns', 'return']`.
+`['param', 'arg', 'argument', 'property', 'prop', 'returns', 'return', 'template']`.
 
 <a name="user-content-check-line-alignment-options-customspacings"></a>
 <a name="check-line-alignment-options-customspacings"></a>
@@ -1014,4 +1014,3 @@ function quux () {
 const fn = ( lorem ) => {}
 // "jsdoc/check-line-alignment": ["error"|"warn", "any",{"disableWrapIndent":true,"wrapIndent":"  "}]
 ````
-
diff --git a/src/rules/checkLineAlignment.js b/src/rules/checkLineAlignment.js
@@ -229,7 +229,7 @@ export default iterateJsdoc(({
     disableWrapIndent = false,
     preserveMainDescriptionPostDelimiter,
     tags: applicableTags = [
-      'param', 'arg', 'argument', 'property', 'prop', 'returns', 'return',
+      'param', 'arg', 'argument', 'property', 'prop', 'returns', 'return', 'template',
     ],
     wrapIndent = '',
   } = context.options[1] || {};
diff --git a/test/rules/assertions/checkLineAlignment.js b/test/rules/assertions/checkLineAlignment.js
@@ -182,6 +182,36 @@ export default /** @type {import('../index.js').TestCases} */ ({
         const fn = ( lorem, sit ) => {}
       `,
     },
+    {
+      code: `
+        /**
+         * Function description.
+         *
+         * @template  {string} Arg Description.
+         * @param     {Arg}    arg Description
+         */
+        function hello(arg) {}
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Expected JSDoc block lines to be aligned.',
+          type: 'Block',
+        },
+      ],
+      options: [
+        'always',
+      ],
+      output: `
+        /**
+         * Function description.
+         *
+         * @template {string} Arg Description.
+         * @param    {Arg}    arg Description
+         */
+        function hello(arg) {}
+      `,
+    },
     {
       code: `
         /**
