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

package/dist/plugin.cjs

@@ -1,11 +1,16 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.rules = void 0;
 const require_tag_rules_js_1 = require("./rules/require-tag-rules.cjs");
-const require_js_1 = require("./rules/require.cjs");
+const require_js_1 = __importDefault(require("./rules/require.cjs"));
+const restrict_tags_js_1 = __importDefault(require("./rules/restrict-tags.cjs"));
 /** Map of all exported rule modules. */
 const rules = {
     require: require_js_1.default,
+    "restrict-tags": restrict_tags_js_1.default,
     ...require_tag_rules_js_1.requiredTagRules,
 };
 exports.rules = rules;
@@ -19,34 +24,158 @@ const plugin = {
     },
     rules: pluginRules,
 };
-const presetRuleNames = {
-    all: ["require", ...require_tag_rules_js_1.requiredTagDefinitions.map(({ ruleName }) => ruleName)],
-    detailed: ["require", "require-remarks"],
+const createPresetRuleEntry = (ruleName, value = "error") => ({
+    ruleName,
+    value,
+});
+const typedocCompatibilityBlockTags = [
+    "@augments",
+    "@callback",
+    "@extends",
+    "@jsx",
+    "@satisfies",
+    "@type",
+    "@typedef",
+    "@yields",
+];
+const presetRuleEntries = {
+    all: [
+        createPresetRuleEntry("require"),
+        createPresetRuleEntry("restrict-tags"),
+        ...require_tag_rules_js_1.requiredTagDefinitions.map(({ ruleName }) => createPresetRuleEntry(ruleName)),
+    ],
+    detailed: [
+        createPresetRuleEntry("require"),
+        createPresetRuleEntry("require-remarks"),
+    ],
+    jsdoc: [
+        createPresetRuleEntry("require"),
+        createPresetRuleEntry("require-param", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+        createPresetRuleEntry("require-returns", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+        createPresetRuleEntry("require-throws", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+    ],
     packages: [
-        "require",
-        "require-remarks",
-        "require-package-documentation",
+        createPresetRuleEntry("require"),
+        createPresetRuleEntry("require-remarks"),
+        createPresetRuleEntry("require-package-documentation"),
+    ],
+    recommended: [createPresetRuleEntry("require")],
+    tsdoc: [
+        createPresetRuleEntry("require"),
+        createPresetRuleEntry("require-remarks"),
+        createPresetRuleEntry("require-param", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+        createPresetRuleEntry("require-returns", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+        createPresetRuleEntry("require-throws", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+        createPresetRuleEntry("require-type-param", [
+            "error",
+            {
+                enforceFor: [
+                    "class",
+                    "function",
+                    "interface",
+                    "type",
+                ],
+            },
+        ]),
+        createPresetRuleEntry("restrict-tags", [
+            "error",
+            {
+                mode: "deny",
+                tags: [...typedocCompatibilityBlockTags],
+            },
+        ]),
+    ],
+    typedoc: [
+        createPresetRuleEntry("require"),
+        createPresetRuleEntry("require-class", [
+            "error",
+            { enforceFor: ["class"] },
+        ]),
+        createPresetRuleEntry("require-enum", [
+            "error",
+            { enforceFor: ["enum"] },
+        ]),
+        createPresetRuleEntry("require-function", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+        createPresetRuleEntry("require-interface", [
+            "error",
+            { enforceFor: ["interface"] },
+        ]),
+    ],
+    "typedoc-strict": [
+        createPresetRuleEntry("require"),
+        createPresetRuleEntry("require-class", [
+            "error",
+            { enforceFor: ["class"] },
+        ]),
+        createPresetRuleEntry("require-enum", [
+            "error",
+            { enforceFor: ["enum"] },
+        ]),
+        createPresetRuleEntry("require-function", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+        createPresetRuleEntry("require-interface", [
+            "error",
+            { enforceFor: ["interface"] },
+        ]),
+        createPresetRuleEntry("require-module", [
+            "error",
+            { enforceFor: ["namespace"] },
+        ]),
+        createPresetRuleEntry("require-remarks"),
+        createPresetRuleEntry("restrict-tags", [
+            "error",
+            {
+                mode: "deny",
+                tags: [...typedocCompatibilityBlockTags],
+            },
+        ]),
     ],
-    recommended: ["require"],
 };
-const createPresetRules = (ruleNames) => {
+const createPresetRules = (ruleEntries) => {
     const presetRules = {};
-    for (const ruleName of ruleNames) {
-        presetRules[`tsdoc-require-2/${ruleName}`] = "error";
+    for (const { ruleName, value } of ruleEntries) {
+        presetRules[`tsdoc-require-2/${ruleName}`] = value ?? "error";
     }
     return presetRules;
 };
-const createPresetConfig = (ruleNames) => ({
+const createPresetConfig = (ruleEntries) => ({
     plugins: {
         "tsdoc-require-2": plugin,
     },
-    rules: createPresetRules(ruleNames),
+    rules: createPresetRules(ruleEntries),
 });
 plugin.configs = {
-    all: createPresetConfig(presetRuleNames.all),
-    detailed: createPresetConfig(presetRuleNames.detailed),
-    packages: createPresetConfig(presetRuleNames.packages),
-    recommended: createPresetConfig(presetRuleNames.recommended),
+    all: createPresetConfig(presetRuleEntries.all),
+    detailed: createPresetConfig(presetRuleEntries.detailed),
+    jsdoc: createPresetConfig(presetRuleEntries.jsdoc),
+    packages: createPresetConfig(presetRuleEntries.packages),
+    recommended: createPresetConfig(presetRuleEntries.recommended),
+    tsdoc: createPresetConfig(presetRuleEntries.tsdoc),
+    typedoc: createPresetConfig(presetRuleEntries.typedoc),
+    "typedoc-strict": createPresetConfig(presetRuleEntries["typedoc-strict"]),
 };
 exports.default = plugin;
 //# sourceMappingURL=plugin.js.map

package/dist/plugin.d.ts

@@ -1,8 +1,10 @@
 import type { ESLint } from "eslint";
 import { requiredTagRules } from "./rules/require-tag-rules.js";
 import requireRule from "./rules/require.js";
+import restrictTagsRule from "./rules/restrict-tags.js";
 type RuleModuleMap = typeof requiredTagRules & {
     require: typeof requireRule;
+    "restrict-tags": typeof restrictTagsRule;
 };
 /** Map of all exported rule modules. */
 declare const rules: RuleModuleMap;

package/dist/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AAE7C,OAAO,EAEH,gBAAgB,EACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,WAAW,MAAM,oBAAoB,CAAC;AAO7C,KAAK,aAAa,GAAG,OAAO,gBAAgB,GAAG;IAC3C,OAAO,EAAE,OAAO,WAAW,CAAC;CAC/B,CAAC;AAEF,wCAAwC;AACxC,QAAA,MAAM,KAAK,EAAE,aAGZ,CAAC;AAIF,wCAAwC;AACxC,QAAA,MAAM,MAAM,EAAE,MAAM,CAAC,MAOpB,CAAC;AAuCF,OAAO,EAAE,KAAK,EAAE,CAAC;AACjB,eAAe,MAAM,CAAC"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AAE7C,OAAO,EAEH,gBAAgB,EACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,WAAW,MAAM,oBAAoB,CAAC;AAC7C,OAAO,gBAAgB,MAAM,0BAA0B,CAAC;AAYxD,KAAK,aAAa,GAAG,OAAO,gBAAgB,GAAG;IAC3C,OAAO,EAAE,OAAO,WAAW,CAAC;IAC5B,eAAe,EAAE,OAAO,gBAAgB,CAAC;CAC5C,CAAC;AAEF,wCAAwC;AACxC,QAAA,MAAM,KAAK,EAAE,aAIZ,CAAC;AAIF,wCAAwC;AACxC,QAAA,MAAM,MAAM,EAAE,MAAM,CAAC,MAOpB,CAAC;AA4KF,OAAO,EAAE,KAAK,EAAE,CAAC;AACjB,eAAe,MAAM,CAAC"}

package/dist/plugin.js

@@ -1,8 +1,10 @@
 import { requiredTagDefinitions, requiredTagRules, } from "./rules/require-tag-rules.js";
 import requireRule from "./rules/require.js";
+import restrictTagsRule from "./rules/restrict-tags.js";
 /** Map of all exported rule modules. */
 const rules = {
     require: requireRule,
+    "restrict-tags": restrictTagsRule,
     ...requiredTagRules,
 };
 const pluginRules = rules;
@@ -15,34 +17,158 @@ const plugin = {
     },
     rules: pluginRules,
 };
-const presetRuleNames = {
-    all: ["require", ...requiredTagDefinitions.map(({ ruleName }) => ruleName)],
-    detailed: ["require", "require-remarks"],
+const createPresetRuleEntry = (ruleName, value = "error") => ({
+    ruleName,
+    value,
+});
+const typedocCompatibilityBlockTags = [
+    "@augments",
+    "@callback",
+    "@extends",
+    "@jsx",
+    "@satisfies",
+    "@type",
+    "@typedef",
+    "@yields",
+];
+const presetRuleEntries = {
+    all: [
+        createPresetRuleEntry("require"),
+        createPresetRuleEntry("restrict-tags"),
+        ...requiredTagDefinitions.map(({ ruleName }) => createPresetRuleEntry(ruleName)),
+    ],
+    detailed: [
+        createPresetRuleEntry("require"),
+        createPresetRuleEntry("require-remarks"),
+    ],
+    jsdoc: [
+        createPresetRuleEntry("require"),
+        createPresetRuleEntry("require-param", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+        createPresetRuleEntry("require-returns", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+        createPresetRuleEntry("require-throws", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+    ],
     packages: [
-        "require",
-        "require-remarks",
-        "require-package-documentation",
+        createPresetRuleEntry("require"),
+        createPresetRuleEntry("require-remarks"),
+        createPresetRuleEntry("require-package-documentation"),
+    ],
+    recommended: [createPresetRuleEntry("require")],
+    tsdoc: [
+        createPresetRuleEntry("require"),
+        createPresetRuleEntry("require-remarks"),
+        createPresetRuleEntry("require-param", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+        createPresetRuleEntry("require-returns", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+        createPresetRuleEntry("require-throws", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+        createPresetRuleEntry("require-type-param", [
+            "error",
+            {
+                enforceFor: [
+                    "class",
+                    "function",
+                    "interface",
+                    "type",
+                ],
+            },
+        ]),
+        createPresetRuleEntry("restrict-tags", [
+            "error",
+            {
+                mode: "deny",
+                tags: [...typedocCompatibilityBlockTags],
+            },
+        ]),
+    ],
+    typedoc: [
+        createPresetRuleEntry("require"),
+        createPresetRuleEntry("require-class", [
+            "error",
+            { enforceFor: ["class"] },
+        ]),
+        createPresetRuleEntry("require-enum", [
+            "error",
+            { enforceFor: ["enum"] },
+        ]),
+        createPresetRuleEntry("require-function", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+        createPresetRuleEntry("require-interface", [
+            "error",
+            { enforceFor: ["interface"] },
+        ]),
+    ],
+    "typedoc-strict": [
+        createPresetRuleEntry("require"),
+        createPresetRuleEntry("require-class", [
+            "error",
+            { enforceFor: ["class"] },
+        ]),
+        createPresetRuleEntry("require-enum", [
+            "error",
+            { enforceFor: ["enum"] },
+        ]),
+        createPresetRuleEntry("require-function", [
+            "error",
+            { enforceFor: ["function"] },
+        ]),
+        createPresetRuleEntry("require-interface", [
+            "error",
+            { enforceFor: ["interface"] },
+        ]),
+        createPresetRuleEntry("require-module", [
+            "error",
+            { enforceFor: ["namespace"] },
+        ]),
+        createPresetRuleEntry("require-remarks"),
+        createPresetRuleEntry("restrict-tags", [
+            "error",
+            {
+                mode: "deny",
+                tags: [...typedocCompatibilityBlockTags],
+            },
+        ]),
     ],
-    recommended: ["require"],
 };
-const createPresetRules = (ruleNames) => {
+const createPresetRules = (ruleEntries) => {
     const presetRules = {};
-    for (const ruleName of ruleNames) {
-        presetRules[`tsdoc-require-2/${ruleName}`] = "error";
+    for (const { ruleName, value } of ruleEntries) {
+        presetRules[`tsdoc-require-2/${ruleName}`] = value ?? "error";
     }
     return presetRules;
 };
-const createPresetConfig = (ruleNames) => ({
+const createPresetConfig = (ruleEntries) => ({
     plugins: {
         "tsdoc-require-2": plugin,
     },
-    rules: createPresetRules(ruleNames),
+    rules: createPresetRules(ruleEntries),
 });
 plugin.configs = {
-    all: createPresetConfig(presetRuleNames.all),
-    detailed: createPresetConfig(presetRuleNames.detailed),
-    packages: createPresetConfig(presetRuleNames.packages),
-    recommended: createPresetConfig(presetRuleNames.recommended),
+    all: createPresetConfig(presetRuleEntries.all),
+    detailed: createPresetConfig(presetRuleEntries.detailed),
+    jsdoc: createPresetConfig(presetRuleEntries.jsdoc),
+    packages: createPresetConfig(presetRuleEntries.packages),
+    recommended: createPresetConfig(presetRuleEntries.recommended),
+    tsdoc: createPresetConfig(presetRuleEntries.tsdoc),
+    typedoc: createPresetConfig(presetRuleEntries.typedoc),
+    "typedoc-strict": createPresetConfig(presetRuleEntries["typedoc-strict"]),
 };
 export { rules };
 export default plugin;

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,sBAAsB,EACtB,gBAAgB,GACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,WAAW,MAAM,oBAAoB,CAAC;AAW7C,wCAAwC;AACxC,MAAM,KAAK,GAAkB;IACzB,OAAO,EAAE,WAAW;IACpB,GAAG,gBAAgB;CACtB,CAAC;AAEF,MAAM,WAAW,GAAG,KAAuD,CAAC;AAE5E,wCAAwC;AACxC,MAAM,MAAM,GAAkB;IAC1B,OAAO,EAAE,EAAE;IACX,IAAI,EAAE;QACF,IAAI,EAAE,+BAA+B;QACrC,OAAO,EAAE,OAAO;KACnB;IACD,KAAK,EAAE,WAAW;CACrB,CAAC;AAEF,MAAM,eAAe,GAAG;IACpB,GAAG,EAAE,CAAC,SAAS,EAAE,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC3E,QAAQ,EAAE,CAAC,SAAS,EAAE,iBAAiB,CAAC;IACxC,QAAQ,EAAE;QACN,SAAS;QACT,iBAAiB;QACjB,+BAA+B;KAClC;IACD,WAAW,EAAE,CAAC,SAAS,CAAC;CAClB,CAAC;AAEX,MAAM,iBAAiB,GAAG,CACtB,SAA4B,EACI,EAAE;IAClC,MAAM,WAAW,GAAqC,EAAE,CAAC;IAEzD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QAC/B,WAAW,CAAC,mBAAmB,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC;IACzD,CAAC;IAED,OAAO,WAAW,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,SAA4B,EAAc,EAAE,CAAC,CAAC;IACtE,OAAO,EAAE;QACL,iBAAiB,EAAE,MAAM;KAC5B;IACD,KAAK,EAAE,iBAAiB,CAAC,SAAS,CAAC;CACtC,CAAC,CAAC;AAEH,MAAM,CAAC,OAAO,GAAG;IACb,GAAG,EAAE,kBAAkB,CAAC,eAAe,CAAC,GAAG,CAAC;IAC5C,QAAQ,EAAE,kBAAkB,CAAC,eAAe,CAAC,QAAQ,CAAC;IACtD,QAAQ,EAAE,kBAAkB,CAAC,eAAe,CAAC,QAAQ,CAAC;IACtD,WAAW,EAAE,kBAAkB,CAAC,eAAe,CAAC,WAAW,CAAC;CAC/D,CAAC;AAEF,OAAO,EAAE,KAAK,EAAE,CAAC;AACjB,eAAe,MAAM,CAAC"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,sBAAsB,EACtB,gBAAgB,GACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,WAAW,MAAM,oBAAoB,CAAC;AAC7C,OAAO,gBAAgB,MAAM,0BAA0B,CAAC;AAiBxD,wCAAwC;AACxC,MAAM,KAAK,GAAkB;IACzB,OAAO,EAAE,WAAW;IACpB,eAAe,EAAE,gBAAgB;IACjC,GAAG,gBAAgB;CACtB,CAAC;AAEF,MAAM,WAAW,GAAG,KAAuD,CAAC;AAE5E,wCAAwC;AACxC,MAAM,MAAM,GAAkB;IAC1B,OAAO,EAAE,EAAE;IACX,IAAI,EAAE;QACF,IAAI,EAAE,+BAA+B;QACrC,OAAO,EAAE,OAAO;KACnB;IACD,KAAK,EAAE,WAAW;CACrB,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAC1B,QAA6B,EAC7B,QAAkD,OAAO,EAC1C,EAAE,CAAC,CAAC;IACnB,QAAQ;IACR,KAAK;CACR,CAAC,CAAC;AAEH,MAAM,6BAA6B,GAAG;IAClC,WAAW;IACX,WAAW;IACX,UAAU;IACV,MAAM;IACN,YAAY;IACZ,OAAO;IACP,UAAU;IACV,SAAS;CACH,CAAC;AAEX,MAAM,iBAAiB,GAAG;IACtB,GAAG,EAAE;QACD,qBAAqB,CAAC,SAAS,CAAC;QAChC,qBAAqB,CAAC,eAAe,CAAC;QACtC,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAC3C,qBAAqB,CAAC,QAA+B,CAAC,CACzD;KACJ;IACD,QAAQ,EAAE;QACN,qBAAqB,CAAC,SAAS,CAAC;QAChC,qBAAqB,CAAC,iBAAiB,CAAC;KAC3C;IACD,KAAK,EAAE;QACH,qBAAqB,CAAC,SAAS,CAAC;QAChC,qBAAqB,CAAC,eAAe,EAAE;YACnC,OAAO;YACP,EAAE,UAAU,EAAE,CAAC,UAAU,CAAC,EAAE;SAC/B,CAAC;QACF,qBAAqB,CAAC,iBAAiB,EAAE;YACrC,OAAO;YACP,EAAE,UAAU,EAAE,CAAC,UAAU,CAAC,EAAE;SAC/B,CAAC;QACF,qBAAqB,CAAC,gBAAgB,EAAE;YACpC,OAAO;YACP,EAAE,UAAU,EAAE,CAAC,UAAU,CAAC,EAAE;SAC/B,CAAC;KACL;IACD,QAAQ,EAAE;QACN,qBAAqB,CAAC,SAAS,CAAC;QAChC,qBAAqB,CAAC,iBAAiB,CAAC;QACxC,qBAAqB,CAAC,+BAA+B,CAAC;KACzD;IACD,WAAW,EAAE,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAC/C,KAAK,EAAE;QACH,qBAAqB,CAAC,SAAS,CAAC;QAChC,qBAAqB,CAAC,iBAAiB,CAAC;QACxC,qBAAqB,CAAC,eAAe,EAAE;YACnC,OAAO;YACP,EAAE,UAAU,EAAE,CAAC,UAAU,CAAC,EAAE;SAC/B,CAAC;QACF,qBAAqB,CAAC,iBAAiB,EAAE;YACrC,OAAO;YACP,EAAE,UAAU,EAAE,CAAC,UAAU,CAAC,EAAE;SAC/B,CAAC;QACF,qBAAqB,CAAC,gBAAgB,EAAE;YACpC,OAAO;YACP,EAAE,UAAU,EAAE,CAAC,UAAU,CAAC,EAAE;SAC/B,CAAC;QACF,qBAAqB,CAAC,oBAAoB,EAAE;YACxC,OAAO;YACP;gBACI,UAAU,EAAE;oBACR,OAAO;oBACP,UAAU;oBACV,WAAW;oBACX,MAAM;iBACT;aACJ;SACJ,CAAC;QACF,qBAAqB,CAAC,eAAe,EAAE;YACnC,OAAO;YACP;gBACI,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,CAAC,GAAG,6BAA6B,CAAC;aAC3C;SACJ,CAAC;KACL;IACD,OAAO,EAAE;QACL,qBAAqB,CAAC,SAAS,CAAC;QAChC,qBAAqB,CAAC,eAAe,EAAE;YACnC,OAAO;YACP,EAAE,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE;SAC5B,CAAC;QACF,qBAAqB,CAAC,cAAc,EAAE;YAClC,OAAO;YACP,EAAE,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE;SAC3B,CAAC;QACF,qBAAqB,CAAC,kBAAkB,EAAE;YACtC,OAAO;YACP,EAAE,UAAU,EAAE,CAAC,UAAU,CAAC,EAAE;SAC/B,CAAC;QACF,qBAAqB,CAAC,mBAAmB,EAAE;YACvC,OAAO;YACP,EAAE,UAAU,EAAE,CAAC,WAAW,CAAC,EAAE;SAChC,CAAC;KACL;IACD,gBAAgB,EAAE;QACd,qBAAqB,CAAC,SAAS,CAAC;QAChC,qBAAqB,CAAC,eAAe,EAAE;YACnC,OAAO;YACP,EAAE,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE;SAC5B,CAAC;QACF,qBAAqB,CAAC,cAAc,EAAE;YAClC,OAAO;YACP,EAAE,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE;SAC3B,CAAC;QACF,qBAAqB,CAAC,kBAAkB,EAAE;YACtC,OAAO;YACP,EAAE,UAAU,EAAE,CAAC,UAAU,CAAC,EAAE;SAC/B,CAAC;QACF,qBAAqB,CAAC,mBAAmB,EAAE;YACvC,OAAO;YACP,EAAE,UAAU,EAAE,CAAC,WAAW,CAAC,EAAE;SAChC,CAAC;QACF,qBAAqB,CAAC,gBAAgB,EAAE;YACpC,OAAO;YACP,EAAE,UAAU,EAAE,CAAC,WAAW,CAAC,EAAE;SAChC,CAAC;QACF,qBAAqB,CAAC,iBAAiB,CAAC;QACxC,qBAAqB,CAAC,eAAe,EAAE;YACnC,OAAO;YACP;gBACI,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,CAAC,GAAG,6BAA6B,CAAC;aAC3C;SACJ,CAAC;KACL;CACK,CAAC;AAEX,MAAM,iBAAiB,GAAG,CACtB,WAAiD,EACjB,EAAE;IAClC,MAAM,WAAW,GAAqC,EAAE,CAAC;IAEzD,KAAK,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,WAAW,EAAE,CAAC;QAC5C,WAAW,CAAC,mBAAmB,QAAQ,EAAE,CAAC,GAAG,KAAK,IAAI,OAAO,CAAC;IAClE,CAAC;IAED,OAAO,WAAW,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CACvB,WAAiD,EACvC,EAAE,CAAC,CAAC;IACd,OAAO,EAAE;QACL,iBAAiB,EAAE,MAAM;KAC5B;IACD,KAAK,EAAE,iBAAiB,CAAC,WAAW,CAAC;CACxC,CAAC,CAAC;AAEH,MAAM,CAAC,OAAO,GAAG;IACb,GAAG,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,GAAG,CAAC;IAC9C,QAAQ,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,QAAQ,CAAC;IACxD,KAAK,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,KAAK,CAAC;IAClD,QAAQ,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,QAAQ,CAAC;IACxD,WAAW,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,WAAW,CAAC;IAC9D,KAAK,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,KAAK,CAAC;IAClD,OAAO,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,OAAO,CAAC;IACtD,gBAAgB,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;CAC5E,CAAC;AAEF,OAAO,EAAE,KAAK,EAAE,CAAC;AACjB,eAAe,MAAM,CAAC"}

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

@@ -1,89 +1,185 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.requiredTagRules = exports.requiredTagDefinitions = void 0;
-const require_alpha_js_1 = require("./required-tags/require-alpha.cjs");
-const require_beta_js_1 = require("./required-tags/require-beta.cjs");
-const require_decorator_js_1 = require("./required-tags/require-decorator.cjs");
-const require_default_value_js_1 = require("./required-tags/require-default-value.cjs");
-const require_deprecated_js_1 = require("./required-tags/require-deprecated.cjs");
-const require_event_property_js_1 = require("./required-tags/require-event-property.cjs");
-const require_example_js_1 = require("./required-tags/require-example.cjs");
-const require_experimental_js_1 = require("./required-tags/require-experimental.cjs");
-const require_inherit_doc_js_1 = require("./required-tags/require-inherit-doc.cjs");
-const require_internal_js_1 = require("./required-tags/require-internal.cjs");
-const require_label_js_1 = require("./required-tags/require-label.cjs");
-const require_link_js_1 = require("./required-tags/require-link.cjs");
-const require_override_js_1 = require("./required-tags/require-override.cjs");
-const require_package_documentation_js_1 = require("./required-tags/require-package-documentation.cjs");
-const require_param_js_1 = require("./required-tags/require-param.cjs");
-const require_private_remarks_js_1 = require("./required-tags/require-private-remarks.cjs");
-const require_public_js_1 = require("./required-tags/require-public.cjs");
-const require_readonly_js_1 = require("./required-tags/require-readonly.cjs");
-const require_remarks_js_1 = require("./required-tags/require-remarks.cjs");
-const require_returns_js_1 = require("./required-tags/require-returns.cjs");
-const require_sealed_js_1 = require("./required-tags/require-sealed.cjs");
-const require_see_js_1 = require("./required-tags/require-see.cjs");
-const require_throws_js_1 = require("./required-tags/require-throws.cjs");
-const require_type_param_js_1 = require("./required-tags/require-type-param.cjs");
-const require_virtual_js_1 = require("./required-tags/require-virtual.cjs");
+const require_abstract_js_1 = __importDefault(require("./required-tags/require-abstract.cjs"));
+const require_alpha_js_1 = __importDefault(require("./required-tags/require-alpha.cjs"));
+const require_author_js_1 = __importDefault(require("./required-tags/require-author.cjs"));
+const require_beta_js_1 = __importDefault(require("./required-tags/require-beta.cjs"));
+const require_category_js_1 = __importDefault(require("./required-tags/require-category.cjs"));
+const require_class_js_1 = __importDefault(require("./required-tags/require-class.cjs"));
+const require_decorator_js_1 = __importDefault(require("./required-tags/require-decorator.cjs"));
+const require_default_value_js_1 = __importDefault(require("./required-tags/require-default-value.cjs"));
+const require_deprecated_js_1 = __importDefault(require("./required-tags/require-deprecated.cjs"));
+const require_document_js_1 = __importDefault(require("./required-tags/require-document.cjs"));
+const require_enum_js_1 = __importDefault(require("./required-tags/require-enum.cjs"));
+const require_event_property_js_1 = __importDefault(require("./required-tags/require-event-property.cjs"));
+const require_event_js_1 = __importDefault(require("./required-tags/require-event.cjs"));
+const require_example_js_1 = __importDefault(require("./required-tags/require-example.cjs"));
+const require_expand_js_1 = __importDefault(require("./required-tags/require-expand.cjs"));
+const require_experimental_js_1 = __importDefault(require("./required-tags/require-experimental.cjs"));
+const require_function_js_1 = __importDefault(require("./required-tags/require-function.cjs"));
+const require_group_js_1 = __importDefault(require("./required-tags/require-group.cjs"));
+const require_hidden_js_1 = __importDefault(require("./required-tags/require-hidden.cjs"));
+const require_hideconstructor_js_1 = __importDefault(require("./required-tags/require-hideconstructor.cjs"));
+const require_ignore_js_1 = __importDefault(require("./required-tags/require-ignore.cjs"));
+const require_import_js_1 = __importDefault(require("./required-tags/require-import.cjs"));
+const require_include_js_1 = __importDefault(require("./required-tags/require-include.cjs"));
+const require_inherit_doc_js_1 = __importDefault(require("./required-tags/require-inherit-doc.cjs"));
+const require_inline_js_1 = __importDefault(require("./required-tags/require-inline.cjs"));
+const require_interface_js_1 = __importDefault(require("./required-tags/require-interface.cjs"));
+const require_internal_js_1 = __importDefault(require("./required-tags/require-internal.cjs"));
+const require_label_js_1 = __importDefault(require("./required-tags/require-label.cjs"));
+const require_license_js_1 = __importDefault(require("./required-tags/require-license.cjs"));
+const require_link_js_1 = __importDefault(require("./required-tags/require-link.cjs"));
+const require_merge_module_with_js_1 = __importDefault(require("./required-tags/require-merge-module-with.cjs"));
+const require_module_js_1 = __importDefault(require("./required-tags/require-module.cjs"));
+const require_namespace_js_1 = __importDefault(require("./required-tags/require-namespace.cjs"));
+const require_overload_js_1 = __importDefault(require("./required-tags/require-overload.cjs"));
+const require_override_js_1 = __importDefault(require("./required-tags/require-override.cjs"));
+const require_package_documentation_js_1 = __importDefault(require("./required-tags/require-package-documentation.cjs"));
+const require_param_js_1 = __importDefault(require("./required-tags/require-param.cjs"));
+const require_primary_export_js_1 = __importDefault(require("./required-tags/require-primary-export.cjs"));
+const require_private_remarks_js_1 = __importDefault(require("./required-tags/require-private-remarks.cjs"));
+const require_private_js_1 = __importDefault(require("./required-tags/require-private.cjs"));
+const require_property_js_1 = __importDefault(require("./required-tags/require-property.cjs"));
+const require_protected_js_1 = __importDefault(require("./required-tags/require-protected.cjs"));
+const require_public_js_1 = __importDefault(require("./required-tags/require-public.cjs"));
+const require_readonly_js_1 = __importDefault(require("./required-tags/require-readonly.cjs"));
+const require_remarks_js_1 = __importDefault(require("./required-tags/require-remarks.cjs"));
+const require_returns_js_1 = __importDefault(require("./required-tags/require-returns.cjs"));
+const require_sealed_js_1 = __importDefault(require("./required-tags/require-sealed.cjs"));
+const require_see_js_1 = __importDefault(require("./required-tags/require-see.cjs"));
+const require_since_js_1 = __importDefault(require("./required-tags/require-since.cjs"));
+const require_sort_strategy_js_1 = __importDefault(require("./required-tags/require-sort-strategy.cjs"));
+const require_summary_js_1 = __importDefault(require("./required-tags/require-summary.cjs"));
+const require_template_js_1 = __importDefault(require("./required-tags/require-template.cjs"));
+const require_throws_js_1 = __importDefault(require("./required-tags/require-throws.cjs"));
+const require_type_param_js_1 = __importDefault(require("./required-tags/require-type-param.cjs"));
+const require_use_declared_type_js_1 = __importDefault(require("./required-tags/require-use-declared-type.cjs"));
+const require_virtual_js_1 = __importDefault(require("./required-tags/require-virtual.cjs"));
 /** 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" },
 ];
 exports.requiredTagDefinitions = requiredTagDefinitions;
 /** Runtime map of required-tag rule modules keyed by rule name. */
 const requiredTagRules = {
+    "require-abstract": require_abstract_js_1.default,
     "require-alpha": require_alpha_js_1.default,
+    "require-author": require_author_js_1.default,
     "require-beta": require_beta_js_1.default,
+    "require-category": require_category_js_1.default,
+    "require-class": require_class_js_1.default,
     "require-decorator": require_decorator_js_1.default,
     "require-default-value": require_default_value_js_1.default,
     "require-deprecated": require_deprecated_js_1.default,
+    "require-document": require_document_js_1.default,
+    "require-enum": require_enum_js_1.default,
+    "require-event": require_event_js_1.default,
     "require-event-property": require_event_property_js_1.default,
     "require-example": require_example_js_1.default,
+    "require-expand": require_expand_js_1.default,
     "require-experimental": require_experimental_js_1.default,
+    "require-function": require_function_js_1.default,
+    "require-group": require_group_js_1.default,
+    "require-hidden": require_hidden_js_1.default,
+    "require-hideconstructor": require_hideconstructor_js_1.default,
+    "require-ignore": require_ignore_js_1.default,
+    "require-import": require_import_js_1.default,
+    "require-include": require_include_js_1.default,
     "require-inherit-doc": require_inherit_doc_js_1.default,
+    "require-inline": require_inline_js_1.default,
+    "require-interface": require_interface_js_1.default,
     "require-internal": require_internal_js_1.default,
     "require-label": require_label_js_1.default,
+    "require-license": require_license_js_1.default,
     "require-link": require_link_js_1.default,
+    "require-merge-module-with": require_merge_module_with_js_1.default,
+    "require-module": require_module_js_1.default,
+    "require-namespace": require_namespace_js_1.default,
+    "require-overload": require_overload_js_1.default,
     "require-override": require_override_js_1.default,
     "require-package-documentation": require_package_documentation_js_1.default,
     "require-param": require_param_js_1.default,
+    "require-primary-export": require_primary_export_js_1.default,
+    "require-private": require_private_js_1.default,
     "require-private-remarks": require_private_remarks_js_1.default,
+    "require-property": require_property_js_1.default,
+    "require-protected": require_protected_js_1.default,
     "require-public": require_public_js_1.default,
     "require-readonly": require_readonly_js_1.default,
     "require-remarks": require_remarks_js_1.default,
     "require-returns": require_returns_js_1.default,
     "require-sealed": require_sealed_js_1.default,
     "require-see": require_see_js_1.default,
+    "require-since": require_since_js_1.default,
+    "require-sort-strategy": require_sort_strategy_js_1.default,
+    "require-summary": require_summary_js_1.default,
+    "require-template": require_template_js_1.default,
     "require-throws": require_throws_js_1.default,
     "require-type-param": require_type_param_js_1.default,
+    "require-use-declared-type": require_use_declared_type_js_1.default,
     "require-virtual": require_virtual_js_1.default,
 };
 exports.requiredTagRules = requiredTagRules;