eslint-plugin-tsdoc-require-2 1.0.7 → 1.0.9

package/dist/rules/require-tag-rules.d.ts

@@ -1,38 +1,13 @@
 import type { TSESLint } from "@typescript-eslint/utils";
 import type { TagRuleDefinition, TagRuleMessageIds, TagRuleOptions } from "../internal/require-tag-factory.js";
+/** Union of all required-tag rule names exported by this plugin. */
+type RequiredTagRuleName = "require-abstract" | "require-alpha" | "require-author" | "require-beta" | "require-category" | "require-class" | "require-decorator" | "require-default-value" | "require-deprecated" | "require-document" | "require-enum" | "require-event" | "require-event-property" | "require-example" | "require-expand" | "require-experimental" | "require-function" | "require-group" | "require-hidden" | "require-hideconstructor" | "require-ignore" | "require-import" | "require-include" | "require-inherit-doc" | "require-inline" | "require-interface" | "require-internal" | "require-label" | "require-license" | "require-link" | "require-merge-module-with" | "require-module" | "require-namespace" | "require-overload" | "require-override" | "require-package-documentation" | "require-param" | "require-primary-export" | "require-private" | "require-private-remarks" | "require-property" | "require-protected" | "require-public" | "require-readonly" | "require-remarks" | "require-returns" | "require-sealed" | "require-see" | "require-since" | "require-sort-strategy" | "require-summary" | "require-template" | "require-throws" | "require-type-param" | "require-use-declared-type" | "require-virtual";
+type TagRuleModuleMap = Record<string, TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>>;
 /** Definitions that map each required-tag rule name to its required TSDoc tag. */
 declare const requiredTagDefinitions: readonly TagRuleDefinition[];
-type RequiredTagRules = {
-    "require-alpha": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-beta": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-decorator": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-default-value": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-deprecated": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-event-property": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-example": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-experimental": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-inherit-doc": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-internal": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-label": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-link": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-override": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-package-documentation": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-param": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-private-remarks": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-public": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-readonly": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-remarks": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-returns": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-sealed": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-see": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-throws": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-type-param": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-    "require-virtual": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
-};
 /** Runtime map of required-tag rule modules keyed by rule name. */
-declare const requiredTagRules: RequiredTagRules;
-/** Union of all required-tag rule names exported by this plugin. */
-export type RequiredTagRuleName = keyof typeof requiredTagRules;
+declare const requiredTagRules: Record<RequiredTagRuleName, TagRuleModuleMap[string]>;
 export { requiredTagDefinitions };
 export { requiredTagRules };
+export type { RequiredTagRuleName };
 //# sourceMappingURL=require-tag-rules.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"require-tag-rules.d.ts","sourceRoot":"","sources":["../../src/rules/require-tag-rules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEzD,OAAO,KAAK,EACR,iBAAiB,EACjB,iBAAiB,EACjB,cAAc,EACjB,MAAM,oCAAoC,CAAC;AA4B5C,kFAAkF;AAClF,QAAA,MAAM,sBAAsB,EAAE,SAAS,iBAAiB,EA6BvD,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACpB,eAAe,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACxE,cAAc,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACvE,mBAAmB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAC5E,uBAAuB,EAAE,QAAQ,CAAC,UAAU,CACxC,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,oBAAoB,EAAE,QAAQ,CAAC,UAAU,CACrC,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,wBAAwB,EAAE,QAAQ,CAAC,UAAU,CACzC,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,iBAAiB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAC1E,sBAAsB,EAAE,QAAQ,CAAC,UAAU,CACvC,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,qBAAqB,EAAE,QAAQ,CAAC,UAAU,CACtC,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,kBAAkB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAC3E,eAAe,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACxE,cAAc,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACvE,kBAAkB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAC3E,+BAA+B,EAAE,QAAQ,CAAC,UAAU,CAChD,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,eAAe,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACxE,yBAAyB,EAAE,QAAQ,CAAC,UAAU,CAC1C,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,gBAAgB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACzE,kBAAkB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAC3E,iBAAiB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAC1E,iBAAiB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAC1E,gBAAgB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACzE,aAAa,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACtE,gBAAgB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACzE,oBAAoB,EAAE,QAAQ,CAAC,UAAU,CACrC,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,iBAAiB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;CAC7E,CAAC;AAEF,mEAAmE;AACnE,QAAA,MAAM,gBAAgB,EAAE,gBA0BvB,CAAC;AAEF,oEAAoE;AACpE,MAAM,MAAM,mBAAmB,GAAG,MAAM,OAAO,gBAAgB,CAAC;AAEhE,OAAO,EAAE,sBAAsB,EAAE,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"require-tag-rules.d.ts","sourceRoot":"","sources":["../../src/rules/require-tag-rules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEzD,OAAO,KAAK,EACR,iBAAiB,EACjB,iBAAiB,EACjB,cAAc,EACjB,MAAM,oCAAoC,CAAC;AA2D5C,oEAAoE;AACpE,KAAK,mBAAmB,GAClB,kBAAkB,GAClB,eAAe,GACf,gBAAgB,GAChB,cAAc,GACd,kBAAkB,GAClB,eAAe,GACf,mBAAmB,GACnB,uBAAuB,GACvB,oBAAoB,GACpB,kBAAkB,GAClB,cAAc,GACd,eAAe,GACf,wBAAwB,GACxB,iBAAiB,GACjB,gBAAgB,GAChB,sBAAsB,GACtB,kBAAkB,GAClB,eAAe,GACf,gBAAgB,GAChB,yBAAyB,GACzB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,GACjB,qBAAqB,GACrB,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,2BAA2B,GAC3B,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,+BAA+B,GAC/B,eAAe,GACf,wBAAwB,GACxB,iBAAiB,GACjB,yBAAyB,GACzB,kBAAkB,GAClB,mBAAmB,GACnB,gBAAgB,GAChB,kBAAkB,GAClB,iBAAiB,GACjB,iBAAiB,GACjB,gBAAgB,GAChB,aAAa,GACb,eAAe,GACf,uBAAuB,GACvB,iBAAiB,GACjB,kBAAkB,GAClB,gBAAgB,GAChB,oBAAoB,GACpB,2BAA2B,GAC3B,iBAAiB,CAAC;AAExB,KAAK,gBAAgB,GAAG,MAAM,CAC1B,MAAM,EACN,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CACzD,CAAC;AAEF,kFAAkF;AAClF,QAAA,MAAM,sBAAsB,EAAE,SAAS,iBAAiB,EA4DvD,CAAC;AAEF,mEAAmE;AACnE,QAAA,MAAM,gBAAgB,EAAE,MAAM,CAAC,mBAAmB,EAAE,gBAAgB,CAAC,MAAM,CAAC,CA0DvE,CAAC;AAEN,OAAO,EAAE,sBAAsB,EAAE,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAC5B,YAAY,EAAE,mBAAmB,EAAE,CAAC"}

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

