eslint-plugin-jsdoc 55.3.0 → 56.0.0

package/dist/cjs/index-cjs.js

@@ -0,0 +1,492 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getJsdocProcessorPlugin_js_1 = require("./getJsdocProcessorPlugin.js");
+const checkAccess_js_1 = __importDefault(require("./rules/checkAccess.js"));
+const checkAlignment_js_1 = __importDefault(require("./rules/checkAlignment.js"));
+const checkExamples_js_1 = __importDefault(require("./rules/checkExamples.js"));
+const checkIndentation_js_1 = __importDefault(require("./rules/checkIndentation.js"));
+const checkLineAlignment_js_1 = __importDefault(require("./rules/checkLineAlignment.js"));
+const checkParamNames_js_1 = __importDefault(require("./rules/checkParamNames.js"));
+const checkPropertyNames_js_1 = __importDefault(require("./rules/checkPropertyNames.js"));
+const checkSyntax_js_1 = __importDefault(require("./rules/checkSyntax.js"));
+const checkTagNames_js_1 = __importDefault(require("./rules/checkTagNames.js"));
+const checkTemplateNames_js_1 = __importDefault(require("./rules/checkTemplateNames.js"));
+const checkTypes_js_1 = __importDefault(require("./rules/checkTypes.js"));
+const checkValues_js_1 = __importDefault(require("./rules/checkValues.js"));
+const convertToJsdocComments_js_1 = __importDefault(require("./rules/convertToJsdocComments.js"));
+const emptyTags_js_1 = __importDefault(require("./rules/emptyTags.js"));
+const implementsOnClasses_js_1 = __importDefault(require("./rules/implementsOnClasses.js"));
+const importsAsDependencies_js_1 = __importDefault(require("./rules/importsAsDependencies.js"));
+const informativeDocs_js_1 = __importDefault(require("./rules/informativeDocs.js"));
+const linesBeforeBlock_js_1 = __importDefault(require("./rules/linesBeforeBlock.js"));
+const matchDescription_js_1 = __importDefault(require("./rules/matchDescription.js"));
+const matchName_js_1 = __importDefault(require("./rules/matchName.js"));
+const multilineBlocks_js_1 = __importDefault(require("./rules/multilineBlocks.js"));
+const noBadBlocks_js_1 = __importDefault(require("./rules/noBadBlocks.js"));
+const noBlankBlockDescriptions_js_1 = __importDefault(require("./rules/noBlankBlockDescriptions.js"));
+const noBlankBlocks_js_1 = __importDefault(require("./rules/noBlankBlocks.js"));
+const noDefaults_js_1 = __importDefault(require("./rules/noDefaults.js"));
+const noMissingSyntax_js_1 = __importDefault(require("./rules/noMissingSyntax.js"));
+const noMultiAsterisks_js_1 = __importDefault(require("./rules/noMultiAsterisks.js"));
+const noRestrictedSyntax_js_1 = __importDefault(require("./rules/noRestrictedSyntax.js"));
+const noTypes_js_1 = __importDefault(require("./rules/noTypes.js"));
+const noUndefinedTypes_js_1 = __importDefault(require("./rules/noUndefinedTypes.js"));
+const requireAsteriskPrefix_js_1 = __importDefault(require("./rules/requireAsteriskPrefix.js"));
+const requireDescription_js_1 = __importDefault(require("./rules/requireDescription.js"));
+const requireDescriptionCompleteSentence_js_1 = __importDefault(require("./rules/requireDescriptionCompleteSentence.js"));
+const requireExample_js_1 = __importDefault(require("./rules/requireExample.js"));
+const requireFileOverview_js_1 = __importDefault(require("./rules/requireFileOverview.js"));
+const requireHyphenBeforeParamDescription_js_1 = __importDefault(require("./rules/requireHyphenBeforeParamDescription.js"));
+const requireJsdoc_js_1 = __importDefault(require("./rules/requireJsdoc.js"));
+const requireParam_js_1 = __importDefault(require("./rules/requireParam.js"));
+const requireParamDescription_js_1 = __importDefault(require("./rules/requireParamDescription.js"));
+const requireParamName_js_1 = __importDefault(require("./rules/requireParamName.js"));
+const requireParamType_js_1 = __importDefault(require("./rules/requireParamType.js"));
+const requireProperty_js_1 = __importDefault(require("./rules/requireProperty.js"));
+const requirePropertyDescription_js_1 = __importDefault(require("./rules/requirePropertyDescription.js"));
+const requirePropertyName_js_1 = __importDefault(require("./rules/requirePropertyName.js"));
+const requirePropertyType_js_1 = __importDefault(require("./rules/requirePropertyType.js"));
+const requireReturns_js_1 = __importDefault(require("./rules/requireReturns.js"));
+const requireReturnsCheck_js_1 = __importDefault(require("./rules/requireReturnsCheck.js"));
+const requireReturnsDescription_js_1 = __importDefault(require("./rules/requireReturnsDescription.js"));
+const requireReturnsType_js_1 = __importDefault(require("./rules/requireReturnsType.js"));
+const requireTemplate_js_1 = __importDefault(require("./rules/requireTemplate.js"));
+const requireThrows_js_1 = __importDefault(require("./rules/requireThrows.js"));
+const requireYields_js_1 = __importDefault(require("./rules/requireYields.js"));
+const requireYieldsCheck_js_1 = __importDefault(require("./rules/requireYieldsCheck.js"));
+const sortTags_js_1 = __importDefault(require("./rules/sortTags.js"));
+const tagLines_js_1 = __importDefault(require("./rules/tagLines.js"));
+const textEscaping_js_1 = __importDefault(require("./rules/textEscaping.js"));
+const typeFormatting_js_1 = __importDefault(require("./rules/typeFormatting.js"));
+const validTypes_js_1 = __importDefault(require("./rules/validTypes.js"));
+/* eslint-disable jsdoc/valid-types -- Bug */
+/**
+ * @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
+ * @typedef {"" | "-typescript" | "-typescript-flavor"} ConfigVariants
+ * @typedef {"" | "-error"} ErrorLevelVariants
+ * @type {import('eslint').ESLint.Plugin & {
+ *   configs: Record<`flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
+ *   import('eslint').Linter.Config>
+ * }}
+ */
+const index = {};
+/* eslint-enable jsdoc/valid-types -- Bug */
+index.configs = {};
+index.rules = {
+    'check-access': checkAccess_js_1.default,
+    'check-alignment': checkAlignment_js_1.default,
+    'check-examples': checkExamples_js_1.default,
+    'check-indentation': checkIndentation_js_1.default,
+    'check-line-alignment': checkLineAlignment_js_1.default,
+    'check-param-names': checkParamNames_js_1.default,
+    'check-property-names': checkPropertyNames_js_1.default,
+    'check-syntax': checkSyntax_js_1.default,
+    'check-tag-names': checkTagNames_js_1.default,
+    'check-template-names': checkTemplateNames_js_1.default,
+    'check-types': checkTypes_js_1.default,
+    'check-values': checkValues_js_1.default,
+    'convert-to-jsdoc-comments': convertToJsdocComments_js_1.default,
+    'empty-tags': emptyTags_js_1.default,
+    'implements-on-classes': implementsOnClasses_js_1.default,
+    'imports-as-dependencies': importsAsDependencies_js_1.default,
+    'informative-docs': informativeDocs_js_1.default,
+    'lines-before-block': linesBeforeBlock_js_1.default,
+    'match-description': matchDescription_js_1.default,
+    'match-name': matchName_js_1.default,
+    'multiline-blocks': multilineBlocks_js_1.default,
+    'no-bad-blocks': noBadBlocks_js_1.default,
+    'no-blank-block-descriptions': noBlankBlockDescriptions_js_1.default,
+    'no-blank-blocks': noBlankBlocks_js_1.default,
+    'no-defaults': noDefaults_js_1.default,
+    'no-missing-syntax': noMissingSyntax_js_1.default,
+    'no-multi-asterisks': noMultiAsterisks_js_1.default,
+    'no-restricted-syntax': noRestrictedSyntax_js_1.default,
+    'no-types': noTypes_js_1.default,
+    'no-undefined-types': noUndefinedTypes_js_1.default,
+    'require-asterisk-prefix': requireAsteriskPrefix_js_1.default,
+    'require-description': requireDescription_js_1.default,
+    'require-description-complete-sentence': requireDescriptionCompleteSentence_js_1.default,
+    'require-example': requireExample_js_1.default,
+    'require-file-overview': requireFileOverview_js_1.default,
+    'require-hyphen-before-param-description': requireHyphenBeforeParamDescription_js_1.default,
+    'require-jsdoc': requireJsdoc_js_1.default,
+    'require-param': requireParam_js_1.default,
+    'require-param-description': requireParamDescription_js_1.default,
+    'require-param-name': requireParamName_js_1.default,
+    'require-param-type': requireParamType_js_1.default,
+    'require-property': requireProperty_js_1.default,
+    'require-property-description': requirePropertyDescription_js_1.default,
+    'require-property-name': requirePropertyName_js_1.default,
+    'require-property-type': requirePropertyType_js_1.default,
+    'require-returns': requireReturns_js_1.default,
+    'require-returns-check': requireReturnsCheck_js_1.default,
+    'require-returns-description': requireReturnsDescription_js_1.default,
+    'require-returns-type': requireReturnsType_js_1.default,
+    'require-template': requireTemplate_js_1.default,
+    'require-throws': requireThrows_js_1.default,
+    'require-yields': requireYields_js_1.default,
+    'require-yields-check': requireYieldsCheck_js_1.default,
+    'sort-tags': sortTags_js_1.default,
+    'tag-lines': tagLines_js_1.default,
+    'text-escaping': textEscaping_js_1.default,
+    'type-formatting': typeFormatting_js_1.default,
+    'valid-types': validTypes_js_1.default,
+};
+/**
+ * @param {"warn"|"error"} warnOrError
+ * @param {string} [flatName]
+ * @returns {import('eslint').Linter.Config}
+ */
+const createRecommendedRuleset = (warnOrError, flatName) => {
+    return {
+        ...(flatName ? {
+            name: 'jsdoc/' + flatName,
+        } : {}),
+        // @ts-expect-error ESLint 8 plugins
+        plugins: flatName ? {
+            jsdoc: index,
+        } : [
+            'jsdoc',
+        ],
+        rules: {
+            'jsdoc/check-access': warnOrError,
+            'jsdoc/check-alignment': warnOrError,
+            'jsdoc/check-examples': 'off',
+            'jsdoc/check-indentation': 'off',
+            'jsdoc/check-line-alignment': 'off',
+            'jsdoc/check-param-names': warnOrError,
+            'jsdoc/check-property-names': warnOrError,
+            'jsdoc/check-syntax': 'off',
+            'jsdoc/check-tag-names': warnOrError,
+            'jsdoc/check-template-names': 'off',
+            'jsdoc/check-types': warnOrError,
+            'jsdoc/check-values': warnOrError,
+            'jsdoc/convert-to-jsdoc-comments': 'off',
+            'jsdoc/empty-tags': warnOrError,
+            'jsdoc/implements-on-classes': warnOrError,
+            'jsdoc/imports-as-dependencies': 'off',
+            'jsdoc/informative-docs': 'off',
+            'jsdoc/lines-before-block': 'off',
+            'jsdoc/match-description': 'off',
+            'jsdoc/match-name': 'off',
+            'jsdoc/multiline-blocks': warnOrError,
+            'jsdoc/no-bad-blocks': 'off',
+            'jsdoc/no-blank-block-descriptions': 'off',
+            'jsdoc/no-blank-blocks': 'off',
+            'jsdoc/no-defaults': warnOrError,
+            'jsdoc/no-missing-syntax': 'off',
+            'jsdoc/no-multi-asterisks': warnOrError,
+            'jsdoc/no-restricted-syntax': 'off',
+            'jsdoc/no-types': 'off',
+            'jsdoc/no-undefined-types': warnOrError,
+            'jsdoc/require-asterisk-prefix': 'off',
+            'jsdoc/require-description': 'off',
+            'jsdoc/require-description-complete-sentence': 'off',
+            'jsdoc/require-example': 'off',
+            'jsdoc/require-file-overview': 'off',
+            'jsdoc/require-hyphen-before-param-description': 'off',
+            'jsdoc/require-jsdoc': warnOrError,
+            'jsdoc/require-param': warnOrError,
+            'jsdoc/require-param-description': warnOrError,
+            'jsdoc/require-param-name': warnOrError,
+            'jsdoc/require-param-type': warnOrError,
+            'jsdoc/require-property': warnOrError,
+            'jsdoc/require-property-description': warnOrError,
+            'jsdoc/require-property-name': warnOrError,
+            'jsdoc/require-property-type': warnOrError,
+            'jsdoc/require-returns': warnOrError,
+            'jsdoc/require-returns-check': warnOrError,
+            'jsdoc/require-returns-description': warnOrError,
+            'jsdoc/require-returns-type': warnOrError,
+            'jsdoc/require-template': 'off',
+            'jsdoc/require-throws': 'off',
+            'jsdoc/require-yields': warnOrError,
+            'jsdoc/require-yields-check': warnOrError,
+            'jsdoc/sort-tags': 'off',
+            'jsdoc/tag-lines': warnOrError,
+            'jsdoc/text-escaping': 'off',
+            'jsdoc/type-formatting': 'off',
+            'jsdoc/valid-types': warnOrError,
+        },
+    };
+};
+/**
+ * @param {"warn"|"error"} warnOrError
+ * @param {string} [flatName]
+ * @returns {import('eslint').Linter.Config}
+ */
+const createRecommendedTypeScriptRuleset = (warnOrError, flatName) => {
+    const ruleset = createRecommendedRuleset(warnOrError, flatName);
+    return {
+        ...ruleset,
+        rules: {
+            ...ruleset.rules,
+            /* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */
+            'jsdoc/check-tag-names': [
+                warnOrError, {
+                    typed: true,
+                },
+            ],
+            'jsdoc/no-types': warnOrError,
+            'jsdoc/no-undefined-types': 'off',
+            'jsdoc/require-param-type': 'off',
+            'jsdoc/require-property-type': 'off',
+            'jsdoc/require-returns-type': 'off',
+            /* eslint-enable @stylistic/indent */
+        },
+    };
+};
+/**
+ * @param {"warn"|"error"} warnOrError
+ * @param {string} [flatName]
+ * @returns {import('eslint').Linter.Config}
+ */
+const createRecommendedTypeScriptFlavorRuleset = (warnOrError, flatName) => {
+    const ruleset = createRecommendedRuleset(warnOrError, flatName);
+    return {
+        ...ruleset,
+        rules: {
+            ...ruleset.rules,
+            /* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */
+            'jsdoc/no-undefined-types': 'off',
+            /* eslint-enable @stylistic/indent */
+        },
+    };
+};
+/**
+ * @param {(string | unknown[])[]} ruleNames
+ */
+const createStandaloneRulesetFactory = (ruleNames) => {
+    /**
+     * @param {"warn"|"error"} warnOrError
+     * @param {string} [flatName]
+     * @returns {import('eslint').Linter.Config}
+     */
+    return (warnOrError, flatName) => {
+        return {
+            name: 'jsdoc/' + flatName,
+            plugins: {
+                jsdoc: index,
+            },
+            rules: Object.fromEntries(ruleNames.map((ruleName) => {
+                return (typeof ruleName === 'string' ?
+                    [
+                        ruleName, warnOrError,
+                    ] :
+                    [
+                        ruleName[0], [
+                            warnOrError, ...ruleName.slice(1),
+                        ],
+                    ]);
+            })),
+        };
+    };
+};
+const contentsRules = [
+    'jsdoc/informative-docs',
+    'jsdoc/match-description',
+    'jsdoc/no-blank-block-descriptions',
+    'jsdoc/no-blank-blocks',
+    [
+        'jsdoc/text-escaping', {
+            escapeHTML: true,
+        },
+    ],
+];
+const createContentsTypescriptRuleset = createStandaloneRulesetFactory(contentsRules);
+const createContentsTypescriptFlavorRuleset = createStandaloneRulesetFactory(contentsRules);
+const logicalRules = [
+    'jsdoc/check-access',
+    'jsdoc/check-param-names',
+    'jsdoc/check-property-names',
+    'jsdoc/check-syntax',
+    'jsdoc/check-tag-names',
+    'jsdoc/check-template-names',
+    'jsdoc/check-types',
+    'jsdoc/check-values',
+    'jsdoc/empty-tags',
+    'jsdoc/implements-on-classes',
+    'jsdoc/require-returns-check',
+    'jsdoc/require-yields-check',
+    'jsdoc/no-bad-blocks',
+    'jsdoc/no-defaults',
+    'jsdoc/no-types',
+    'jsdoc/no-undefined-types',
+    'jsdoc/valid-types',
+];
+const createLogicalTypescriptRuleset = createStandaloneRulesetFactory(logicalRules);
+const createLogicalTypescriptFlavorRuleset = createStandaloneRulesetFactory(logicalRules);
+const requirementsRules = [
+    'jsdoc/require-example',
+    'jsdoc/require-jsdoc',
+    'jsdoc/require-param',
+    'jsdoc/require-param-description',
+    'jsdoc/require-param-name',
+    'jsdoc/require-property',
+    'jsdoc/require-property-description',
+    'jsdoc/require-property-name',
+    'jsdoc/require-returns',
+    'jsdoc/require-returns-description',
+    'jsdoc/require-yields',
+];
+const createRequirementsTypeScriptRuleset = createStandaloneRulesetFactory(requirementsRules);
+const createRequirementsTypeScriptFlavorRuleset = createStandaloneRulesetFactory([
+    ...requirementsRules,
+    'jsdoc/require-param-type',
+    'jsdoc/require-property-type',
+    'jsdoc/require-returns-type',
+    'jsdoc/require-template',
+]);
+const stylisticRules = [
+    'jsdoc/check-alignment',
+    'jsdoc/check-line-alignment',
+    'jsdoc/lines-before-block',
+    'jsdoc/multiline-blocks',
+    'jsdoc/no-multi-asterisks',
+    'jsdoc/require-asterisk-prefix',
+    [
+        'jsdoc/require-hyphen-before-param-description', 'never',
+    ],
+    'jsdoc/tag-lines',
+];
+const createStylisticTypeScriptRuleset = createStandaloneRulesetFactory(stylisticRules);
+const createStylisticTypeScriptFlavorRuleset = createStandaloneRulesetFactory(stylisticRules);
+/* c8 ignore next 3 -- TS */
+if (!index.configs) {
+    throw new Error('TypeScript guard');
+}
+index.configs.recommended = createRecommendedRuleset('warn');
+index.configs['recommended-error'] = createRecommendedRuleset('error');
+index.configs['recommended-typescript'] = createRecommendedTypeScriptRuleset('warn');
+index.configs['recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error');
+index.configs['recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn');
+index.configs['recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error');
+index.configs['flat/recommended'] = createRecommendedRuleset('warn', 'flat/recommended');
+index.configs['flat/recommended-error'] = createRecommendedRuleset('error', 'flat/recommended-error');
+index.configs['flat/recommended-typescript'] = createRecommendedTypeScriptRuleset('warn', 'flat/recommended-typescript');
+index.configs['flat/recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error', 'flat/recommended-typescript-error');
+index.configs['flat/recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn', 'flat/recommended-typescript-flavor');
+index.configs['flat/recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error', 'flat/recommended-typescript-flavor-error');
+index.configs['flat/contents-typescript'] = createContentsTypescriptRuleset('warn', 'flat/contents-typescript');
+index.configs['flat/contents-typescript-error'] = createContentsTypescriptRuleset('error', 'flat/contents-typescript-error');
+index.configs['flat/contents-typescript-flavor'] = createContentsTypescriptFlavorRuleset('warn', 'flat/contents-typescript-flavor');
+index.configs['flat/contents-typescript-flavor-error'] = createContentsTypescriptFlavorRuleset('error', 'flat/contents-typescript-error-flavor');
+index.configs['flat/logical-typescript'] = createLogicalTypescriptRuleset('warn', 'flat/logical-typescript');
+index.configs['flat/logical-typescript-error'] = createLogicalTypescriptRuleset('error', 'flat/logical-typescript-error');
+index.configs['flat/logical-typescript-flavor'] = createLogicalTypescriptFlavorRuleset('warn', 'flat/logical-typescript-flavor');
+index.configs['flat/logical-typescript-flavor-error'] = createLogicalTypescriptFlavorRuleset('error', 'flat/logical-typescript-error-flavor');
+index.configs['flat/requirements-typescript'] = createRequirementsTypeScriptRuleset('warn', 'flat/requirements-typescript');
+index.configs['flat/requirements-typescript-error'] = createRequirementsTypeScriptRuleset('error', 'flat/requirements-typescript-error');
+index.configs['flat/requirements-typescript-flavor'] = createRequirementsTypeScriptFlavorRuleset('warn', 'flat/requirements-typescript-flavor');
+index.configs['flat/requirements-typescript-flavor-error'] = createRequirementsTypeScriptFlavorRuleset('error', 'flat/requirements-typescript-error-flavor');
+index.configs['flat/stylistic-typescript'] = createStylisticTypeScriptRuleset('warn', 'flat/stylistic-typescript');
+index.configs['flat/stylistic-typescript-error'] = createStylisticTypeScriptRuleset('error', 'flat/stylistic-typescript-error');
+index.configs['flat/stylistic-typescript-flavor'] = createStylisticTypeScriptFlavorRuleset('warn', 'flat/stylistic-typescript-flavor');
+index.configs['flat/stylistic-typescript-flavor-error'] = createStylisticTypeScriptFlavorRuleset('error', 'flat/stylistic-typescript-error-flavor');
+index.configs.examples = /** @type {import('eslint').Linter.Config[]} */ ([
+    {
+        files: [
+            '**/*.js',
+        ],
+        name: 'jsdoc/examples/processor',
+        plugins: {
+            examples: (0, getJsdocProcessorPlugin_js_1.getJsdocProcessorPlugin)(),
+        },
+        processor: 'examples/examples',
+    },
+    {
+        files: [
+            '**/*.md/*.js',
+        ],
+        name: 'jsdoc/examples/rules',
+        rules: {
+            // "always" newline rule at end unlikely in sample code
+            'eol-last': 0,
+            // Wouldn't generally expect example paths to resolve relative to JS file
+            'import/no-unresolved': 0,
+            // Snippets likely too short to always include import/export info
+            'import/unambiguous': 0,
+            'jsdoc/require-file-overview': 0,
+            // The end of a multiline comment would end the comment the example is in.
+            'jsdoc/require-jsdoc': 0,
+            // Unlikely to have inadvertent debugging within examples
+            'no-console': 0,
+            // Often wish to start `@example` code after newline; also may use
+            //   empty lines for spacing
+            'no-multiple-empty-lines': 0,
+            // Many variables in examples will be `undefined`
+            'no-undef': 0,
+            // Common to define variables for clarity without always using them
+            'no-unused-vars': 0,
+            // See import/no-unresolved
+            'node/no-missing-import': 0,
+            'node/no-missing-require': 0,
+            // Can generally look nicer to pad a little even if code imposes more stringency
+            'padded-blocks': 0,
+        },
+    },
+]);
+index.configs['default-expressions'] = /** @type {import('eslint').Linter.Config[]} */ ([
+    {
+        files: [
+            '**/*.js',
+        ],
+        name: 'jsdoc/default-expressions/processor',
+        plugins: {
+            examples: (0, getJsdocProcessorPlugin_js_1.getJsdocProcessorPlugin)({
+                checkDefaults: true,
+                checkParams: true,
+                checkProperties: true,
+            }),
+        },
+        processor: 'examples/examples',
+    },
+    {
+        files: [
+            '**/*.jsdoc-defaults', '**/*.jsdoc-params', '**/*.jsdoc-properties',
+        ],
+        name: 'jsdoc/default-expressions/rules',
+        rules: {
+            ...index.configs.examples[1].rules,
+            'chai-friendly/no-unused-expressions': 0,
+            'no-empty-function': 0,
+            'no-new': 0,
+            'no-unused-expressions': 0,
+            quotes: [
+                'error', 'double',
+            ],
+            semi: [
+                'error', 'never',
+            ],
+            strict: 0,
+        },
+    },
+]);
+index.configs['examples-and-default-expressions'] = /** @type {import('eslint').Linter.Config[]} */ ([
+    {
+        name: 'jsdoc/examples-and-default-expressions',
+        plugins: {
+            examples: (0, getJsdocProcessorPlugin_js_1.getJsdocProcessorPlugin)({
+                checkDefaults: true,
+                checkParams: true,
+                checkProperties: true,
+            }),
+        },
+    },
+    ...index.configs.examples.map((config) => {
+        return {
+            ...config,
+            plugins: {},
+        };
+    }),
+    ...index.configs['default-expressions'].map((config) => {
+        return {
+            ...config,
+            plugins: {},
+        };
+    }),
+]);
+exports.default = index;

package/dist/cjs/index.cjs.cjs

@@ -0,0 +1,6 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const index_cjs_js_1 = __importDefault(require("./index-cjs.js"));
+module.exports = index_cjs_js_1.default;

package/dist/cjs/index.cjs.d.cts

@@ -0,0 +1,2 @@
+import items from './index-cjs.js';
+export = items;

package/dist/cjs/iterateJsdoc.cjs

@@ -0,0 +1,38 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+const iterateJsdoc_js_1 = __importStar(require("./iterateJsdoc.js"));
+exports.getSettings = iterateJsdoc_js_1.getSettings;
+exports.parseComment = iterateJsdoc_js_1.parseComment;
+module.exports = iterateJsdoc_js_1.default;

package/dist/cjs/iterateJsdoc.d.cts

@@ -0,0 +1,2 @@
+import iterateJsdoc from './iterateJsdoc.js';
+export = iterateJsdoc;