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

package/dist/rules/required-tags/require-remarks.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 RequireRemarksRule = (0, require_tag_factory_js_1.createTagRule)({
+    create(context) {
+        return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@remarks");
+    },
+    defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @remarks 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-remarks.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @remarks.",
+        },
+        schema: [require_tag_factory_js_1.optionSchema],
+        type: "problem",
+    },
+    name: "require-remarks",
+});
+exports.default = RequireRemarksRule;
+//# sourceMappingURL=require-remarks.js.map

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

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

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

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

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

@@ -0,0 +1,30 @@
+import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
+const RequireRemarksRule = createTagRule({
+    create(context) {
+        return createRequireTagRuleListener(context, "@remarks");
+    },
+    defaultOptions: defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @remarks 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-remarks.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @remarks.",
+        },
+        schema: [optionSchema],
+        type: "problem",
+    },
+    name: "require-remarks",
+});
+export default RequireRemarksRule;
+//# sourceMappingURL=require-remarks.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"require-remarks.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-remarks.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,kBAAkB,GAAkB,aAAa,CAGrD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC7D,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,uFAAuF;YAC3F,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,mHAAmH;SAC3H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,gEAAgE;SACvE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,iBAAiB;CAC1B,CAAC,CAAC;AAEH,eAAe,kBAAkB,CAAC"}

package/dist/rules/required-tags/require-returns.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 RequireReturnsRule = (0, require_tag_factory_js_1.createTagRule)({
+    create(context) {
+        return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@returns");
+    },
+    defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @returns 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-returns.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @returns.",
+        },
+        schema: [require_tag_factory_js_1.optionSchema],
+        type: "problem",
+    },
+    name: "require-returns",
+});
+exports.default = RequireReturnsRule;
+//# sourceMappingURL=require-returns.js.map

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

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

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

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

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

@@ -0,0 +1,30 @@
+import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
+const RequireReturnsRule = createTagRule({
+    create(context) {
+        return createRequireTagRuleListener(context, "@returns");
+    },
+    defaultOptions: defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @returns 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-returns.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @returns.",
+        },
+        schema: [optionSchema],
+        type: "problem",
+    },
+    name: "require-returns",
+});
+export default RequireReturnsRule;
+//# sourceMappingURL=require-returns.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"require-returns.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-returns.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,kBAAkB,GAAkB,aAAa,CAGrD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC7D,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,uFAAuF;YAC3F,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,mHAAmH;SAC3H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,gEAAgE;SACvE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,iBAAiB;CAC1B,CAAC,CAAC;AAEH,eAAe,kBAAkB,CAAC"}

package/dist/rules/required-tags/require-sealed.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 RequireSealedRule = (0, require_tag_factory_js_1.createTagRule)({
+    create(context) {
+        return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@sealed");
+    },
+    defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @sealed 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-sealed.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @sealed.",
+        },
+        schema: [require_tag_factory_js_1.optionSchema],
+        type: "problem",
+    },
+    name: "require-sealed",
+});
+exports.default = RequireSealedRule;
+//# sourceMappingURL=require-sealed.js.map

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

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

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

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

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

@@ -0,0 +1,30 @@
+import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
+const RequireSealedRule = createTagRule({
+    create(context) {
+        return createRequireTagRuleListener(context, "@sealed");
+    },
+    defaultOptions: defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @sealed 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-sealed.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @sealed.",
+        },
+        schema: [optionSchema],
+        type: "problem",
+    },
+    name: "require-sealed",
+});
+export default RequireSealedRule;
+//# sourceMappingURL=require-sealed.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"require-sealed.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-sealed.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,iBAAiB,GAAkB,aAAa,CAGpD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAC5D,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,sFAAsF;YAC1F,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,kHAAkH;SAC1H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,+DAA+D;SACtE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,gBAAgB;CACzB,CAAC,CAAC;AAEH,eAAe,iBAAiB,CAAC"}