@@ -1,85 +1,178 @@
+import requireAbstractRule from "./required-tags/require-abstract.js";
 import requireAlphaRule from "./required-tags/require-alpha.js";
+import requireAuthorRule from "./required-tags/require-author.js";
 import requireBetaRule from "./required-tags/require-beta.js";
+import requireCategoryRule from "./required-tags/require-category.js";
+import requireClassRule from "./required-tags/require-class.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 requireDocumentRule from "./required-tags/require-document.js";
+import requireEnumRule from "./required-tags/require-enum.js";
 import requireEventPropertyRule from "./required-tags/require-event-property.js";
+import requireEventRule from "./required-tags/require-event.js";
 import requireExampleRule from "./required-tags/require-example.js";
+import requireExpandRule from "./required-tags/require-expand.js";
 import requireExperimentalRule from "./required-tags/require-experimental.js";
+import requireFunctionRule from "./required-tags/require-function.js";
+import requireGroupRule from "./required-tags/require-group.js";
+import requireHiddenRule from "./required-tags/require-hidden.js";
+import requireHideconstructorRule from "./required-tags/require-hideconstructor.js";
+import requireIgnoreRule from "./required-tags/require-ignore.js";
+import requireImportRule from "./required-tags/require-import.js";
+import requireIncludeRule from "./required-tags/require-include.js";
 import requireInheritDocRule from "./required-tags/require-inherit-doc.js";
+import requireInlineRule from "./required-tags/require-inline.js";
+import requireInterfaceRule from "./required-tags/require-interface.js";
 import requireInternalRule from "./required-tags/require-internal.js";
 import requireLabelRule from "./required-tags/require-label.js";
+import requireLicenseRule from "./required-tags/require-license.js";
 import requireLinkRule from "./required-tags/require-link.js";
+import requireMergeModuleWithRule from "./required-tags/require-merge-module-with.js";
+import requireModuleRule from "./required-tags/require-module.js";
+import requireNamespaceRule from "./required-tags/require-namespace.js";
+import requireOverloadRule from "./required-tags/require-overload.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 requirePrimaryExportRule from "./required-tags/require-primary-export.js";
 import requirePrivateRemarksRule from "./required-tags/require-private-remarks.js";
+import requirePrivateRule from "./required-tags/require-private.js";
+import requirePropertyRule from "./required-tags/require-property.js";
+import requireProtectedRule from "./required-tags/require-protected.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 requireSinceRule from "./required-tags/require-since.js";
+import requireSortStrategyRule from "./required-tags/require-sort-strategy.js";
+import requireSummaryRule from "./required-tags/require-summary.js";
+import requireTemplateRule from "./required-tags/require-template.js";
 import requireThrowsRule from "./required-tags/require-throws.js";
 import requireTypeParamRule from "./required-tags/require-type-param.js";
