eslint-plugin-tsdoc-require-2 1.0.1 → 1.0.3

package/dist/rules/require-tag-rules.js

@@ -0,0 +1,85 @@
+import requireAlphaRule from "./required-tags/require-alpha.js";
+import requireBetaRule from "./required-tags/require-beta.js";
+import requireDecoratorRule from "./required-tags/require-decorator.js";
+import requireDefaultValueRule from "./required-tags/require-default-value.js";
+import requireDeprecatedRule from "./required-tags/require-deprecated.js";
+import requireEventPropertyRule from "./required-tags/require-event-property.js";
+import requireExampleRule from "./required-tags/require-example.js";
+import requireExperimentalRule from "./required-tags/require-experimental.js";
+import requireInheritDocRule from "./required-tags/require-inherit-doc.js";
+import requireInternalRule from "./required-tags/require-internal.js";
+import requireLabelRule from "./required-tags/require-label.js";
+import requireLinkRule from "./required-tags/require-link.js";
+import requireOverrideRule from "./required-tags/require-override.js";
+import requirePackageDocumentationRule from "./required-tags/require-package-documentation.js";
+import requireParamRule from "./required-tags/require-param.js";
+import requirePrivateRemarksRule from "./required-tags/require-private-remarks.js";
+import requirePublicRule from "./required-tags/require-public.js";
+import requireReadonlyRule from "./required-tags/require-readonly.js";
+import requireRemarksRule from "./required-tags/require-remarks.js";
+import requireReturnsRule from "./required-tags/require-returns.js";
+import requireSealedRule from "./required-tags/require-sealed.js";
+import requireSeeRule from "./required-tags/require-see.js";
+import requireThrowsRule from "./required-tags/require-throws.js";
+import requireTypeParamRule from "./required-tags/require-type-param.js";
+import requireVirtualRule from "./required-tags/require-virtual.js";
+const requiredTagDefinitions = [
+    { ruleName: "require-alpha", tagName: "@alpha" },
+    { ruleName: "require-beta", tagName: "@beta" },
+    { ruleName: "require-decorator", tagName: "@decorator" },
+    { ruleName: "require-default-value", tagName: "@defaultValue" },
+    { ruleName: "require-deprecated", tagName: "@deprecated" },
+    { ruleName: "require-event-property", tagName: "@eventProperty" },
+    { ruleName: "require-example", tagName: "@example" },
+    { ruleName: "require-experimental", tagName: "@experimental" },
+    { ruleName: "require-inherit-doc", tagName: "@inheritDoc" },
+    { ruleName: "require-internal", tagName: "@internal" },
+    { ruleName: "require-label", tagName: "@label" },
+    { ruleName: "require-link", tagName: "@link" },
+    { ruleName: "require-override", tagName: "@override" },
+    {
+        ruleName: "require-package-documentation",
+        tagName: "@packageDocumentation",
+    },
+    { ruleName: "require-param", tagName: "@param" },
+    { ruleName: "require-private-remarks", tagName: "@privateRemarks" },
+    { ruleName: "require-public", tagName: "@public" },
+    { ruleName: "require-readonly", tagName: "@readonly" },
+    { ruleName: "require-remarks", tagName: "@remarks" },
+    { ruleName: "require-returns", tagName: "@returns" },
+    { ruleName: "require-sealed", tagName: "@sealed" },
+    { ruleName: "require-see", tagName: "@see" },
+    { ruleName: "require-throws", tagName: "@throws" },
+    { ruleName: "require-type-param", tagName: "@typeParam" },
+    { ruleName: "require-virtual", tagName: "@virtual" },
+];
+const requiredTagRules = {
+    "require-alpha": requireAlphaRule,
+    "require-beta": requireBetaRule,
+    "require-decorator": requireDecoratorRule,
+    "require-default-value": requireDefaultValueRule,
+    "require-deprecated": requireDeprecatedRule,
+    "require-event-property": requireEventPropertyRule,
+    "require-example": requireExampleRule,
+    "require-experimental": requireExperimentalRule,
+    "require-inherit-doc": requireInheritDocRule,
+    "require-internal": requireInternalRule,
+    "require-label": requireLabelRule,
+    "require-link": requireLinkRule,
+    "require-override": requireOverrideRule,
+    "require-package-documentation": requirePackageDocumentationRule,
+    "require-param": requireParamRule,
+    "require-private-remarks": requirePrivateRemarksRule,
+    "require-public": requirePublicRule,
+    "require-readonly": requireReadonlyRule,
+    "require-remarks": requireRemarksRule,
+    "require-returns": requireReturnsRule,
+    "require-sealed": requireSealedRule,
+    "require-see": requireSeeRule,
+    "require-throws": requireThrowsRule,
+    "require-type-param": requireTypeParamRule,
+    "require-virtual": requireVirtualRule,
+};
+export { requiredTagDefinitions };
+export { requiredTagRules };
+//# sourceMappingURL=require-tag-rules.js.map