package/dist/rules/required-tags/require-see.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 RequireSeeRule = (0, require_tag_factory_js_1.createTagRule)({
+    create(context) {
+        return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@see");
+    },
+    defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @see 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-see.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @see.",
+        },
+        schema: [require_tag_factory_js_1.optionSchema],
+        type: "problem",
+    },
+    name: "require-see",
+});
+exports.default = RequireSeeRule;
+//# sourceMappingURL=require-see.js.map

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

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

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

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

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

@@ -0,0 +1,30 @@
+import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
+const RequireSeeRule = createTagRule({
+    create(context) {
+        return createRequireTagRuleListener(context, "@see");
+    },
+    defaultOptions: defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @see 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-see.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @see.",
+        },
+        schema: [optionSchema],
+        type: "problem",
+    },
+    name: "require-see",
+});
+export default RequireSeeRule;
+//# sourceMappingURL=require-see.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"require-see.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-see.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,cAAc,GAAkB,aAAa,CAGjD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACzD,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,mFAAmF;YACvF,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,+GAA+G;SACvH;QACD,QAAQ,EAAE;YACN,UAAU,EACN,4DAA4D;SACnE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,aAAa;CACtB,CAAC,CAAC;AAEH,eAAe,cAAc,CAAC"}

package/dist/rules/required-tags/require-throws.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 RequireThrowsRule = (0, require_tag_factory_js_1.createTagRule)({
+    create(context) {
+        return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@throws");
+    },
+    defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @throws 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-throws.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @throws.",
+        },
+        schema: [require_tag_factory_js_1.optionSchema],
+        type: "problem",
+    },
+    name: "require-throws",
+});
+exports.default = RequireThrowsRule;
+//# sourceMappingURL=require-throws.js.map

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

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

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

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

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

@@ -0,0 +1,30 @@
+import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
+const RequireThrowsRule = createTagRule({
+    create(context) {
+        return createRequireTagRuleListener(context, "@throws");
+    },
+    defaultOptions: defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @throws 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-throws.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @throws.",
+        },
+        schema: [optionSchema],
+        type: "problem",
+    },
+    name: "require-throws",
+});
+export default RequireThrowsRule;
+//# sourceMappingURL=require-throws.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"require-throws.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-throws.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,iBAAiB,GAAkB,aAAa,CAGpD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAC5D,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,sFAAsF;YAC1F,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,kHAAkH;SAC1H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,+DAA+D;SACtE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,gBAAgB;CACzB,CAAC,CAAC;AAEH,eAAe,iBAAiB,CAAC"}

package/dist/rules/required-tags/require-type-param.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 RequireTypeParamRule = (0, require_tag_factory_js_1.createTagRule)({
+    create(context) {
+        return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@typeParam");
+    },
+    defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @typeParam 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-type-param.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @typeParam.",
+        },
+        schema: [require_tag_factory_js_1.optionSchema],
+        type: "problem",
+    },
+    name: "require-type-param",
+});
+exports.default = RequireTypeParamRule;
+//# sourceMappingURL=require-type-param.js.map

package/dist/rules/required-tags/require-type-param.d.ts

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

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

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

package/dist/rules/required-tags/require-type-param.js

@@ -0,0 +1,30 @@
+import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
+const RequireTypeParamRule = createTagRule({
+    create(context) {
+        return createRequireTagRuleListener(context, "@typeParam");
+    },
+    defaultOptions: defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @typeParam 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-type-param.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @typeParam.",
+        },
+        schema: [optionSchema],
+        type: "problem",
+    },
+    name: "require-type-param",
+});
+export default RequireTypeParamRule;
+//# sourceMappingURL=require-type-param.js.map

package/dist/rules/required-tags/require-type-param.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"require-type-param.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-type-param.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,oBAAoB,GAAkB,aAAa,CAGvD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC/D,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,yFAAyF;YAC7F,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,sHAAsH;SAC9H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,kEAAkE;SACzE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,oBAAoB;CAC7B,CAAC,CAAC;AAEH,eAAe,oBAAoB,CAAC"}

