node/tools/eslint/node_modules/eslint-plugin-jsdoc/src/rules/requirePropertyDescription.js
Michaël Zasso 2eff28fb7a
tools: move ESLint to tools/eslint
Greatly simplify how ESLint and its plugins are installed.

PR-URL: https://github.com/nodejs/node/pull/53413
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2024-06-19 19:54:08 +00:00

26 lines
656 B
JavaScript

import iterateJsdoc from '../iterateJsdoc.js';
export default iterateJsdoc(({
report,
utils,
}) => {
utils.forEachPreferredTag('property', (jsdoc, targetTagName) => {
if (!jsdoc.description.trim()) {
report(
`Missing JSDoc @${targetTagName} "${jsdoc.name}" description.`,
null,
jsdoc,
);
}
});
}, {
iterateAllJsdocs: true,
meta: {
docs: {
description: 'Requires that each `@property` tag has a `description` value.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-description.md#repos-sticky-header',
},
type: 'suggestion',
},
});