package/dist/rules/require-tag-rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"require-tag-rules.js","sourceRoot":"","sources":["../../src/rules/require-tag-rules.ts"],"names":[],"mappings":"AAQA,OAAO,gBAAgB,MAAM,kCAAkC,CAAC;AAChE,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAC9D,OAAO,oBAAoB,MAAM,sCAAsC,CAAC;AACxE,OAAO,uBAAuB,MAAM,0CAA0C,CAAC;AAC/E,OAAO,qBAAqB,MAAM,uCAAuC,CAAC;AAC1E,OAAO,wBAAwB,MAAM,2CAA2C,CAAC;AACjF,OAAO,kBAAkB,MAAM,oCAAoC,CAAC;AACpE,OAAO,uBAAuB,MAAM,yCAAyC,CAAC;AAC9E,OAAO,qBAAqB,MAAM,wCAAwC,CAAC;AAC3E,OAAO,mBAAmB,MAAM,qCAAqC,CAAC;AACtE,OAAO,gBAAgB,MAAM,kCAAkC,CAAC;AAChE,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAC9D,OAAO,mBAAmB,MAAM,qCAAqC,CAAC;AACtE,OAAO,+BAA+B,MAAM,kDAAkD,CAAC;AAC/F,OAAO,gBAAgB,MAAM,kCAAkC,CAAC;AAChE,OAAO,yBAAyB,MAAM,4CAA4C,CAAC;AACnF,OAAO,iBAAiB,MAAM,mCAAmC,CAAC;AAClE,OAAO,mBAAmB,MAAM,qCAAqC,CAAC;AACtE,OAAO,kBAAkB,MAAM,oCAAoC,CAAC;AACpE,OAAO,kBAAkB,MAAM,oCAAoC,CAAC;AACpE,OAAO,iBAAiB,MAAM,mCAAmC,CAAC;AAClE,OAAO,cAAc,MAAM,gCAAgC,CAAC;AAC5D,OAAO,iBAAiB,MAAM,mCAAmC,CAAC;AAClE,OAAO,oBAAoB,MAAM,uCAAuC,CAAC;AACzE,OAAO,kBAAkB,MAAM,oCAAoC,CAAC;AAEpE,MAAM,sBAAsB,GAAiC;IACzD,EAAE,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE;IAChD,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,EAAE;IAC9C,EAAE,QAAQ,EAAE,mBAAmB,EAAE,OAAO,EAAE,YAAY,EAAE;IACxD,EAAE,QAAQ,EAAE,uBAAuB,EAAE,OAAO,EAAE,eAAe,EAAE;IAC/D,EAAE,QAAQ,EAAE,oBAAoB,EAAE,OAAO,EAAE,aAAa,EAAE;IAC1D,EAAE,QAAQ,EAAE,wBAAwB,EAAE,OAAO,EAAE,gBAAgB,EAAE;IACjE,EAAE,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,UAAU,EAAE;IACpD,EAAE,QAAQ,EAAE,sBAAsB,EAAE,OAAO,EAAE,eAAe,EAAE;IAC9D,EAAE,QAAQ,EAAE,qBAAqB,EAAE,OAAO,EAAE,aAAa,EAAE;IAC3D,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,WAAW,EAAE;IACtD,EAAE,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE;IAChD,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,EAAE;IAC9C,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,WAAW,EAAE;IACtD;QACI,QAAQ,EAAE,+BAA+B;QACzC,OAAO,EAAE,uBAAuB;KACnC;IACD,EAAE,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE;IAChD,EAAE,QAAQ,EAAE,yBAAyB,EAAE,OAAO,EAAE,iBAAiB,EAAE;IACnE,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE;IAClD,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,WAAW,EAAE;IACtD,EAAE,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,UAAU,EAAE;IACpD,EAAE,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,UAAU,EAAE;IACpD,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE;IAClD,EAAE,QAAQ,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE;IAC5C,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE;IAClD,EAAE,QAAQ,EAAE,oBAAoB,EAAE,OAAO,EAAE,YAAY,EAAE;IACzD,EAAE,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,UAAU,EAAE;CACvD,CAAC;AAsDF,MAAM,gBAAgB,GAAqB;IACvC,eAAe,EAAE,gBAAgB;IACjC,cAAc,EAAE,eAAe;IAC/B,mBAAmB,EAAE,oBAAoB;IACzC,uBAAuB,EAAE,uBAAuB;IAChD,oBAAoB,EAAE,qBAAqB;IAC3C,wBAAwB,EAAE,wBAAwB;IAClD,iBAAiB,EAAE,kBAAkB;IACrC,sBAAsB,EAAE,uBAAuB;IAC/C,qBAAqB,EAAE,qBAAqB;IAC5C,kBAAkB,EAAE,mBAAmB;IACvC,eAAe,EAAE,gBAAgB;IACjC,cAAc,EAAE,eAAe;IAC/B,kBAAkB,EAAE,mBAAmB;IACvC,+BAA+B,EAAE,+BAA+B;IAChE,eAAe,EAAE,gBAAgB;IACjC,yBAAyB,EAAE,yBAAyB;IACpD,gBAAgB,EAAE,iBAAiB;IACnC,kBAAkB,EAAE,mBAAmB;IACvC,iBAAiB,EAAE,kBAAkB;IACrC,iBAAiB,EAAE,kBAAkB;IACrC,gBAAgB,EAAE,iBAAiB;IACnC,aAAa,EAAE,cAAc;IAC7B,gBAAgB,EAAE,iBAAiB;IACnC,oBAAoB,EAAE,oBAAoB;IAC1C,iBAAiB,EAAE,kBAAkB;CACxC,CAAC;AAIF,OAAO,EAAE,sBAAsB,EAAE,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/rules/require.cjs

