Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/rules/require-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -354,5 +354,13 @@ export default class <NumType> {
* @callback
* @returns {[Something | undefined]}
*/

/**
* @template {string | Buffer} [T=string, U=number]
* @typedef {object} Dirent
* @property {T} name name
* @property {U} aNumber number
* @property {string} parentPath path
*/
````

2 changes: 1 addition & 1 deletion src/jsdocUtils.js
Original file line number Diff line number Diff line change
Expand Up @@ -1495,7 +1495,7 @@ const parseClosureTemplateTag = (tag) => {
return tag.name
.split(',')
.map((type) => {
return type.trim().replace(/^\[(?<name>.*?)=.*\]$/u, '$<name>');
return type.trim().replace(/^\[?(?<name>.*?)=.*$/u, '$<name>');
});
};

Expand Down
22 changes: 11 additions & 11 deletions src/rules/requireTemplate.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,19 @@ export default iterateJsdoc(({

const usedNames = new Set();
const templateTags = utils.getTags('template');
const templateNames = templateTags.flatMap(({
name,
}) => {
return name.split(/,\s*/u);
const templateNames = templateTags.flatMap((tag) => {
return utils.parseClosureTemplateTag(tag);
});

for (const tag of templateTags) {
const {
name,
} = tag;
const names = name.split(/,\s*/u);
if (requireSeparateTemplates && names.length > 1) {
report(`Missing separate @template for ${names[1]}`, null, tag);
if (requireSeparateTemplates) {
for (const tag of templateTags) {
const {
name,
} = tag;
const names = name.split(/,\s*/u);
if (names.length > 1) {
report(`Missing separate @template for ${names[1]}`, null, tag);
}
}
}

Expand Down
11 changes: 11 additions & 0 deletions test/rules/assertions/requireTemplate.js
Original file line number Diff line number Diff line change
Expand Up @@ -634,5 +634,16 @@ export default /** @type {import('../index.js').TestCases} */ ({
*/
`,
},
{
code: `
/**
* @template {string | Buffer} [T=string, U=number]
* @typedef {object} Dirent
* @property {T} name name
* @property {U} aNumber number
* @property {string} parentPath path
*/
`,
},
],
});
Loading