package/dist/rules/required-tags/require-virtual.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 RequireVirtualRule = (0, require_tag_factory_js_1.createTagRule)({
+    create(context) {
+        return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@virtual");
+    },
+    defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @virtual 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-virtual.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @virtual.",
+        },
+        schema: [require_tag_factory_js_1.optionSchema],
+        type: "problem",
+    },
+    name: "require-virtual",
+});
+exports.default = RequireVirtualRule;
+//# sourceMappingURL=require-virtual.js.map

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

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

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

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

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

@@ -0,0 +1,30 @@
+import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
+const RequireVirtualRule = createTagRule({
+    create(context) {
+        return createRequireTagRuleListener(context, "@virtual");
+    },
+    defaultOptions: defaultRuleOptions,
+    meta: {
+        defaultOptions: [
+            {
+                enforceFor: [...enforceableEntityKinds],
+                includeNonExported: false,
+            },
+        ],
+        deprecated: false,
+        docs: {
+            description: "require @virtual 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-virtual.md",
+        },
+        messages: {
+            missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @virtual.",
+        },
+        schema: [optionSchema],
+        type: "problem",
+    },
+    name: "require-virtual",
+});
+export default RequireVirtualRule;
+//# sourceMappingURL=require-virtual.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"require-virtual.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-virtual.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,kBAAkB,GAAkB,aAAa,CAGrD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC7D,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,uFAAuF;YAC3F,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,mHAAmH;SAC3H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,gEAAgE;SACvE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,iBAAiB;CAC1B,CAAC,CAAC;AAEH,eAAe,kBAAkB,CAAC"}

package/docs/rules/require.md

@@ -1,10 +1,10 @@
 # tsdoc-require-2/require
 
-Requires TSDoc comments for exported TypeScript declarations and default exports.
+Requires TSDoc comments for exported TypeScript declarations and default exports, with optional enforcement for non-exported top-level declarations.
 
 ## Rule Details
 
-This rule reports exported declarations that do not have a TSDoc block comment (`/** ... */`) directly above them.
+By default, this rule reports exported declarations that do not have a TSDoc block comment (`/** ... */`) directly above them.
 
 It checks:
 
@@ -16,6 +16,8 @@ It checks:
 - exported variables
 - default exports (including default-exported identifiers)
 
+When `includeNonExported: true` is enabled, the same checks also apply to non-exported top-level declarations.
+
 Why this matters: if exported APIs are undocumented, consumers have to inspect implementation details instead of reading a stable contract.
 
 ### ❌ Incorrect
@@ -67,6 +69,7 @@ type Options = [
 			"type" |
 			"variable"
 		>;
+		includeNonExported?: boolean;
 	},
 ];
 ```
@@ -74,12 +77,17 @@ type Options = [
 Default options:
 
 ```ts
-[{ enforceFor: ["class", "enum", "function", "interface", "object", "type", "variable"] }]
+[
+	{
+		enforceFor: ["class", "enum", "function", "interface", "object", "type", "variable"],
+		includeNonExported: false,
+	},
+]
 ```
 
 ### `enforceFor`
 
-Limits which exported entity kinds are checked.
+Limits which entity kinds are checked.
 
 Example flat config that only enforces docs for classes and functions:
 
@@ -103,9 +111,35 @@ export default [
 ];
 ```
 
+### `includeNonExported`
+
+When `true`, this rule also enforces TSDoc on supported non-exported top-level declarations.
+
+Example flat config:
+
+```ts
+import tsdocRequire from "eslint-plugin-tsdoc-require-2";
+
+export default [
+	{
+		plugins: {
+			"tsdoc-require-2": tsdocRequire,
+		},
+		rules: {
+			"tsdoc-require-2/require": [
+				"error",
+				{
+					includeNonExported: true,
+				},
+			],
+		},
+	},
+];
+```
+
 ## When Not To Use It
 
-Disable this rule if your project intentionally does not require API documentation on exported declarations.
+Disable this rule if your project intentionally does not require API documentation on exported declarations (or internal declarations when `includeNonExported` is enabled).
 
 ## Further Reading