feat(require-template): add rule; fixes part of #1120

.README/README.md

@@ -236,6 +236,7 @@ non-default-recommended fixer).
 |:heavy_check_mark:|:wrench:|[check-tag-names](./docs/rules/check-tag-names.md#readme)|Reports invalid jsdoc (block) tag names|
 |:heavy_check_mark:|:wrench:|[check-types](./docs/rules/check-types.md#readme)|Reports types deemed invalid (customizable and with defaults, for preventing and/or recommending replacements)|
 |:heavy_check_mark:||[check-values](./docs/rules/check-values.md#readme)|Checks for expected content within some miscellaneous tags (`@version`, `@since`, `@license`, `@author`)|
+| || [convert-to-jsdoc-comments](./docs/rules/convert-to-jsdoc-comments.md#readme) | Converts line and block comments preceding or following specified nodes into JSDoc comments|
 |:heavy_check_mark:|:wrench:|[empty-tags](./docs/rules/empty-tags.md#readme)|Checks tags that are expected to be empty (e.g., `@abstract` or `@async`), reporting if they have content|
 |:heavy_check_mark:||[implements-on-classes](./docs/rules/implements-on-classes.md#readme)|Prohibits use of `@implements` on non-constructor functions (to enforce the tag only being used on classes/constructors)|
 |||[informative-docs](./docs/rules/informative-docs.md#readme)|Reports on JSDoc texts that serve only to restate their attached name.|
@@ -270,6 +271,7 @@ non-default-recommended fixer).
 |:heavy_check_mark:||[require-returns-check](./docs/rules/require-returns-check.md#readme)|Requires a return statement be present in a function body if a `@returns` tag is specified in the jsdoc comment block (and reports if multiple `@returns` tags are present).|
 |:heavy_check_mark:||[require-returns-description](./docs/rules/require-returns-description.md#readme)|Requires that the `@returns` tag has a `description` value (not including `void`/`undefined` type returns).|
 |:heavy_check_mark: (off in TS)||[require-returns-type](./docs/rules/require-returns-type.md#readme)|Requires that `@returns` tag has a type value (in curly brackets).|
+| || [require-template](./docs/rules/require-template.md#readme) | Requires `@template` tags be present when type parameters are used.|
 |||[require-throws](./docs/rules/require-throws.md#readme)|Requires that throw statements are documented|
 |:heavy_check_mark:||[require-yields](./docs/rules/require-yields.md#readme)|Requires that yields are documented|
 |:heavy_check_mark:||[require-yields-check](./docs/rules/require-yields-check.md#readme)|Ensures that if a `@yields` is present that a `yield` (or `yield` with a value) is present in the function body (or that if a `@next` is present that there is a `yield` with a return value present)|

.README/rules/require-template.md

@@ -0,0 +1,54 @@
+# `require-template`
+
+Checks to see that `@template` tags are present for any detected type
+parameters.
+
+Currently checks `TSTypeAliasDeclaration` such as:
+
+```ts
+export type Pairs<D, V> = [D, V | undefined];
+```
+
+or
+
+```js
+/**
+ * @typedef {[D, V | undefined]} Pairs
+ */
+```
+
+Note that in the latter TypeScript-flavor JavaScript example, there is no way
+for us to firmly distinguish between `D` and `V` as type parameters or as some
+other identifiers, so we use an algorithm that any single capital letters
+are assumed to be templates.
+
+## Options
+
+### `requireSeparateTemplates`
+
+Requires that each template have its own separate line, i.e., preventing
+templates of this format:
+
+```js
+/**
+ * @template T, U, V
+ */
+```
+
+Defaults to `false`.
+
+|||
+|---|---|
+|Context|everywhere|
+|Tags|`template`|
+|Recommended|true|
+|Settings||
+|Options|`requireSeparateTemplates`|
+
+## Failing examples
+
+<!-- assertions-failing requireTemplate -->
+
+## Passing examples
+
+<!-- assertions-passing requireTemplate -->

.github/workflows/feature.yaml

@@ -42,6 +42,7 @@ jobs:
         node_js_version:
           - '18'
           - '20'
+          - '22'
   build:
     runs-on: ubuntu-latest
     name: Build

.ncurc.cjs

@@ -2,7 +2,7 @@
 
 module.exports = {
   reject: [
-    // Todo: When package converted to ESM only
+    // Todo: When our package converted to ESM only
     'escape-string-regexp',
 
     // todo[engine:node@>=20]: Can reenable

README.md

@@ -263,6 +263,7 @@ non-default-recommended fixer).
 |:heavy_check_mark:|:wrench:|[check-tag-names](./docs/rules/check-tag-names.md#readme)|Reports invalid jsdoc (block) tag names|
 |:heavy_check_mark:|:wrench:|[check-types](./docs/rules/check-types.md#readme)|Reports types deemed invalid (customizable and with defaults, for preventing and/or recommending replacements)|
 |:heavy_check_mark:||[check-values](./docs/rules/check-values.md#readme)|Checks for expected content within some miscellaneous tags (`@version`, `@since`, `@license`, `@author`)|
+| || [convert-to-jsdoc-comments](./docs/rules/convert-to-jsdoc-comments.md#readme) | Converts line and block comments preceding or following specified nodes into JSDoc comments|
 |:heavy_check_mark:|:wrench:|[empty-tags](./docs/rules/empty-tags.md#readme)|Checks tags that are expected to be empty (e.g., `@abstract` or `@async`), reporting if they have content|
 |:heavy_check_mark:||[implements-on-classes](./docs/rules/implements-on-classes.md#readme)|Prohibits use of `@implements` on non-constructor functions (to enforce the tag only being used on classes/constructors)|
 |||[informative-docs](./docs/rules/informative-docs.md#readme)|Reports on JSDoc texts that serve only to restate their attached name.|
@@ -297,6 +298,7 @@ non-default-recommended fixer).
 |:heavy_check_mark:||[require-returns-check](./docs/rules/require-returns-check.md#readme)|Requires a return statement be present in a function body if a `@returns` tag is specified in the jsdoc comment block (and reports if multiple `@returns` tags are present).|
 |:heavy_check_mark:||[require-returns-description](./docs/rules/require-returns-description.md#readme)|Requires that the `@returns` tag has a `description` value (not including `void`/`undefined` type returns).|
 |:heavy_check_mark: (off in TS)||[require-returns-type](./docs/rules/require-returns-type.md#readme)|Requires that `@returns` tag has a type value (in curly brackets).|
+| || [require-template](./docs/rules/require-template.md#readme) | Requires `@template` tags be present when type parameters are used.|
 |||[require-throws](./docs/rules/require-throws.md#readme)|Requires that throw statements are documented|
 |:heavy_check_mark:||[require-yields](./docs/rules/require-yields.md#readme)|Requires that yields are documented|
 |:heavy_check_mark:||[require-yields-check](./docs/rules/require-yields-check.md#readme)|Ensures that if a `@yields` is present that a `yield` (or `yield` with a value) is present in the function body (or that if a `@next` is present that there is a `yield` with a return value present)|

docs/rules/require-template.md

@@ -0,0 +1,147 @@
+<a name="user-content-require-template"></a>
+<a name="require-template"></a>
+# <code>require-template</code>
+
+Checks to see that `@template` tags are present for any detected type
+parameters.
+
+Currently checks `TSTypeAliasDeclaration` such as:
+
+```ts
+export type Pairs<D, V> = [D, V | undefined];
+```
+
+or
+
+```js
+/**
+ * @typedef {[D, V | undefined]} Pairs
+ */
+```
+
+Note that in the latter TypeScript-flavor JavaScript example, there is no way
+for us to firmly distinguish between `D` and `V` as type parameters or as some
+other identifiers, so we use an algorithm that any single capital letters
+are assumed to be templates.
+
+<a name="user-content-require-template-options"></a>
+<a name="require-template-options"></a>
+## Options
+
+<a name="user-content-require-template-options-requireseparatetemplates"></a>
+<a name="require-template-options-requireseparatetemplates"></a>
+### <code>requireSeparateTemplates</code>
+
+Requires that each template have its own separate line, i.e., preventing
+templates of this format:
+
+```js
+/**
+ * @template T, U, V
+ */
+```
+
+Defaults to `false`.
+
+|||
+|---|---|
+|Context|everywhere|
+|Tags|`template`|
+|Recommended|true|
+|Settings||
+|Options|`requireSeparateTemplates`|
+
+<a name="user-content-require-template-failing-examples"></a>
+<a name="require-template-failing-examples"></a>
+## Failing examples
+
+The following patterns are considered problems:
+
+````js
+/**
+ *
+ */
+type Pairs<D, V> = [D, V | undefined];
+// Message: Missing @template D
+
+/**
+ *
+ */
+export type Pairs<D, V> = [D, V | undefined];
+// Message: Missing @template D
+
+/**
+ * @typedef {[D, V | undefined]} Pairs
+ */
+// Message: Missing @template D
+
+/**
+ * @typedef {[D, V | undefined]} Pairs
+ */
+// Settings: {"jsdoc":{"mode":"permissive"}}
+// Message: Missing @template D
+
+/**
+ * @template D, U
+ */
+export type Extras<D, U, V> = [D, U, V | undefined];
+// Message: Missing @template V
+
+/**
+ * @template D, U
+ * @typedef {[D, U, V | undefined]} Extras
+ */
+// Message: Missing @template V
+
+/**
+ * @template D, V
+ */
+export type Pairs<D, V> = [D, V | undefined];
+// "jsdoc/require-template": ["error"|"warn", {"requireSeparateTemplates":true}]
+// Message: Missing separate @template for V
+
+/**
+ * @template D, V
+ * @typedef {[D, V | undefined]} Pairs
+ */
+// "jsdoc/require-template": ["error"|"warn", {"requireSeparateTemplates":true}]
+// Message: Missing separate @template for V
+````
+
+
+
+<a name="user-content-require-template-passing-examples"></a>
+<a name="require-template-passing-examples"></a>
+## Passing examples
+
+The following patterns are not considered problems:
+
+````js
+/**
+ * @template D
+ * @template V
+ */
+export type Pairs<D, V> = [D, V | undefined];
+
+/**
+ * @template D
+ * @template V
+ * @typedef {[D, V | undefined]} Pairs
+ */
+
+/**
+ * @template D, U, V
+ */
+export type Extras<D, U, V> = [D, U, V | undefined];
+
+/**
+ * @template D, U, V
+ * @typedef {[D, U, V | undefined]} Extras
+ */
+
+/**
+ * @typedef {[D, U, V | undefined]} Extras
+ * @typedef {[D, U, V | undefined]} Extras
+ */
+````
+

package.json

@@ -5,7 +5,7 @@
     "url": "http://gajus.com"
   },
   "dependencies": {
-    "@es-joy/jsdoccomment": "~0.45.0",
+    "@es-joy/jsdoccomment": "~0.46.0",
     "are-docs-informative": "^0.0.2",
     "comment-parser": "1.4.1",
     "debug": "^4.3.5",
@@ -54,7 +54,7 @@
     "eslint": "9.6.0",
     "eslint-config-canonical": "~43.0.13",
     "espree": "^10.1.0",
-    "gitdown": "^3.1.5",
+    "gitdown": "^4.0.0",
     "glob": "^10.4.2",
     "globals": "^15.8.0",
     "husky": "^9.0.11",