+import requireUseDeclaredTypeRule from "./required-tags/require-use-declared-type.js";
 import requireVirtualRule from "./required-tags/require-virtual.js";
 /** Definitions that map each required-tag rule name to its required TSDoc tag. */
 const requiredTagDefinitions = [
+    { ruleName: "require-abstract", tagName: "@abstract" },
     { ruleName: "require-alpha", tagName: "@alpha" },
+    { ruleName: "require-author", tagName: "@author" },
     { ruleName: "require-beta", tagName: "@beta" },
+    { ruleName: "require-category", tagName: "@category" },
+    { ruleName: "require-class", tagName: "@class" },
     { ruleName: "require-decorator", tagName: "@decorator" },
     { ruleName: "require-default-value", tagName: "@defaultValue" },
     { ruleName: "require-deprecated", tagName: "@deprecated" },
+    { ruleName: "require-document", tagName: "@document" },
+    { ruleName: "require-enum", tagName: "@enum" },
+    { ruleName: "require-event", tagName: "@event" },
     { ruleName: "require-event-property", tagName: "@eventProperty" },
     { ruleName: "require-example", tagName: "@example" },
+    { ruleName: "require-expand", tagName: "@expand" },
     { ruleName: "require-experimental", tagName: "@experimental" },
+    { ruleName: "require-function", tagName: "@function" },
+    { ruleName: "require-group", tagName: "@group" },
+    { ruleName: "require-hidden", tagName: "@hidden" },
+    { ruleName: "require-hideconstructor", tagName: "@hideconstructor" },
+    { ruleName: "require-ignore", tagName: "@ignore" },
+    { ruleName: "require-import", tagName: "@import" },
+    { ruleName: "require-include", tagName: "@include" },
     { ruleName: "require-inherit-doc", tagName: "@inheritDoc" },
+    { ruleName: "require-inline", tagName: "@inline" },
+    { ruleName: "require-interface", tagName: "@interface" },
     { ruleName: "require-internal", tagName: "@internal" },
     { ruleName: "require-label", tagName: "@label" },
+    { ruleName: "require-license", tagName: "@license" },
     { ruleName: "require-link", tagName: "@link" },
+    { ruleName: "require-merge-module-with", tagName: "@mergeModuleWith" },
+    { ruleName: "require-module", tagName: "@module" },
+    { ruleName: "require-namespace", tagName: "@namespace" },
+    { ruleName: "require-overload", tagName: "@overload" },
     { ruleName: "require-override", tagName: "@override" },
     {
         ruleName: "require-package-documentation",
         tagName: "@packageDocumentation",
     },
     { ruleName: "require-param", tagName: "@param" },
+    { ruleName: "require-primary-export", tagName: "@primaryExport" },
+    { ruleName: "require-private", tagName: "@private" },
     { ruleName: "require-private-remarks", tagName: "@privateRemarks" },
+    { ruleName: "require-property", tagName: "@property" },
+    { ruleName: "require-protected", tagName: "@protected" },
     { 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-since", tagName: "@since" },
+    { ruleName: "require-sort-strategy", tagName: "@sortStrategy" },
+    { ruleName: "require-summary", tagName: "@summary" },
+    { ruleName: "require-template", tagName: "@template" },
     { ruleName: "require-throws", tagName: "@throws" },
     { ruleName: "require-type-param", tagName: "@typeParam" },
+    { ruleName: "require-use-declared-type", tagName: "@useDeclaredType" },
     { ruleName: "require-virtual", tagName: "@virtual" },
 ];
 /** Runtime map of required-tag rule modules keyed by rule name. */
 const requiredTagRules = {
+    "require-abstract": requireAbstractRule,
     "require-alpha": requireAlphaRule,
+    "require-author": requireAuthorRule,
     "require-beta": requireBetaRule,
+    "require-category": requireCategoryRule,
+    "require-class": requireClassRule,
     "require-decorator": requireDecoratorRule,
     "require-default-value": requireDefaultValueRule,
     "require-deprecated": requireDeprecatedRule,
+    "require-document": requireDocumentRule,
+    "require-enum": requireEnumRule,
+    "require-event": requireEventRule,
     "require-event-property": requireEventPropertyRule,
     "require-example": requireExampleRule,
+    "require-expand": requireExpandRule,
     "require-experimental": requireExperimentalRule,
+    "require-function": requireFunctionRule,
+    "require-group": requireGroupRule,
+    "require-hidden": requireHiddenRule,
+    "require-hideconstructor": requireHideconstructorRule,
+    "require-ignore": requireIgnoreRule,
+    "require-import": requireImportRule,
+    "require-include": requireIncludeRule,
     "require-inherit-doc": requireInheritDocRule,
+    "require-inline": requireInlineRule,
+    "require-interface": requireInterfaceRule,
     "require-internal": requireInternalRule,
     "require-label": requireLabelRule,
+    "require-license": requireLicenseRule,
     "require-link": requireLinkRule,
+    "require-merge-module-with": requireMergeModuleWithRule,
+    "require-module": requireModuleRule,
+    "require-namespace": requireNamespaceRule,
+    "require-overload": requireOverloadRule,
     "require-override": requireOverrideRule,
     "require-package-documentation": requirePackageDocumentationRule,
     "require-param": requireParamRule,
+    "require-primary-export": requirePrimaryExportRule,
+    "require-private": requirePrivateRule,
     "require-private-remarks": requirePrivateRemarksRule,
+    "require-property": requirePropertyRule,
+    "require-protected": requireProtectedRule,
     "require-public": requirePublicRule,
     "require-readonly": requireReadonlyRule,
     "require-remarks": requireRemarksRule,
     "require-returns": requireReturnsRule,
     "require-sealed": requireSealedRule,
     "require-see": requireSeeRule,
+    "require-since": requireSinceRule,
+    "require-sort-strategy": requireSortStrategyRule,
+    "require-summary": requireSummaryRule,
+    "require-template": requireTemplateRule,
     "require-throws": requireThrowsRule,
     "require-type-param": requireTypeParamRule,
+    "require-use-declared-type": requireUseDeclaredTypeRule,
     "require-virtual": requireVirtualRule,
 };
 export { requiredTagDefinitions };

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

@@ -1 +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,kFAAkF;AAClF,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,mEAAmE;AACnE,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;AAKF,OAAO,EAAE,sBAAsB,EAAE,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"require-tag-rules.js","sourceRoot":"","sources":["../../src/rules/require-tag-rules.ts"],"names":[],"mappings":"AAQA,OAAO,mBAAmB,MAAM,qCAAqC,CAAC;AACtE,OAAO,gBAAgB,MAAM,kCAAkC,CAAC;AAChE,OAAO,iBAAiB,MAAM,mCAAmC,CAAC;AAClE,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAC9D,OAAO,mBAAmB,MAAM,qCAAqC,CAAC;AACtE,OAAO,gBAAgB,MAAM,kCAAkC,CAAC;AAChE,OAAO,oBAAoB,MAAM,sCAAsC,CAAC;AACxE,OAAO,uBAAuB,MAAM,0CAA0C,CAAC;AAC/E,OAAO,qBAAqB,MAAM,uCAAuC,CAAC;AAC1E,OAAO,mBAAmB,MAAM,qCAAqC,CAAC;AACtE,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAC9D,OAAO,wBAAwB,MAAM,2CAA2C,CAAC;AACjF,OAAO,gBAAgB,MAAM,kCAAkC,CAAC;AAChE,OAAO,kBAAkB,MAAM,oCAAoC,CAAC;AACpE,OAAO,iBAAiB,MAAM,mCAAmC,CAAC;AAClE,OAAO,uBAAuB,MAAM,yCAAyC,CAAC;AAC9E,OAAO,mBAAmB,MAAM,qCAAqC,CAAC;AACtE,OAAO,gBAAgB,MAAM,kCAAkC,CAAC;AAChE,OAAO,iBAAiB,MAAM,mCAAmC,CAAC;AAClE,OAAO,0BAA0B,MAAM,4CAA4C,CAAC;AACpF,OAAO,iBAAiB,MAAM,mCAAmC,CAAC;AAClE,OAAO,iBAAiB,MAAM,mCAAmC,CAAC;AAClE,OAAO,kBAAkB,MAAM,oCAAoC,CAAC;AACpE,OAAO,qBAAqB,MAAM,wCAAwC,CAAC;AAC3E,OAAO,iBAAiB,MAAM,mCAAmC,CAAC;AAClE,OAAO,oBAAoB,MAAM,sCAAsC,CAAC;AACxE,OAAO,mBAAmB,MAAM,qCAAqC,CAAC;AACtE,OAAO,gBAAgB,MAAM,kCAAkC,CAAC;AAChE,OAAO,kBAAkB,MAAM,oCAAoC,CAAC;AACpE,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAC9D,OAAO,0BAA0B,MAAM,8CAA8C,CAAC;AACtF,OAAO,iBAAiB,MAAM,mCAAmC,CAAC;AAClE,OAAO,oBAAoB,MAAM,sCAAsC,CAAC;AACxE,OAAO,mBAAmB,MAAM,qCAAqC,CAAC;AACtE,OAAO,mBAAmB,MAAM,qCAAqC,CAAC;AACtE,OAAO,+BAA+B,MAAM,kDAAkD,CAAC;AAC/F,OAAO,gBAAgB,MAAM,kCAAkC,CAAC;AAChE,OAAO,wBAAwB,MAAM,2CAA2C,CAAC;AACjF,OAAO,yBAAyB,MAAM,4CAA4C,CAAC;AACnF,OAAO,kBAAkB,MAAM,oCAAoC,CAAC;AACpE,OAAO,mBAAmB,MAAM,qCAAqC,CAAC;AACtE,OAAO,oBAAoB,MAAM,sCAAsC,CAAC;AACxE,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,gBAAgB,MAAM,kCAAkC,CAAC;AAChE,OAAO,uBAAuB,MAAM,0CAA0C,CAAC;AAC/E,OAAO,kBAAkB,MAAM,oCAAoC,CAAC;AACpE,OAAO,mBAAmB,MAAM,qCAAqC,CAAC;AACtE,OAAO,iBAAiB,MAAM,mCAAmC,CAAC;AAClE,OAAO,oBAAoB,MAAM,uCAAuC,CAAC;AACzE,OAAO,0BAA0B,MAAM,8CAA8C,CAAC;AACtF,OAAO,kBAAkB,MAAM,oCAAoC,CAAC;AAkEpE,kFAAkF;AAClF,MAAM,sBAAsB,GAAiC;IACzD,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,WAAW,EAAE;IACtD,EAAE,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE;IAChD,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE;IAClD,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,EAAE;IAC9C,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,WAAW,EAAE;IACtD,EAAE,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE;IAChD,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,kBAAkB,EAAE,OAAO,EAAE,WAAW,EAAE;IACtD,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,EAAE;IAC9C,EAAE,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE;IAChD,EAAE,QAAQ,EAAE,wBAAwB,EAAE,OAAO,EAAE,gBAAgB,EAAE;IACjE,EAAE,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,UAAU,EAAE;IACpD,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE;IAClD,EAAE,QAAQ,EAAE,sBAAsB,EAAE,OAAO,EAAE,eAAe,EAAE;IAC9D,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,WAAW,EAAE;IACtD,EAAE,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE;IAChD,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE;IAClD,EAAE,QAAQ,EAAE,yBAAyB,EAAE,OAAO,EAAE,kBAAkB,EAAE;IACpE,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE;IAClD,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE;IAClD,EAAE,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,UAAU,EAAE;IACpD,EAAE,QAAQ,EAAE,qBAAqB,EAAE,OAAO,EAAE,aAAa,EAAE;IAC3D,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE;IAClD,EAAE,QAAQ,EAAE,mBAAmB,EAAE,OAAO,EAAE,YAAY,EAAE;IACxD,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,WAAW,EAAE;IACtD,EAAE,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE;IAChD,EAAE,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,UAAU,EAAE;IACpD,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,EAAE;IAC9C,EAAE,QAAQ,EAAE,2BAA2B,EAAE,OAAO,EAAE,kBAAkB,EAAE;IACtE,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE;IAClD,EAAE,QAAQ,EAAE,mBAAmB,EAAE,OAAO,EAAE,YAAY,EAAE;IACxD,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,WAAW,EAAE;IACtD,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,wBAAwB,EAAE,OAAO,EAAE,gBAAgB,EAAE;IACjE,EAAE,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,UAAU,EAAE;IACpD,EAAE,QAAQ,EAAE,yBAAyB,EAAE,OAAO,EAAE,iBAAiB,EAAE;IACnE,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,WAAW,EAAE;IACtD,EAAE,QAAQ,EAAE,mBAAmB,EAAE,OAAO,EAAE,YAAY,EAAE;IACxD,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,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE;IAChD,EAAE,QAAQ,EAAE,uBAAuB,EAAE,OAAO,EAAE,eAAe,EAAE;IAC/D,EAAE,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,UAAU,EAAE;IACpD,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,WAAW,EAAE;IACtD,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE;IAClD,EAAE,QAAQ,EAAE,oBAAoB,EAAE,OAAO,EAAE,YAAY,EAAE;IACzD,EAAE,QAAQ,EAAE,2BAA2B,EAAE,OAAO,EAAE,kBAAkB,EAAE;IACtE,EAAE,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,UAAU,EAAE;CACvD,CAAC;AAEF,mEAAmE;AACnE,MAAM,gBAAgB,GAClB;IACI,kBAAkB,EAAE,mBAAmB;IACvC,eAAe,EAAE,gBAAgB;IACjC,gBAAgB,EAAE,iBAAiB;IACnC,cAAc,EAAE,eAAe;IAC/B,kBAAkB,EAAE,mBAAmB;IACvC,eAAe,EAAE,gBAAgB;IACjC,mBAAmB,EAAE,oBAAoB;IACzC,uBAAuB,EAAE,uBAAuB;IAChD,oBAAoB,EAAE,qBAAqB;IAC3C,kBAAkB,EAAE,mBAAmB;IACvC,cAAc,EAAE,eAAe;IAC/B,eAAe,EAAE,gBAAgB;IACjC,wBAAwB,EAAE,wBAAwB;IAClD,iBAAiB,EAAE,kBAAkB;IACrC,gBAAgB,EAAE,iBAAiB;IACnC,sBAAsB,EAAE,uBAAuB;IAC/C,kBAAkB,EAAE,mBAAmB;IACvC,eAAe,EAAE,gBAAgB;IACjC,gBAAgB,EAAE,iBAAiB;IACnC,yBAAyB,EAAE,0BAA0B;IACrD,gBAAgB,EAAE,iBAAiB;IACnC,gBAAgB,EAAE,iBAAiB;IACnC,iBAAiB,EAAE,kBAAkB;IACrC,qBAAqB,EAAE,qBAAqB;IAC5C,gBAAgB,EAAE,iBAAiB;IACnC,mBAAmB,EAAE,oBAAoB;IACzC,kBAAkB,EAAE,mBAAmB;IACvC,eAAe,EAAE,gBAAgB;IACjC,iBAAiB,EAAE,kBAAkB;IACrC,cAAc,EAAE,eAAe;IAC/B,2BAA2B,EAAE,0BAA0B;IACvD,gBAAgB,EAAE,iBAAiB;IACnC,mBAAmB,EAAE,oBAAoB;IACzC,kBAAkB,EAAE,mBAAmB;IACvC,kBAAkB,EAAE,mBAAmB;IACvC,+BAA+B,EAAE,+BAA+B;IAChE,eAAe,EAAE,gBAAgB;IACjC,wBAAwB,EAAE,wBAAwB;IAClD,iBAAiB,EAAE,kBAAkB;IACrC,yBAAyB,EAAE,yBAAyB;IACpD,kBAAkB,EAAE,mBAAmB;IACvC,mBAAmB,EAAE,oBAAoB;IACzC,gBAAgB,EAAE,iBAAiB;IACnC,kBAAkB,EAAE,mBAAmB;IACvC,iBAAiB,EAAE,kBAAkB;IACrC,iBAAiB,EAAE,kBAAkB;IACrC,gBAAgB,EAAE,iBAAiB;IACnC,aAAa,EAAE,cAAc;IAC7B,eAAe,EAAE,gBAAgB;IACjC,uBAAuB,EAAE,uBAAuB;IAChD,iBAAiB,EAAE,kBAAkB;IACrC,kBAAkB,EAAE,mBAAmB;IACvC,gBAAgB,EAAE,iBAAiB;IACnC,oBAAoB,EAAE,oBAAoB;IAC1C,2BAA2B,EAAE,0BAA0B;IACvD,iBAAiB,EAAE,kBAAkB;CACxC,CAAC;AAEN,OAAO,EAAE,sBAAsB,EAAE,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/rules/require.cjs

@@ -6,17 +6,12 @@ const enforceableEntityKinds = [
     "enum",
     "function",
     "interface",
+    "namespace",
     "object",
     "type",
     "variable",
 ];
 const defaultEnforceFor = [...enforceableEntityKinds];
-const defaultRuleOptions = [
-    {
-        enforceFor: defaultEnforceFor,
-        includeNonExported: false,
-    },
-];
 const optionSchema = {
     additionalProperties: false,
     properties: {
@@ -28,24 +23,41 @@ const optionSchema = {
             type: "array",
             uniqueItems: true,
         },
+        exportMode: {
+            description: "Choose whether to check exported declarations, non-exported top-level declarations, or both.",
+            enum: [
+                "all",
+                "exported",
+                "non-exported",
+            ],
+            type: "string",
+        },
         includeNonExported: {
             default: false,
-            description: "Also enforce on non-exported declarations (opt-in).",
+            description: 'Legacy alias for exportMode: "all". Also enforce on non-exported declarations when true.',
             type: "boolean",
         },
     },
     type: "object",
 };
+const resolveExportMode = (ruleOption) => {
+    if (ruleOption?.includeNonExported === true) {
+        return "all";
+    }
+    return ruleOption?.exportMode ?? "exported";
+};
+const shouldCheckExportedDeclarations = (exportMode) => exportMode === "all" || exportMode === "exported";
+const shouldCheckNonExportedDeclarations = (exportMode) => exportMode === "all" || exportMode === "non-exported";
 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.TSModuleDeclaration ||
     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 ||
@@ -66,6 +78,17 @@ const getExpressionKind = (node) => {
     return assertUnreachable(node);
 };
 const getEntityDisplayName = (name) => name ?? "<default export>";
+const isTopLevelNode = (node) => node.parent?.type === utils_1.AST_NODE_TYPES.Program;
+const getModuleDeclarationName = (declaration) => {
+    if (declaration.id.type === utils_1.AST_NODE_TYPES.Identifier) {
+        return declaration.id.name;
+    }
+    if (declaration.id.type === utils_1.AST_NODE_TYPES.Literal &&
+        typeof declaration.id.value === "string") {
+        return declaration.id.value;
+    }
+    return undefined;
+};
 const hasTSDocComment = (sourceCode, node) => {
     const comments = sourceCode.getCommentsBefore(node);
     const nearestComment = comments.at(-1);
@@ -132,6 +155,16 @@ const declarationTargets = (declaration) => {
             },
         ];
     }
