@depup/eslint-plugin-jsdoc 62.8.0-depup.0

package/src/rules/checkAccess.js

@@ -0,0 +1,45 @@
+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',
+  },
+});

package/src/rules/checkAlignment.js

@@ -0,0 +1,82 @@
+import iterateJsdoc from '../iterateJsdoc.js';
+
+export default iterateJsdoc(({
+  context,
+  indent,
+  jsdocNode,
+  report,
+  sourceCode,
+}) => {
+  const {
+    innerIndent = 1,
+  } = context.options[0] || {};
+
+  // `indent` is whitespace from line 1 (`/**`), so slice and account for "/".
+  const indentLevel = indent.length + innerIndent;
+  const sourceLines = sourceCode.getText(jsdocNode).split('\n')
+    .slice(1)
+    .map((line, number) => {
+      return {
+        line: line.split('*')[0],
+        number,
+      };
+    })
+    .filter(({
+      line,
+    }) => {
+      return !line.trimStart().length;
+    });
+
+  /** @type {import('eslint').Rule.ReportFixer} */
+  const fix = (fixer) => {
+    const replacement = sourceCode.getText(jsdocNode).split('\n')
+      .map((line, index) => {
+        // Ignore the first line and all lines not starting with `*`
+        const ignored = !index || line.split('*')[0].trimStart().length;
+
+        return ignored ? line : `${indent}${''.padStart(innerIndent, ' ')}${line.trimStart()}`;
+      })
+      .join('\n');
+
+    return fixer.replaceText(jsdocNode, replacement);
+  };
+
+  sourceLines.some(({
+    line,
+    number,
+  }) => {
+    if (line.length !== indentLevel) {
+      report('Expected JSDoc block to be aligned.', fix, {
+        line: number + 1,
+      });
+
+      return true;
+    }
+
+    return false;
+  });
+}, {
+  iterateAllJsdocs: true,
+  meta: {
+    docs: {
+      description: 'Reports invalid alignment of JSDoc block asterisks.',
+      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-alignment.md#repos-sticky-header',
+    },
+    fixable: 'code',
+    schema: [
+      {
+        additionalProperties: false,
+        properties: {
+          innerIndent: {
+            default: 1,
+            description: `Set to 0 if you wish to avoid the normal requirement for an inner indentation of
+one space. Defaults to 1 (one space of normal inner indentation).`,
+            type: 'integer',
+          },
+        },
+        type: 'object',
+      },
+    ],
+    type: 'layout',
+  },
+});