| import iterateJsdoc from '../iterateJsdoc.js'; |
| |
| const accessLevels = [ |
| 'package', 'private', 'protected', 'public', |
| ]; |
| |
| export default iterateJsdoc(({ |
| report, |
| utils, |
| }) => { |
| utils.forEachPreferredTag('access', (jsdocParameter, targetTagName) => { |
| const desc = jsdocParameter.name + ' ' + jsdocParameter.description; |
| |
| if (!accessLevels.includes(desc.trim())) { |
| report( |
| `Missing valid JSDoc @${targetTagName} level.`, |
| null, |
| jsdocParameter, |
| ); |
| } |
| }); |
| const accessLength = utils.getTags('access').length; |
| const individualTagLength = utils.getPresentTags(accessLevels).length; |
| if (accessLength && individualTagLength) { |
| report( |
| 'The @access tag may not be used with specific access-control tags (@package, @private, @protected, or @public).', |
| ); |
| } |
| |
| if (accessLength > 1 || individualTagLength > 1) { |
| report( |
| 'At most one access-control tag may be present on a JSDoc block.', |
| ); |
| } |
| }, { |
| checkPrivate: true, |
| iterateAllJsdocs: true, |
| meta: { |
| docs: { |
| description: 'Checks that `@access` tags have a valid value.', |
| url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-access.md#repos-sticky-header', |
| }, |
| type: 'suggestion', |
| }, |
| }); |