+    if (declaration.type === utils_1.AST_NODE_TYPES.TSModuleDeclaration) {
+        return [
+            {
+                commentNode: declaration,
+                kind: "namespace",
+                name: getModuleDeclarationName(declaration),
+                reportNode: declaration,
+            },
+        ];
+    }
     if (declaration.type === utils_1.AST_NODE_TYPES.TSTypeAliasDeclaration) {
         return [
             {
@@ -171,7 +204,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 exportMode = resolveExportMode(ruleOption);
         const checkTarget = (target) => {
             if (!enabledKinds.has(target.kind)) {
                 return;
@@ -214,6 +247,10 @@ const requireRule = createRule({
         };
         return {
             ExportDefaultDeclaration(exportNode) {
+                if (!shouldCheckExportedDeclarations(exportMode) ||
+                    !isTopLevelNode(exportNode)) {
+                    return;
+                }
                 const { declaration } = exportNode;
                 if (declaration.type === utils_1.AST_NODE_TYPES.Identifier) {
                     checkIdentifierExport(declaration);
@@ -233,6 +270,10 @@ const requireRule = createRule({
                 }
             },
             ExportNamedDeclaration(exportNode) {
+                if (!shouldCheckExportedDeclarations(exportMode) ||
+                    !isTopLevelNode(exportNode)) {
+                    return;
+                }
                 if (exportNode.declaration !== null &&
                     isSupportedDeclaration(exportNode.declaration)) {
                     checkDeclarationWithExportComment(exportNode.declaration, exportNode);
@@ -252,16 +293,19 @@ const requireRule = createRule({
                 checkedTargets.clear();
                 for (const statement of programNode.body) {
                     if (isSupportedDeclaration(statement)) {
-                        if (includeNonExported) {
+                        if (shouldCheckNonExportedDeclarations(exportMode)) {
                             for (const target of declarationTargetsWithCommentNode(statement, statement)) {
                                 checkTarget(target);
                             }
                         }
-                        trackDeclarationTargets(statement);
+                        if (shouldCheckExportedDeclarations(exportMode)) {
+                            trackDeclarationTargets(statement);
+                        }
                         continue;
                     }
-                    if (statement.type ===
-                        utils_1.AST_NODE_TYPES.ExportNamedDeclaration &&
+                    if (shouldCheckExportedDeclarations(exportMode) &&
+                        statement.type ===
+                            utils_1.AST_NODE_TYPES.ExportNamedDeclaration &&
                         statement.declaration !== null &&
                         isSupportedDeclaration(statement.declaration)) {
                         trackDeclarationTargets(statement.declaration);
@@ -270,17 +314,16 @@ const requireRule = createRule({
             },
         };
     },
-    defaultOptions: defaultRuleOptions,
     meta: {
         defaultOptions: [
             {
                 enforceFor: [...enforceableEntityKinds],
-                includeNonExported: false,
+                exportMode: "exported",
             },
         ],
         deprecated: false,
         docs: {
-            description: "require TSDoc comments for exported TypeScript declarations and default exports, with opt-in non-exported support.",
+            description: "require TSDoc comments for supported TypeScript declarations and default exports, with configurable export scope.",
             frozen: false,
             recommended: true,
             url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/require.md",

package/dist/rules/require.d.ts

@@ -1,9 +1,11 @@
 import type { TSESLint } from "@typescript-eslint/utils";
-type EntityKind = "class" | "enum" | "function" | "interface" | "object" | "type" | "variable";
+type EntityKind = "class" | "enum" | "function" | "interface" | "namespace" | "object" | "type" | "variable";
+type ExportMode = "all" | "exported" | "non-exported";
 type MessageIds = "missingTSDoc";
 type Options = [RuleOption];
 type RuleOption = {
     enforceFor?: readonly EntityKind[];
+    exportMode?: ExportMode;
     includeNonExported?: boolean;
 };
 /** ESLint rule module implementing tsdoc-require-2/require. */

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;IACnC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC,CAAC;AAgPF,+DAA+D;AAC/D,QAAA,MAAM,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAmLxD,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,WAAW,GACX,QAAQ,GACR,MAAM,GACN,UAAU,CAAC;AACjB,KAAK,UAAU,GAAG,KAAK,GAAG,UAAU,GAAG,cAAc,CAAC;AACtD,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,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC,CAAC;AAqSF,+DAA+D;AAC/D,QAAA,MAAM,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAmMxD,CAAC;AAEH,eAAe,WAAW,CAAC"}

package/dist/rules/require.js

@@ -4,17 +4,12 @@ const enforceableEntityKinds = [
     "enum",
     "function",
     "interface",
+    "namespace",
     "object",
     "type",
     "variable",
 ];
 const defaultEnforceFor = [...enforceableEntityKinds];
-const defaultRuleOptions = [
-    {
-        enforceFor: defaultEnforceFor,
-        includeNonExported: false,
-    },
-];
 const optionSchema = {
     additionalProperties: false,
     properties: {
@@ -26,24 +21,41 @@ const optionSchema = {
             type: "array",
             uniqueItems: true,
         },
+        exportMode: {
+            description: "Choose whether to check exported declarations, non-exported top-level declarations, or both.",
+            enum: [
+                "all",
+                "exported",
+                "non-exported",
+            ],
+            type: "string",
+        },
         includeNonExported: {
             default: false,
-            description: "Also enforce on non-exported declarations (opt-in).",
+            description: 'Legacy alias for exportMode: "all". Also enforce on non-exported declarations when true.',
             type: "boolean",
         },
     },
     type: "object",
 };
+const resolveExportMode = (ruleOption) => {
+    if (ruleOption?.includeNonExported === true) {
+        return "all";
+    }
+    return ruleOption?.exportMode ?? "exported";
+};
+const shouldCheckExportedDeclarations = (exportMode) => exportMode === "all" || exportMode === "exported";
+const shouldCheckNonExportedDeclarations = (exportMode) => exportMode === "all" || exportMode === "non-exported";
 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 = ESLintUtils.RuleCreator((ruleName) => `https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/${ruleName}.md`);
 const isSupportedDeclaration = (node) => node.type === AST_NODE_TYPES.ClassDeclaration ||
     node.type === AST_NODE_TYPES.FunctionDeclaration ||
     node.type === AST_NODE_TYPES.TSDeclareFunction ||
     node.type === AST_NODE_TYPES.TSEnumDeclaration ||
     node.type === AST_NODE_TYPES.TSInterfaceDeclaration ||
+    node.type === AST_NODE_TYPES.TSModuleDeclaration ||
     node.type === AST_NODE_TYPES.TSTypeAliasDeclaration ||
     node.type === AST_NODE_TYPES.VariableDeclaration;
 const isSupportedDefaultExportExpression = (node) => node.type === AST_NODE_TYPES.ArrowFunctionExpression ||
@@ -64,6 +76,17 @@ const getExpressionKind = (node) => {
     return assertUnreachable(node);
 };
 const getEntityDisplayName = (name) => name ?? "<default export>";
+const isTopLevelNode = (node) => node.parent?.type === AST_NODE_TYPES.Program;
+const getModuleDeclarationName = (declaration) => {
+    if (declaration.id.type === AST_NODE_TYPES.Identifier) {
+        return declaration.id.name;
+    }
+    if (declaration.id.type === AST_NODE_TYPES.Literal &&
+        typeof declaration.id.value === "string") {
+        return declaration.id.value;
+    }
+    return undefined;
+};
 const hasTSDocComment = (sourceCode, node) => {
     const comments = sourceCode.getCommentsBefore(node);
     const nearestComment = comments.at(-1);
@@ -130,6 +153,16 @@ const declarationTargets = (declaration) => {
             },
         ];
     }
+    if (declaration.type === AST_NODE_TYPES.TSModuleDeclaration) {
+        return [
+            {
+                commentNode: declaration,
+                kind: "namespace",
+                name: getModuleDeclarationName(declaration),
+                reportNode: declaration,
+            },
+        ];
+    }
     if (declaration.type === AST_NODE_TYPES.TSTypeAliasDeclaration) {
         return [
             {
@@ -169,7 +202,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 exportMode = resolveExportMode(ruleOption);
         const checkTarget = (target) => {
             if (!enabledKinds.has(target.kind)) {
                 return;
@@ -212,6 +245,10 @@ const requireRule = createRule({
         };
         return {
             ExportDefaultDeclaration(exportNode) {
+                if (!shouldCheckExportedDeclarations(exportMode) ||
+                    !isTopLevelNode(exportNode)) {
+                    return;
+                }
                 const { declaration } = exportNode;
                 if (declaration.type === AST_NODE_TYPES.Identifier) {
                     checkIdentifierExport(declaration);
@@ -231,6 +268,10 @@ const requireRule = createRule({
                 }
             },
             ExportNamedDeclaration(exportNode) {
+                if (!shouldCheckExportedDeclarations(exportMode) ||
+                    !isTopLevelNode(exportNode)) {
+                    return;
+                }
                 if (exportNode.declaration !== null &&
                     isSupportedDeclaration(exportNode.declaration)) {
                     checkDeclarationWithExportComment(exportNode.declaration, exportNode);
@@ -250,16 +291,19 @@ const requireRule = createRule({
                 checkedTargets.clear();
                 for (const statement of programNode.body) {
                     if (isSupportedDeclaration(statement)) {
-                        if (includeNonExported) {
+                        if (shouldCheckNonExportedDeclarations(exportMode)) {
                             for (const target of declarationTargetsWithCommentNode(statement, statement)) {
                                 checkTarget(target);
                             }
                         }
-                        trackDeclarationTargets(statement);
+                        if (shouldCheckExportedDeclarations(exportMode)) {
+                            trackDeclarationTargets(statement);
+                        }
                         continue;
                     }
-                    if (statement.type ===
-                        AST_NODE_TYPES.ExportNamedDeclaration &&
+                    if (shouldCheckExportedDeclarations(exportMode) &&
+                        statement.type ===
+                            AST_NODE_TYPES.ExportNamedDeclaration &&
                         statement.declaration !== null &&
                         isSupportedDeclaration(statement.declaration)) {
                         trackDeclarationTargets(statement.declaration);
@@ -268,17 +312,16 @@ const requireRule = createRule({
             },
         };
     },
-    defaultOptions: defaultRuleOptions,
     meta: {
         defaultOptions: [
             {
                 enforceFor: [...enforceableEntityKinds],
-                includeNonExported: false,
+                exportMode: "exported",
             },
         ],
         deprecated: false,
         docs: {
-            description: "require TSDoc comments for exported TypeScript declarations and default exports, with opt-in non-exported support.",
+            description: "require TSDoc comments for supported TypeScript declarations and default exports, with configurable export scope.",
             frozen: false,
             recommended: true,
             url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/require.md",