@@ -0,0 +1,296 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@typescript-eslint/utils");
+const enforceableEntityKinds = [
+    "class",
+    "enum",
+    "function",
+    "interface",
+    "object",
+    "type",
+    "variable",
+];
+const defaultEnforceFor = [...enforceableEntityKinds];
+const defaultRuleOptions = [
+    {
+        enforceFor: defaultEnforceFor,
+        includeNonExported: false,
+    },
+];
+const optionSchema = {
+    additionalProperties: false,
+    properties: {
+        enforceFor: {
+            items: {
+                enum: [...enforceableEntityKinds],
+                type: "string",
+            },
+            type: "array",
+            uniqueItems: true,
+        },
+        includeNonExported: {
+            default: false,
+            description: "Also enforce on non-exported declarations (opt-in).",
+            type: "boolean",
+        },
+    },
+    type: "object",
+};
+const assertUnreachable = (value) => {
+    throw new Error(`Unexpected node type: ${String(value)}`);
+};
+// eslint-disable-next-line total-functions/no-hidden-type-assertions -- RuleCreator generic is required so `meta.docs.recommended` is strongly typed and accepted in the inline metadata literal.
+const createRule = utils_1.ESLintUtils.RuleCreator((ruleName) => `https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/${ruleName}.md`);
+const isSupportedDeclaration = (node) => node.type === utils_1.AST_NODE_TYPES.ClassDeclaration ||
+    node.type === utils_1.AST_NODE_TYPES.FunctionDeclaration ||
+    node.type === utils_1.AST_NODE_TYPES.TSDeclareFunction ||
+    node.type === utils_1.AST_NODE_TYPES.TSEnumDeclaration ||
+    node.type === utils_1.AST_NODE_TYPES.TSInterfaceDeclaration ||
+    node.type === utils_1.AST_NODE_TYPES.TSTypeAliasDeclaration ||
+    node.type === utils_1.AST_NODE_TYPES.VariableDeclaration;
+const isSupportedDefaultExportExpression = (node) => node.type === utils_1.AST_NODE_TYPES.ArrowFunctionExpression ||
+    node.type === utils_1.AST_NODE_TYPES.ClassExpression ||
+    node.type === utils_1.AST_NODE_TYPES.FunctionExpression ||
+    node.type === utils_1.AST_NODE_TYPES.ObjectExpression;
+const getExpressionKind = (node) => {
+    if (node.type === utils_1.AST_NODE_TYPES.ArrowFunctionExpression ||
+        node.type === utils_1.AST_NODE_TYPES.FunctionExpression) {
+        return "function";
+    }
+    if (node.type === utils_1.AST_NODE_TYPES.ClassExpression) {
+        return "class";
+    }
+    if (node.type === utils_1.AST_NODE_TYPES.ObjectExpression) {
+        return "object";
+    }
+    return assertUnreachable(node);
+};
+const getEntityDisplayName = (name) => name ?? "<default export>";
+const hasTSDocComment = (sourceCode, node) => {
+    const comments = sourceCode.getCommentsBefore(node);
+    const nearestComment = comments.at(-1);
+    if (nearestComment === undefined) {
+        return false;
+    }
+    if (nearestComment.type !== utils_1.AST_TOKEN_TYPES.Block) {
+        return false;
+    }
+    if (!nearestComment.value.startsWith("*")) {
+        return false;
+    }
+    const nearestCommentLoc = nearestComment.loc;
+    const nodeLoc = node.loc;
+    if (nearestCommentLoc === null || nodeLoc === null) {
+        return false;
+    }
+    const lineGap = nodeLoc.start.line - nearestCommentLoc.end.line;
+    return lineGap >= 0 && lineGap <= 1;
+};
+const createTargetKey = (target) => {
+    const [start, end] = target.reportNode.range;
+    return `${start}:${end}:${target.kind}:${target.name ?? ""}`;
+};
+const declarationTargets = (declaration) => {
+    if (declaration.type === utils_1.AST_NODE_TYPES.ClassDeclaration) {
+        return [
+            {
+                commentNode: declaration,
+                kind: "class",
+                name: declaration.id?.name,
+                reportNode: declaration,
+            },
+        ];
+    }
+    if (declaration.type === utils_1.AST_NODE_TYPES.FunctionDeclaration ||
+        declaration.type === utils_1.AST_NODE_TYPES.TSDeclareFunction) {
+        return [
+            {
+                commentNode: declaration,
+                kind: "function",
+                name: declaration.id?.name,
+                reportNode: declaration,
+            },
+        ];
+    }
+    if (declaration.type === utils_1.AST_NODE_TYPES.TSEnumDeclaration) {
+        return [
+            {
+                commentNode: declaration,
+                kind: "enum",
+                name: declaration.id.name,
+                reportNode: declaration,
+            },
+        ];
+    }
+    if (declaration.type === utils_1.AST_NODE_TYPES.TSInterfaceDeclaration) {
+        return [
+            {
+                commentNode: declaration,
+                kind: "interface",
+                name: declaration.id.name,
+                reportNode: declaration,
+            },
+        ];
+    }
+    if (declaration.type === utils_1.AST_NODE_TYPES.TSTypeAliasDeclaration) {
+        return [
+            {
+                commentNode: declaration,
+                kind: "type",
+                name: declaration.id.name,
+                reportNode: declaration,
+            },
+        ];
+    }
+    if (declaration.type === utils_1.AST_NODE_TYPES.VariableDeclaration) {
+        return declaration.declarations.flatMap((declarator) => {
+            if (declarator.id.type !== utils_1.AST_NODE_TYPES.Identifier) {
+                return [];
+            }
+            return [
+                {
+                    commentNode: declaration,
+                    kind: "variable",
+                    name: declarator.id.name,
+                    reportNode: declarator,
+                },
+            ];
+        });
+    }
+    return assertUnreachable(declaration);
+};
+const declarationTargetsWithCommentNode = (declaration, commentNode) => declarationTargets(declaration).map((target) => ({
+    ...target,
+    commentNode,
+}));
+const requireRule = createRule({
+    create(context) {
+        const declarationsByName = new Map();
+        const checkedTargets = new Set();
+        const sourceCode = context.sourceCode;
+        const ruleOption = context.options.at(0);
+        const enabledKinds = new Set(ruleOption?.enforceFor ?? defaultEnforceFor);
+        const includeNonExported = ruleOption?.includeNonExported ?? false;
+        const checkTarget = (target) => {
+            if (!enabledKinds.has(target.kind)) {
+                return;
+            }
+            const targetKey = createTargetKey(target);
+            if (checkedTargets.has(targetKey)) {
+                return;
+            }
+            checkedTargets.add(targetKey);
+            if (hasTSDocComment(sourceCode, target.commentNode)) {
+                return;
+            }
+            context.report({
+                data: {
+                    entityKind: target.kind,
+                    entityName: getEntityDisplayName(target.name),
+                },
+                messageId: "missingTSDoc",
+                node: target.reportNode,
+            });
+        };
+        const checkDeclarationWithExportComment = (declaration, exportNode) => {
+            for (const target of declarationTargetsWithCommentNode(declaration, exportNode)) {
+                checkTarget(target);
+            }
+        };
+        const trackDeclarationTargets = (declaration) => {
+            for (const target of declarationTargets(declaration)) {
+                if (target.name === undefined) {
+                    continue;
+                }
+                declarationsByName.set(target.name, target);
+            }
+        };
+        const checkIdentifierExport = (identifier) => {
+            const target = declarationsByName.get(identifier.name);
+            if (target !== undefined) {
+                checkTarget(target);
+            }
+        };
+        return {
+            ExportDefaultDeclaration(exportNode) {
+                const { declaration } = exportNode;
+                if (declaration.type === utils_1.AST_NODE_TYPES.Identifier) {
+                    checkIdentifierExport(declaration);
+                    return;
+                }
+                if (isSupportedDeclaration(declaration)) {
+                    checkDeclarationWithExportComment(declaration, exportNode);
+                    return;
+                }
+                if (isSupportedDefaultExportExpression(declaration)) {
+                    checkTarget({
+                        commentNode: exportNode,
+                        kind: getExpressionKind(declaration),
+                        name: undefined,
+                        reportNode: declaration,
+                    });
+                }
+            },
+            ExportNamedDeclaration(exportNode) {
+                if (exportNode.declaration !== null &&
+                    isSupportedDeclaration(exportNode.declaration)) {
+                    checkDeclarationWithExportComment(exportNode.declaration, exportNode);
+                }
+                if (exportNode.source !== null) {
+                    return;
+                }
+                for (const specifier of exportNode.specifiers) {
+                    if (specifier.type !== utils_1.AST_NODE_TYPES.ExportSpecifier) {
+                        continue;
+                    }
+                    checkIdentifierExport(specifier.local);
+                }
+            },
+            Program(programNode) {
+                declarationsByName.clear();
+                checkedTargets.clear();
+                for (const statement of programNode.body) {
+                    if (isSupportedDeclaration(statement)) {
+                        if (includeNonExported) {
+                            for (const target of declarationTargetsWithCommentNode(statement, statement)) {
+                                checkTarget(target);
+                            }
+                        }
+                        trackDeclarationTargets(statement);
+                        continue;
+                    }
+                    if (statement.type ===
+                        utils_1.AST_NODE_TYPES.ExportNamedDeclaration &&
+                        statement.declaration !== null &&
+                        isSupportedDeclaration(statement.declaration)) {
+                        trackDeclarationTargets(statement.declaration);
+                    }
+                }
+            },
+        };
+    },
+    defaultOptions: defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require TSDoc comments for exported TypeScript declarations and default exports, with opt-in non-exported support.",
+            frozen: false,
+            recommended: true,
+            url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/require.md",
+        },
+        messages: {
+            missingTSDoc: "Missing TSDoc for {{entityKind}} {{entityName}}.",
+        },
+        schema: [optionSchema],
+        type: "problem",
+    },
+    name: "require",
+});
+exports.default = requireRule;
+//# sourceMappingURL=require.js.map

package/dist/rules/require.d.ts

@@ -4,6 +4,7 @@ type MessageIds = "missingTSDoc";
 type Options = [RuleOption];
 type RuleOption = {
     enforceFor?: readonly EntityKind[];
+    includeNonExported?: boolean;
 };
 declare const requireRule: TSESLint.RuleModule<MessageIds, Options>;
 export default requireRule;

package/dist/rules/require.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"require.d.ts","sourceRoot":"","sources":["../../src/rules/require.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAc,QAAQ,EAAY,MAAM,0BAA0B,CAAC;AAQ/E,KAAK,UAAU,GACT,OAAO,GACP,MAAM,GACN,UAAU,GACV,WAAW,GACX,QAAQ,GACR,MAAM,GACN,UAAU,CAAC;AACjB,KAAK,UAAU,GAAG,cAAc,CAAC;AAEjC,KAAK,OAAO,GAAG,CAAC,UAAU,CAAC,CAAC;AAM5B,KAAK,UAAU,GAAG;IACd,UAAU,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;CACtC,CAAC;AA0OF,QAAA,MAAM,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAyKxD,CAAC;AAEH,eAAe,WAAW,CAAC"}
+{"version":3,"file":"require.d.ts","sourceRoot":"","sources":["../../src/rules/require.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAc,QAAQ,EAAY,MAAM,0BAA0B,CAAC;AAQ/E,KAAK,UAAU,GACT,OAAO,GACP,MAAM,GACN,UAAU,GACV,WAAW,GACX,QAAQ,GACR,MAAM,GACN,UAAU,CAAC;AACjB,KAAK,UAAU,GAAG,cAAc,CAAC;AAEjC,KAAK,OAAO,GAAG,CAAC,UAAU,CAAC,CAAC;AAM5B,KAAK,UAAU,GAAG;IACd,UAAU,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;IACnC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC,CAAC;AAgPF,QAAA,MAAM,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAmLxD,CAAC;AAEH,eAAe,WAAW,CAAC"}

package/dist/rules/require.js

@@ -12,6 +12,7 @@ const defaultEnforceFor = [...enforceableEntityKinds];
 const defaultRuleOptions = [
     {
         enforceFor: defaultEnforceFor,
+        includeNonExported: false,
     },
 ];
 const optionSchema = {
@@ -25,6 +26,11 @@ const optionSchema = {
             type: "array",
             uniqueItems: true,
         },
+        includeNonExported: {
+            default: false,
+            description: "Also enforce on non-exported declarations (opt-in).",
+            type: "boolean",
+        },
     },
     type: "object",
 };
@@ -162,6 +168,7 @@ const requireRule = createRule({
         const sourceCode = context.sourceCode;
         const ruleOption = context.options.at(0);
         const enabledKinds = new Set(ruleOption?.enforceFor ?? defaultEnforceFor);
+        const includeNonExported = ruleOption?.includeNonExported ?? false;
         const checkTarget = (target) => {
             if (!enabledKinds.has(target.kind)) {
                 return;
@@ -242,6 +249,11 @@ const requireRule = createRule({
                 checkedTargets.clear();
                 for (const statement of programNode.body) {
                     if (isSupportedDeclaration(statement)) {
+                        if (includeNonExported) {
+                            for (const target of declarationTargetsWithCommentNode(statement, statement)) {
+                                checkTarget(target);
+                            }
+                        }
                         trackDeclarationTargets(statement);
                         continue;
                     }
@@ -260,17 +272,18 @@ const requireRule = createRule({
         defaultOptions: [
             {
                 enforceFor: [...enforceableEntityKinds],
+                includeNonExported: false,
             },
         ],
         deprecated: false,
         docs: {
-            description: "require TSDoc comments for exported TypeScript declarations and default exports.",
+            description: "require TSDoc comments for exported TypeScript declarations and default exports, with opt-in non-exported support.",
             frozen: false,
-            recommended: false,
+            recommended: true,
             url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/require.md",
         },
         messages: {
-            missingTSDoc: "Missing TSDoc for exported {{entityKind}} {{entityName}}.",
+            missingTSDoc: "Missing TSDoc for {{entityKind}} {{entityName}}.",
         },
         schema: [optionSchema],
         type: "problem",

package/dist/rules/require.js.map

@@ -1 +1 @@
-{"version":3,"file":"require.js","sourceRoot":"","sources":["../../src/rules/require.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,cAAc,EACd,eAAe,EACf,WAAW,GACd,MAAM,0BAA0B,CAAC;AA4ClC,MAAM,sBAAsB,GAAG;IAC3B,OAAO;IACP,MAAM;IACN,UAAU;IACV,WAAW;IACX,QAAQ;IACR,MAAM;IACN,UAAU;CAC4B,CAAC;AAE3C,MAAM,iBAAiB,GAA0B,CAAC,GAAG,sBAAsB,CAAC,CAAC;AAE7E,MAAM,kBAAkB,GAAY;IAChC;QACI,UAAU,EAAE,iBAAiB;KAChC;CACJ,CAAC;AAEF,MAAM,YAAY,GAA2B;IACzC,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,UAAU,EAAE;YACR,KAAK,EAAE;gBACH,IAAI,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACjC,IAAI,EAAE,QAAQ;aACjB;YACD,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,IAAI;SACpB;KACJ;IACD,IAAI,EAAE,QAAQ;CACjB,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,KAAY,EAAS,EAAE;IAC9C,MAAM,IAAI,KAAK,CAAC,yBAAyB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAC9D,CAAC,CAAC;AAEF,kMAAkM;AAClM,MAAM,UAAU,GAAG,WAAW,CAAC,WAAW,CACtC,CAAC,QAAQ,EAAE,EAAE,CACT,oFAAoF,QAAQ,KAAK,CACxG,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAC3B,IAA6B,EACD,EAAE,CAC9B,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB;IAC7C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB;IAChD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB;IAC9C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB;IAC9C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB;IACnD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB;IACnD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB,CAAC;AAErD,MAAM,kCAAkC,GAAG,CACvC,IAA6B,EACW,EAAE,CAC1C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,uBAAuB;IACpD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe;IAC5C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,kBAAkB;IAC/C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,CAAC;AAElD,MAAM,iBAAiB,GAAG,CACtB,IAAgD,EACtC,EAAE;IACZ,IACI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,uBAAuB;QACpD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,kBAAkB,EACjD,CAAC;QACC,OAAO,UAAU,CAAC;IACtB,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe,EAAE,CAAC;QAC/C,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;QAChD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,IAAwB,EAAU,EAAE,CAC9D,IAAI,IAAI,kBAAkB,CAAC;AAE/B,MAAM,eAAe,GAAG,CACpB,UAAyC,EACzC,IAA6B,EACtB,EAAE;IACT,MAAM,QAAQ,GAAG,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACpD,MAAM,cAAc,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvC,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,cAAc,CAAC,IAAI,KAAK,eAAe,CAAC,KAAK,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,iBAAiB,GAAG,cAAc,CAAC,GAAG,CAAC;IAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;IACzB,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACjD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC;IAChE,OAAO,OAAO,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,CAAC;AACxC,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,MAAwB,EAAU,EAAE;IACzD,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC;IAC7C,OAAO,GAAG,KAAK,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CACvB,WAA2C,EACnC,EAAE;IACV,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;QACvD,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,IAAI;gBAC1B,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IACI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB;QACvD,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB,EACvD,CAAC;QACC,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,IAAI;gBAC1B,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB,EAAE,CAAC;QACxD,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC,IAAI;gBACzB,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB,EAAE,CAAC;QAC7D,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC,IAAI;gBACzB,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB,EAAE,CAAC;QAC7D,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC,IAAI;gBACzB,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB,EAAE,CAAC;QAC1D,OAAO,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACnD,IAAI,UAAU,CAAC,EAAE,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU,EAAE,CAAC;gBACnD,OAAO,EAAE,CAAC;YACd,CAAC;YAED,OAAO;gBACH;oBACI,WAAW,EAAE,WAAW;oBACxB,IAAI,EAAE,UAAmB;oBACzB,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC,IAAI;oBACxB,UAAU,EAAE,UAAU;iBACzB;aACJ,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAED,OAAO,iBAAiB,CAAC,WAAW,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,MAAM,iCAAiC,GAAG,CACtC,WAA2C,EAC3C,WAAoC,EAC5B,EAAE,CACV,kBAAkB,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC7C,GAAG,MAAM;IACT,WAAW;CACd,CAAC,CAAC,CAAC;AAER,MAAM,WAAW,GAA6C,UAAU,CAGtE;IACE,MAAM,CAAC,OAAO;QACV,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAkB,CAAC;QACrD,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;QACzC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACtC,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,YAAY,GAAG,IAAI,GAAG,CACxB,UAAU,EAAE,UAAU,IAAI,iBAAiB,CAC9C,CAAC;QAEF,MAAM,WAAW,GAAG,CAAC,MAAwB,EAAQ,EAAE;YACnD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjC,OAAO;YACX,CAAC;YAED,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;YAC1C,IAAI,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;gBAChC,OAAO;YACX,CAAC;YAED,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAE9B,IAAI,eAAe,CAAC,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;gBAClD,OAAO;YACX,CAAC;YAED,OAAO,CAAC,MAAM,CAAC;gBACX,IAAI,EAAE;oBACF,UAAU,EAAE,MAAM,CAAC,IAAI;oBACvB,UAAU,EAAE,oBAAoB,CAAC,MAAM,CAAC,IAAI,CAAC;iBAChD;gBACD,SAAS,EAAE,cAAc;gBACzB,IAAI,EAAE,MAAM,CAAC,UAAU;aAC1B,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,MAAM,iCAAiC,GAAG,CACtC,WAA2C,EAC3C,UAE+C,EAC3C,EAAE;YACN,KAAK,MAAM,MAAM,IAAI,iCAAiC,CAClD,WAAW,EACX,UAAU,CACb,EAAE,CAAC;gBACA,WAAW,CAAC,MAAM,CAAC,CAAC;YACxB,CAAC;QACL,CAAC,CAAC;QAEF,MAAM,uBAAuB,GAAG,CAC5B,WAA2C,EACvC,EAAE;YACN,KAAK,MAAM,MAAM,IAAI,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;gBACnD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC5B,SAAS;gBACb,CAAC;gBAED,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAChD,CAAC;QACL,CAAC,CAAC;QAEF,MAAM,qBAAqB,GAAG,CAC1B,UAAyC,EACrC,EAAE;YACN,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACvD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACvB,WAAW,CAAC,MAAM,CAAC,CAAC;YACxB,CAAC;QACL,CAAC,CAAC;QAEF,OAAO;YACH,wBAAwB,CACpB,UAAuD;gBAEvD,MAAM,EAAE,WAAW,EAAE,GAAG,UAAU,CAAC;gBAEnC,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU,EAAE,CAAC;oBACjD,qBAAqB,CAAC,WAAW,CAAC,CAAC;oBACnC,OAAO;gBACX,CAAC;gBAED,IAAI,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;oBACtC,iCAAiC,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;oBAC3D,OAAO;gBACX,CAAC;gBAED,IAAI,kCAAkC,CAAC,WAAW,CAAC,EAAE,CAAC;oBAClD,WAAW,CAAC;wBACR,WAAW,EAAE,UAAU;wBACvB,IAAI,EAAE,iBAAiB,CAAC,WAAW,CAAC;wBACpC,IAAI,EAAE,SAAS;wBACf,UAAU,EAAE,WAAW;qBAC1B,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;YACD,sBAAsB,CAClB,UAAqD;gBAErD,IACI,UAAU,CAAC,WAAW,KAAK,IAAI;oBAC/B,sBAAsB,CAAC,UAAU,CAAC,WAAW,CAAC,EAChD,CAAC;oBACC,iCAAiC,CAC7B,UAAU,CAAC,WAAW,EACtB,UAAU,CACb,CAAC;gBACN,CAAC;gBAED,IAAI,UAAU,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;oBAC7B,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;oBAC5C,IAAI,SAAS,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe,EAAE,CAAC;wBACpD,SAAS;oBACb,CAAC;oBAED,qBAAqB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBAC3C,CAAC;YACL,CAAC;YACD,OAAO,CAAC,WAAuC;gBAC3C,kBAAkB,CAAC,KAAK,EAAE,CAAC;gBAC3B,cAAc,CAAC,KAAK,EAAE,CAAC;gBAEvB,KAAK,MAAM,SAAS,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC;oBACvC,IAAI,sBAAsB,CAAC,SAAS,CAAC,EAAE,CAAC;wBACpC,uBAAuB,CAAC,SAAS,CAAC,CAAC;wBACnC,SAAS;oBACb,CAAC;oBAED,IACI,SAAS,CAAC,IAAI;wBACV,cAAc,CAAC,sBAAsB;wBACzC,SAAS,CAAC,WAAW,KAAK,IAAI;wBAC9B,sBAAsB,CAAC,SAAS,CAAC,WAAW,CAAC,EAC/C,CAAC;wBACC,uBAAuB,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;oBACnD,CAAC;gBACL,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,cAAc,EAAE,kBAAkB;IAClC,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;aAC1C;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,kFAAkF;YACtF,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,6FAA6F;SACrG;QACD,QAAQ,EAAE;YACN,YAAY,EACR,2DAA2D;SAClE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,SAAS;CAClB,CAAC,CAAC;AAEH,eAAe,WAAW,CAAC"}
+{"version":3,"file":"require.js","sourceRoot":"","sources":["../../src/rules/require.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,cAAc,EACd,eAAe,EACf,WAAW,GACd,MAAM,0BAA0B,CAAC;AA6ClC,MAAM,sBAAsB,GAAG;IAC3B,OAAO;IACP,MAAM;IACN,UAAU;IACV,WAAW;IACX,QAAQ;IACR,MAAM;IACN,UAAU;CAC4B,CAAC;AAE3C,MAAM,iBAAiB,GAA0B,CAAC,GAAG,sBAAsB,CAAC,CAAC;AAE7E,MAAM,kBAAkB,GAAY;IAChC;QACI,UAAU,EAAE,iBAAiB;QAC7B,kBAAkB,EAAE,KAAK;KAC5B;CACJ,CAAC;AAEF,MAAM,YAAY,GAA2B;IACzC,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,UAAU,EAAE;YACR,KAAK,EAAE;gBACH,IAAI,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACjC,IAAI,EAAE,QAAQ;aACjB;YACD,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,IAAI;SACpB;QACD,kBAAkB,EAAE;YAChB,OAAO,EAAE,KAAK;YACd,WAAW,EAAE,qDAAqD;YAClE,IAAI,EAAE,SAAS;SAClB;KACJ;IACD,IAAI,EAAE,QAAQ;CACjB,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,KAAY,EAAS,EAAE;IAC9C,MAAM,IAAI,KAAK,CAAC,yBAAyB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAC9D,CAAC,CAAC;AAEF,kMAAkM;AAClM,MAAM,UAAU,GAAG,WAAW,CAAC,WAAW,CACtC,CAAC,QAAQ,EAAE,EAAE,CACT,oFAAoF,QAAQ,KAAK,CACxG,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAC3B,IAA6B,EACD,EAAE,CAC9B,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB;IAC7C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB;IAChD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB;IAC9C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB;IAC9C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB;IACnD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB;IACnD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB,CAAC;AAErD,MAAM,kCAAkC,GAAG,CACvC,IAA6B,EACW,EAAE,CAC1C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,uBAAuB;IACpD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe;IAC5C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,kBAAkB;IAC/C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,CAAC;AAElD,MAAM,iBAAiB,GAAG,CACtB,IAAgD,EACtC,EAAE;IACZ,IACI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,uBAAuB;QACpD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,kBAAkB,EACjD,CAAC;QACC,OAAO,UAAU,CAAC;IACtB,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe,EAAE,CAAC;QAC/C,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;QAChD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,IAAwB,EAAU,EAAE,CAC9D,IAAI,IAAI,kBAAkB,CAAC;AAE/B,MAAM,eAAe,GAAG,CACpB,UAAyC,EACzC,IAA6B,EACtB,EAAE;IACT,MAAM,QAAQ,GAAG,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACpD,MAAM,cAAc,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvC,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,cAAc,CAAC,IAAI,KAAK,eAAe,CAAC,KAAK,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,iBAAiB,GAAG,cAAc,CAAC,GAAG,CAAC;IAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;IACzB,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACjD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC;IAChE,OAAO,OAAO,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,CAAC;AACxC,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,MAAwB,EAAU,EAAE;IACzD,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC;IAC7C,OAAO,GAAG,KAAK,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CACvB,WAA2C,EACnC,EAAE;IACV,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;QACvD,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,IAAI;gBAC1B,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IACI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB;QACvD,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB,EACvD,CAAC;QACC,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,IAAI;gBAC1B,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB,EAAE,CAAC;QACxD,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC,IAAI;gBACzB,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB,EAAE,CAAC;QAC7D,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC,IAAI;gBACzB,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB,EAAE,CAAC;QAC7D,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC,IAAI;gBACzB,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB,EAAE,CAAC;QAC1D,OAAO,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACnD,IAAI,UAAU,CAAC,EAAE,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU,EAAE,CAAC;gBACnD,OAAO,EAAE,CAAC;YACd,CAAC;YAED,OAAO;gBACH;oBACI,WAAW,EAAE,WAAW;oBACxB,IAAI,EAAE,UAAmB;oBACzB,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC,IAAI;oBACxB,UAAU,EAAE,UAAU;iBACzB;aACJ,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAED,OAAO,iBAAiB,CAAC,WAAW,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,MAAM,iCAAiC,GAAG,CACtC,WAA2C,EAC3C,WAAoC,EAC5B,EAAE,CACV,kBAAkB,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC7C,GAAG,MAAM;IACT,WAAW;CACd,CAAC,CAAC,CAAC;AAER,MAAM,WAAW,GAA6C,UAAU,CAGtE;IACE,MAAM,CAAC,OAAO;QACV,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAkB,CAAC;QACrD,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;QACzC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACtC,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,YAAY,GAAG,IAAI,GAAG,CACxB,UAAU,EAAE,UAAU,IAAI,iBAAiB,CAC9C,CAAC;QACF,MAAM,kBAAkB,GAAG,UAAU,EAAE,kBAAkB,IAAI,KAAK,CAAC;QAEnE,MAAM,WAAW,GAAG,CAAC,MAAwB,EAAQ,EAAE;YACnD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjC,OAAO;YACX,CAAC;YAED,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;YAC1C,IAAI,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;gBAChC,OAAO;YACX,CAAC;YAED,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAE9B,IAAI,eAAe,CAAC,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;gBAClD,OAAO;YACX,CAAC;YAED,OAAO,CAAC,MAAM,CAAC;gBACX,IAAI,EAAE;oBACF,UAAU,EAAE,MAAM,CAAC,IAAI;oBACvB,UAAU,EAAE,oBAAoB,CAAC,MAAM,CAAC,IAAI,CAAC;iBAChD;gBACD,SAAS,EAAE,cAAc;gBACzB,IAAI,EAAE,MAAM,CAAC,UAAU;aAC1B,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,MAAM,iCAAiC,GAAG,CACtC,WAA2C,EAC3C,UAE+C,EAC3C,EAAE;YACN,KAAK,MAAM,MAAM,IAAI,iCAAiC,CAClD,WAAW,EACX,UAAU,CACb,EAAE,CAAC;gBACA,WAAW,CAAC,MAAM,CAAC,CAAC;YACxB,CAAC;QACL,CAAC,CAAC;QAEF,MAAM,uBAAuB,GAAG,CAC5B,WAA2C,EACvC,EAAE;YACN,KAAK,MAAM,MAAM,IAAI,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;gBACnD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC5B,SAAS;gBACb,CAAC;gBAED,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAChD,CAAC;QACL,CAAC,CAAC;QAEF,MAAM,qBAAqB,GAAG,CAC1B,UAAyC,EACrC,EAAE;YACN,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACvD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACvB,WAAW,CAAC,MAAM,CAAC,CAAC;YACxB,CAAC;QACL,CAAC,CAAC;QAEF,OAAO;YACH,wBAAwB,CACpB,UAAuD;gBAEvD,MAAM,EAAE,WAAW,EAAE,GAAG,UAAU,CAAC;gBAEnC,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU,EAAE,CAAC;oBACjD,qBAAqB,CAAC,WAAW,CAAC,CAAC;oBACnC,OAAO;gBACX,CAAC;gBAED,IAAI,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;oBACtC,iCAAiC,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;oBAC3D,OAAO;gBACX,CAAC;gBAED,IAAI,kCAAkC,CAAC,WAAW,CAAC,EAAE,CAAC;oBAClD,WAAW,CAAC;wBACR,WAAW,EAAE,UAAU;wBACvB,IAAI,EAAE,iBAAiB,CAAC,WAAW,CAAC;wBACpC,IAAI,EAAE,SAAS;wBACf,UAAU,EAAE,WAAW;qBAC1B,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;YACD,sBAAsB,CAClB,UAAqD;gBAErD,IACI,UAAU,CAAC,WAAW,KAAK,IAAI;oBAC/B,sBAAsB,CAAC,UAAU,CAAC,WAAW,CAAC,EAChD,CAAC;oBACC,iCAAiC,CAC7B,UAAU,CAAC,WAAW,EACtB,UAAU,CACb,CAAC;gBACN,CAAC;gBAED,IAAI,UAAU,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;oBAC7B,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;oBAC5C,IAAI,SAAS,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe,EAAE,CAAC;wBACpD,SAAS;oBACb,CAAC;oBAED,qBAAqB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBAC3C,CAAC;YACL,CAAC;YACD,OAAO,CAAC,WAAuC;gBAC3C,kBAAkB,CAAC,KAAK,EAAE,CAAC;gBAC3B,cAAc,CAAC,KAAK,EAAE,CAAC;gBAEvB,KAAK,MAAM,SAAS,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC;oBACvC,IAAI,sBAAsB,CAAC,SAAS,CAAC,EAAE,CAAC;wBACpC,IAAI,kBAAkB,EAAE,CAAC;4BACrB,KAAK,MAAM,MAAM,IAAI,iCAAiC,CAClD,SAAS,EACT,SAAS,CACZ,EAAE,CAAC;gCACA,WAAW,CAAC,MAAM,CAAC,CAAC;4BACxB,CAAC;wBACL,CAAC;wBAED,uBAAuB,CAAC,SAAS,CAAC,CAAC;wBACnC,SAAS;oBACb,CAAC;oBAED,IACI,SAAS,CAAC,IAAI;wBACV,cAAc,CAAC,sBAAsB;wBACzC,SAAS,CAAC,WAAW,KAAK,IAAI;wBAC9B,sBAAsB,CAAC,SAAS,CAAC,WAAW,CAAC,EAC/C,CAAC;wBACC,uBAAuB,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;oBACnD,CAAC;gBACL,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,cAAc,EAAE,kBAAkB;IAClC,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,oHAAoH;YACxH,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,IAAI;YACjB,GAAG,EAAE,6FAA6F;SACrG;QACD,QAAQ,EAAE;YACN,YAAY,EAAE,kDAAkD;SACnE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,SAAS;CAClB,CAAC,CAAC;AAEH,eAAe,WAAW,CAAC"}

package/dist/rules/required-tags/require-alpha.cjs

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
+const RequireAlphaRule = (0, require_tag_factory_js_1.createTagRule)({
+    create(context) {
+        return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@alpha");
+    },
+    defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @alpha tag in TSDoc blocks for TypeScript declarations and default exports.",
+            frozen: false,
+            recommended: false,
+            url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-alpha.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @alpha.",
+        },
+        schema: [require_tag_factory_js_1.optionSchema],
+        type: "problem",
+    },
+    name: "require-alpha",
+});
+exports.default = RequireAlphaRule;
+//# sourceMappingURL=require-alpha.js.map

package/dist/rules/required-tags/require-alpha.d.ts

@@ -0,0 +1,4 @@
+import { type TagRuleModule } from "../../internal/require-tag-factory.js";
+declare const RequireAlphaRule: TagRuleModule;
+export default RequireAlphaRule;
+//# sourceMappingURL=require-alpha.d.ts.map

package/dist/rules/required-tags/require-alpha.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"require-alpha.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-alpha.ts"],"names":[],"mappings":"AAAA,OAAO,EAQH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,QAAA,MAAM,gBAAgB,EAAE,aA+BtB,CAAC;AAEH,eAAe,gBAAgB,CAAC"}

package/dist/rules/required-tags/require-alpha.js

@@ -0,0 +1,30 @@
+import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
+const RequireAlphaRule = createTagRule({
+    create(context) {
+        return createRequireTagRuleListener(context, "@alpha");
+    },
+    defaultOptions: defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @alpha tag in TSDoc blocks for TypeScript declarations and default exports.",
+            frozen: false,
+            recommended: false,
+            url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-alpha.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @alpha.",
+        },
+        schema: [optionSchema],
+        type: "problem",
+    },
+    name: "require-alpha",
+});
+export default RequireAlphaRule;
+//# sourceMappingURL=require-alpha.js.map

package/dist/rules/required-tags/require-alpha.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"require-alpha.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-alpha.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,gBAAgB,GAAkB,aAAa,CAGnD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IACD,cAAc,EAAE,kBAAkB;IAClC,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,qFAAqF;YACzF,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,iHAAiH;SACzH;QACD,QAAQ,EAAE;YACN,UAAU,EACN,8DAA8D;SACrE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,eAAe;CACxB,CAAC,CAAC;AAEH,eAAe,gBAAgB,CAAC"}

package/dist/rules/required-tags/require-beta.cjs

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
+const RequireBetaRule = (0, require_tag_factory_js_1.createTagRule)({
+    create(context) {
+        return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@beta");
+    },
+    defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @beta tag in TSDoc blocks for TypeScript declarations and default exports.",
+            frozen: false,
+            recommended: false,
+            url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-beta.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @beta.",
+        },
+        schema: [require_tag_factory_js_1.optionSchema],
+        type: "problem",
+    },
+    name: "require-beta",
+});
+exports.default = RequireBetaRule;
+//# sourceMappingURL=require-beta.js.map

package/dist/rules/required-tags/require-beta.d.ts

@@ -0,0 +1,4 @@
+import { type TagRuleModule } from "../../internal/require-tag-factory.js";
+declare const RequireBetaRule: TagRuleModule;
+export default RequireBetaRule;
+//# sourceMappingURL=require-beta.d.ts.map

package/dist/rules/required-tags/require-beta.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"require-beta.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-beta.ts"],"names":[],"mappings":"AAAA,OAAO,EAQH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,QAAA,MAAM,eAAe,EAAE,aA+BrB,CAAC;AAEH,eAAe,eAAe,CAAC"}

package/dist/rules/required-tags/require-beta.js

@@ -0,0 +1,30 @@
+import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
+const RequireBetaRule = createTagRule({
+    create(context) {
+        return createRequireTagRuleListener(context, "@beta");
+    },
+    defaultOptions: defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @beta tag in TSDoc blocks for TypeScript declarations and default exports.",
+            frozen: false,
+            recommended: false,
+            url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-beta.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @beta.",
+        },
+        schema: [optionSchema],
+        type: "problem",
+    },
+    name: "require-beta",
+});
+export default RequireBetaRule;
+//# sourceMappingURL=require-beta.js.map