eslint-plugin-tsdoc-require-2 1.0.2 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +115 -73
- package/dist/internal/require-tag-factory.cjs +309 -0
- package/dist/internal/require-tag-factory.d.ts +26 -0
- package/dist/internal/require-tag-factory.d.ts.map +1 -0
- package/dist/internal/require-tag-factory.js +302 -0
- package/dist/internal/require-tag-factory.js.map +1 -0
- package/dist/plugin.cjs +33 -11
- package/dist/plugin.d.ts +2 -1
- package/dist/plugin.d.ts.map +1 -1
- package/dist/plugin.js +33 -11
- package/dist/plugin.js.map +1 -1
- package/dist/rules/require-tag-rules.cjs +88 -0
- package/dist/rules/require-tag-rules.d.ts +35 -0
- package/dist/rules/require-tag-rules.d.ts.map +1 -0
- package/dist/rules/require-tag-rules.js +85 -0
- package/dist/rules/require-tag-rules.js.map +1 -0
- package/dist/rules/require.cjs +16 -3
- package/dist/rules/require.d.ts +1 -0
- package/dist/rules/require.d.ts.map +1 -1
- package/dist/rules/require.js +16 -3
- package/dist/rules/require.js.map +1 -1
- package/dist/rules/required-tags/require-alpha.cjs +32 -0
- package/dist/rules/required-tags/require-alpha.d.ts +4 -0
- package/dist/rules/required-tags/require-alpha.d.ts.map +1 -0
- package/dist/rules/required-tags/require-alpha.js +30 -0
- package/dist/rules/required-tags/require-alpha.js.map +1 -0
- package/dist/rules/required-tags/require-beta.cjs +32 -0
- package/dist/rules/required-tags/require-beta.d.ts +4 -0
- package/dist/rules/required-tags/require-beta.d.ts.map +1 -0
- package/dist/rules/required-tags/require-beta.js +30 -0
- package/dist/rules/required-tags/require-beta.js.map +1 -0
- package/dist/rules/required-tags/require-decorator.cjs +32 -0
- package/dist/rules/required-tags/require-decorator.d.ts +4 -0
- package/dist/rules/required-tags/require-decorator.d.ts.map +1 -0
- package/dist/rules/required-tags/require-decorator.js +30 -0
- package/dist/rules/required-tags/require-decorator.js.map +1 -0
- package/dist/rules/required-tags/require-default-value.cjs +32 -0
- package/dist/rules/required-tags/require-default-value.d.ts +4 -0
- package/dist/rules/required-tags/require-default-value.d.ts.map +1 -0
- package/dist/rules/required-tags/require-default-value.js +30 -0
- package/dist/rules/required-tags/require-default-value.js.map +1 -0
- package/dist/rules/required-tags/require-deprecated.cjs +32 -0
- package/dist/rules/required-tags/require-deprecated.d.ts +4 -0
- package/dist/rules/required-tags/require-deprecated.d.ts.map +1 -0
- package/dist/rules/required-tags/require-deprecated.js +30 -0
- package/dist/rules/required-tags/require-deprecated.js.map +1 -0
- package/dist/rules/required-tags/require-event-property.cjs +32 -0
- package/dist/rules/required-tags/require-event-property.d.ts +4 -0
- package/dist/rules/required-tags/require-event-property.d.ts.map +1 -0
- package/dist/rules/required-tags/require-event-property.js +30 -0
- package/dist/rules/required-tags/require-event-property.js.map +1 -0
- package/dist/rules/required-tags/require-example.cjs +32 -0
- package/dist/rules/required-tags/require-example.d.ts +4 -0
- package/dist/rules/required-tags/require-example.d.ts.map +1 -0
- package/dist/rules/required-tags/require-example.js +30 -0
- package/dist/rules/required-tags/require-example.js.map +1 -0
- package/dist/rules/required-tags/require-experimental.cjs +32 -0
- package/dist/rules/required-tags/require-experimental.d.ts +4 -0
- package/dist/rules/required-tags/require-experimental.d.ts.map +1 -0
- package/dist/rules/required-tags/require-experimental.js +30 -0
- package/dist/rules/required-tags/require-experimental.js.map +1 -0
- package/dist/rules/required-tags/require-inherit-doc.cjs +32 -0
- package/dist/rules/required-tags/require-inherit-doc.d.ts +4 -0
- package/dist/rules/required-tags/require-inherit-doc.d.ts.map +1 -0
- package/dist/rules/required-tags/require-inherit-doc.js +30 -0
- package/dist/rules/required-tags/require-inherit-doc.js.map +1 -0
- package/dist/rules/required-tags/require-internal.cjs +32 -0
- package/dist/rules/required-tags/require-internal.d.ts +4 -0
- package/dist/rules/required-tags/require-internal.d.ts.map +1 -0
- package/dist/rules/required-tags/require-internal.js +30 -0
- package/dist/rules/required-tags/require-internal.js.map +1 -0
- package/dist/rules/required-tags/require-label.cjs +32 -0
- package/dist/rules/required-tags/require-label.d.ts +4 -0
- package/dist/rules/required-tags/require-label.d.ts.map +1 -0
- package/dist/rules/required-tags/require-label.js +30 -0
- package/dist/rules/required-tags/require-label.js.map +1 -0
- package/dist/rules/required-tags/require-link.cjs +32 -0
- package/dist/rules/required-tags/require-link.d.ts +4 -0
- package/dist/rules/required-tags/require-link.d.ts.map +1 -0
- package/dist/rules/required-tags/require-link.js +30 -0
- package/dist/rules/required-tags/require-link.js.map +1 -0
- package/dist/rules/required-tags/require-override.cjs +32 -0
- package/dist/rules/required-tags/require-override.d.ts +4 -0
- package/dist/rules/required-tags/require-override.d.ts.map +1 -0
- package/dist/rules/required-tags/require-override.js +30 -0
- package/dist/rules/required-tags/require-override.js.map +1 -0
- package/dist/rules/required-tags/require-package-documentation.cjs +32 -0
- package/dist/rules/required-tags/require-package-documentation.d.ts +4 -0
- package/dist/rules/required-tags/require-package-documentation.d.ts.map +1 -0
- package/dist/rules/required-tags/require-package-documentation.js +30 -0
- package/dist/rules/required-tags/require-package-documentation.js.map +1 -0
- package/dist/rules/required-tags/require-param.cjs +32 -0
- package/dist/rules/required-tags/require-param.d.ts +4 -0
- package/dist/rules/required-tags/require-param.d.ts.map +1 -0
- package/dist/rules/required-tags/require-param.js +30 -0
- package/dist/rules/required-tags/require-param.js.map +1 -0
- package/dist/rules/required-tags/require-private-remarks.cjs +32 -0
- package/dist/rules/required-tags/require-private-remarks.d.ts +4 -0
- package/dist/rules/required-tags/require-private-remarks.d.ts.map +1 -0
- package/dist/rules/required-tags/require-private-remarks.js +30 -0
- package/dist/rules/required-tags/require-private-remarks.js.map +1 -0
- package/dist/rules/required-tags/require-public.cjs +32 -0
- package/dist/rules/required-tags/require-public.d.ts +4 -0
- package/dist/rules/required-tags/require-public.d.ts.map +1 -0
- package/dist/rules/required-tags/require-public.js +30 -0
- package/dist/rules/required-tags/require-public.js.map +1 -0
- package/dist/rules/required-tags/require-readonly.cjs +32 -0
- package/dist/rules/required-tags/require-readonly.d.ts +4 -0
- package/dist/rules/required-tags/require-readonly.d.ts.map +1 -0
- package/dist/rules/required-tags/require-readonly.js +30 -0
- package/dist/rules/required-tags/require-readonly.js.map +1 -0
- package/dist/rules/required-tags/require-remarks.cjs +32 -0
- package/dist/rules/required-tags/require-remarks.d.ts +4 -0
- package/dist/rules/required-tags/require-remarks.d.ts.map +1 -0
- package/dist/rules/required-tags/require-remarks.js +30 -0
- package/dist/rules/required-tags/require-remarks.js.map +1 -0
- package/dist/rules/required-tags/require-returns.cjs +32 -0
- package/dist/rules/required-tags/require-returns.d.ts +4 -0
- package/dist/rules/required-tags/require-returns.d.ts.map +1 -0
- package/dist/rules/required-tags/require-returns.js +30 -0
- package/dist/rules/required-tags/require-returns.js.map +1 -0
- package/dist/rules/required-tags/require-sealed.cjs +32 -0
- package/dist/rules/required-tags/require-sealed.d.ts +4 -0
- package/dist/rules/required-tags/require-sealed.d.ts.map +1 -0
- package/dist/rules/required-tags/require-sealed.js +30 -0
- package/dist/rules/required-tags/require-sealed.js.map +1 -0
- package/dist/rules/required-tags/require-see.cjs +32 -0
- package/dist/rules/required-tags/require-see.d.ts +4 -0
- package/dist/rules/required-tags/require-see.d.ts.map +1 -0
- package/dist/rules/required-tags/require-see.js +30 -0
- package/dist/rules/required-tags/require-see.js.map +1 -0
- package/dist/rules/required-tags/require-throws.cjs +32 -0
- package/dist/rules/required-tags/require-throws.d.ts +4 -0
- package/dist/rules/required-tags/require-throws.d.ts.map +1 -0
- package/dist/rules/required-tags/require-throws.js +30 -0
- package/dist/rules/required-tags/require-throws.js.map +1 -0
- package/dist/rules/required-tags/require-type-param.cjs +32 -0
- package/dist/rules/required-tags/require-type-param.d.ts +4 -0
- package/dist/rules/required-tags/require-type-param.d.ts.map +1 -0
- package/dist/rules/required-tags/require-type-param.js +30 -0
- package/dist/rules/required-tags/require-type-param.js.map +1 -0
- package/dist/rules/required-tags/require-virtual.cjs +32 -0
- package/dist/rules/required-tags/require-virtual.d.ts +4 -0
- package/dist/rules/required-tags/require-virtual.d.ts.map +1 -0
- package/dist/rules/required-tags/require-virtual.js +30 -0
- package/dist/rules/required-tags/require-virtual.js.map +1 -0
- package/docs/rules/require.md +39 -5
- package/docs/rules/required-tags/require-alpha.md +57 -0
- package/docs/rules/required-tags/require-beta.md +57 -0
- package/docs/rules/required-tags/require-decorator.md +57 -0
- package/docs/rules/required-tags/require-default-value.md +57 -0
- package/docs/rules/required-tags/require-deprecated.md +57 -0
- package/docs/rules/required-tags/require-event-property.md +57 -0
- package/docs/rules/required-tags/require-example.md +57 -0
- package/docs/rules/required-tags/require-experimental.md +57 -0
- package/docs/rules/required-tags/require-inherit-doc.md +57 -0
- package/docs/rules/required-tags/require-internal.md +57 -0
- package/docs/rules/required-tags/require-label.md +57 -0
- package/docs/rules/required-tags/require-link.md +57 -0
- package/docs/rules/required-tags/require-override.md +57 -0
- package/docs/rules/required-tags/require-package-documentation.md +57 -0
- package/docs/rules/required-tags/require-param.md +57 -0
- package/docs/rules/required-tags/require-private-remarks.md +57 -0
- package/docs/rules/required-tags/require-public.md +57 -0
- package/docs/rules/required-tags/require-readonly.md +57 -0
- package/docs/rules/required-tags/require-remarks.md +57 -0
- package/docs/rules/required-tags/require-returns.md +57 -0
- package/docs/rules/required-tags/require-sealed.md +57 -0
- package/docs/rules/required-tags/require-see.md +57 -0
- package/docs/rules/required-tags/require-throws.md +57 -0
- package/docs/rules/required-tags/require-type-param.md +57 -0
- package/docs/rules/required-tags/require-virtual.md +57 -0
- package/docs/rules/required-tags.md +76 -0
- package/package.json +27 -13
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
const RequireDeprecatedRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@deprecated");
|
|
5
|
+
},
|
|
6
|
+
defaultOptions: defaultRuleOptions,
|
|
7
|
+
meta: {
|
|
8
|
+
defaultOptions: [
|
|
9
|
+
{
|
|
10
|
+
enforceFor: [...enforceableEntityKinds],
|
|
11
|
+
includeNonExported: false,
|
|
12
|
+
},
|
|
13
|
+
],
|
|
14
|
+
deprecated: false,
|
|
15
|
+
docs: {
|
|
16
|
+
description: "require @deprecated tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
17
|
+
frozen: false,
|
|
18
|
+
recommended: false,
|
|
19
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-deprecated.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @deprecated.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-deprecated",
|
|
28
|
+
});
|
|
29
|
+
export default RequireDeprecatedRule;
|
|
30
|
+
//# sourceMappingURL=require-deprecated.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-deprecated.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-deprecated.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,qBAAqB,GAAkB,aAAa,CAGxD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAChE,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,0FAA0F;YAC9F,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,sHAAsH;SAC9H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,mEAAmE;SAC1E;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,oBAAoB;CAC7B,CAAC,CAAC;AAEH,eAAe,qBAAqB,CAAC"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
|
|
4
|
+
const RequireEventPropertyRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@eventProperty");
|
|
7
|
+
},
|
|
8
|
+
defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
|
|
9
|
+
meta: {
|
|
10
|
+
defaultOptions: [
|
|
11
|
+
{
|
|
12
|
+
enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
|
|
13
|
+
includeNonExported: false,
|
|
14
|
+
},
|
|
15
|
+
],
|
|
16
|
+
deprecated: false,
|
|
17
|
+
docs: {
|
|
18
|
+
description: "require @eventProperty tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
19
|
+
frozen: false,
|
|
20
|
+
recommended: false,
|
|
21
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-event-property.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @eventProperty.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-event-property",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireEventPropertyRule;
|
|
32
|
+
//# sourceMappingURL=require-event-property.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-event-property.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-event-property.ts"],"names":[],"mappings":"AAAA,OAAO,EAQH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,QAAA,MAAM,wBAAwB,EAAE,aA+B9B,CAAC;AAEH,eAAe,wBAAwB,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
const RequireEventPropertyRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@eventProperty");
|
|
5
|
+
},
|
|
6
|
+
defaultOptions: defaultRuleOptions,
|
|
7
|
+
meta: {
|
|
8
|
+
defaultOptions: [
|
|
9
|
+
{
|
|
10
|
+
enforceFor: [...enforceableEntityKinds],
|
|
11
|
+
includeNonExported: false,
|
|
12
|
+
},
|
|
13
|
+
],
|
|
14
|
+
deprecated: false,
|
|
15
|
+
docs: {
|
|
16
|
+
description: "require @eventProperty tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
17
|
+
frozen: false,
|
|
18
|
+
recommended: false,
|
|
19
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-event-property.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @eventProperty.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-event-property",
|
|
28
|
+
});
|
|
29
|
+
export default RequireEventPropertyRule;
|
|
30
|
+
//# sourceMappingURL=require-event-property.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-event-property.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-event-property.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,wBAAwB,GAAkB,aAAa,CAG3D;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IACnE,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,6FAA6F;YACjG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,0HAA0H;SAClI;QACD,QAAQ,EAAE;YACN,UAAU,EACN,sEAAsE;SAC7E;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,wBAAwB;CACjC,CAAC,CAAC;AAEH,eAAe,wBAAwB,CAAC"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
|
|
4
|
+
const RequireExampleRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@example");
|
|
7
|
+
},
|
|
8
|
+
defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
|
|
9
|
+
meta: {
|
|
10
|
+
defaultOptions: [
|
|
11
|
+
{
|
|
12
|
+
enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
|
|
13
|
+
includeNonExported: false,
|
|
14
|
+
},
|
|
15
|
+
],
|
|
16
|
+
deprecated: false,
|
|
17
|
+
docs: {
|
|
18
|
+
description: "require @example tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
19
|
+
frozen: false,
|
|
20
|
+
recommended: false,
|
|
21
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-example.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @example.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-example",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireExampleRule;
|
|
32
|
+
//# sourceMappingURL=require-example.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-example.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-example.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"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
const RequireExampleRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@example");
|
|
5
|
+
},
|
|
6
|
+
defaultOptions: defaultRuleOptions,
|
|
7
|
+
meta: {
|
|
8
|
+
defaultOptions: [
|
|
9
|
+
{
|
|
10
|
+
enforceFor: [...enforceableEntityKinds],
|
|
11
|
+
includeNonExported: false,
|
|
12
|
+
},
|
|
13
|
+
],
|
|
14
|
+
deprecated: false,
|
|
15
|
+
docs: {
|
|
16
|
+
description: "require @example tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
17
|
+
frozen: false,
|
|
18
|
+
recommended: false,
|
|
19
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-example.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @example.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-example",
|
|
28
|
+
});
|
|
29
|
+
export default RequireExampleRule;
|
|
30
|
+
//# sourceMappingURL=require-example.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-example.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-example.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"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
|
|
4
|
+
const RequireExperimentalRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@experimental");
|
|
7
|
+
},
|
|
8
|
+
defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
|
|
9
|
+
meta: {
|
|
10
|
+
defaultOptions: [
|
|
11
|
+
{
|
|
12
|
+
enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
|
|
13
|
+
includeNonExported: false,
|
|
14
|
+
},
|
|
15
|
+
],
|
|
16
|
+
deprecated: false,
|
|
17
|
+
docs: {
|
|
18
|
+
description: "require @experimental tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
19
|
+
frozen: false,
|
|
20
|
+
recommended: false,
|
|
21
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-experimental.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @experimental.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-experimental",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireExperimentalRule;
|
|
32
|
+
//# sourceMappingURL=require-experimental.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-experimental.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-experimental.ts"],"names":[],"mappings":"AAAA,OAAO,EAQH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,QAAA,MAAM,uBAAuB,EAAE,aA+B7B,CAAC;AAEH,eAAe,uBAAuB,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
const RequireExperimentalRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@experimental");
|
|
5
|
+
},
|
|
6
|
+
defaultOptions: defaultRuleOptions,
|
|
7
|
+
meta: {
|
|
8
|
+
defaultOptions: [
|
|
9
|
+
{
|
|
10
|
+
enforceFor: [...enforceableEntityKinds],
|
|
11
|
+
includeNonExported: false,
|
|
12
|
+
},
|
|
13
|
+
],
|
|
14
|
+
deprecated: false,
|
|
15
|
+
docs: {
|
|
16
|
+
description: "require @experimental tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
17
|
+
frozen: false,
|
|
18
|
+
recommended: false,
|
|
19
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-experimental.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @experimental.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-experimental",
|
|
28
|
+
});
|
|
29
|
+
export default RequireExperimentalRule;
|
|
30
|
+
//# sourceMappingURL=require-experimental.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-experimental.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-experimental.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,uBAAuB,GAAkB,aAAa,CAG1D;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAClE,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,4FAA4F;YAChG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,wHAAwH;SAChI;QACD,QAAQ,EAAE;YACN,UAAU,EACN,qEAAqE;SAC5E;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,sBAAsB;CAC/B,CAAC,CAAC;AAEH,eAAe,uBAAuB,CAAC"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
|
|
4
|
+
const RequireInheritDocRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@inheritDoc");
|
|
7
|
+
},
|
|
8
|
+
defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
|
|
9
|
+
meta: {
|
|
10
|
+
defaultOptions: [
|
|
11
|
+
{
|
|
12
|
+
enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
|
|
13
|
+
includeNonExported: false,
|
|
14
|
+
},
|
|
15
|
+
],
|
|
16
|
+
deprecated: false,
|
|
17
|
+
docs: {
|
|
18
|
+
description: "require @inheritDoc tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
19
|
+
frozen: false,
|
|
20
|
+
recommended: false,
|
|
21
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-inherit-doc.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @inheritDoc.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-inherit-doc",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireInheritDocRule;
|
|
32
|
+
//# sourceMappingURL=require-inherit-doc.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-inherit-doc.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-inherit-doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAQH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,QAAA,MAAM,qBAAqB,EAAE,aA+B3B,CAAC;AAEH,eAAe,qBAAqB,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
const RequireInheritDocRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@inheritDoc");
|
|
5
|
+
},
|
|
6
|
+
defaultOptions: defaultRuleOptions,
|
|
7
|
+
meta: {
|
|
8
|
+
defaultOptions: [
|
|
9
|
+
{
|
|
10
|
+
enforceFor: [...enforceableEntityKinds],
|
|
11
|
+
includeNonExported: false,
|
|
12
|
+
},
|
|
13
|
+
],
|
|
14
|
+
deprecated: false,
|
|
15
|
+
docs: {
|
|
16
|
+
description: "require @inheritDoc tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
17
|
+
frozen: false,
|
|
18
|
+
recommended: false,
|
|
19
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-inherit-doc.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @inheritDoc.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-inherit-doc",
|
|
28
|
+
});
|
|
29
|
+
export default RequireInheritDocRule;
|
|
30
|
+
//# sourceMappingURL=require-inherit-doc.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-inherit-doc.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-inherit-doc.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,qBAAqB,GAAkB,aAAa,CAGxD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAChE,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,0FAA0F;YAC9F,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,uHAAuH;SAC/H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,mEAAmE;SAC1E;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,qBAAqB;CAC9B,CAAC,CAAC;AAEH,eAAe,qBAAqB,CAAC"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
|
|
4
|
+
const RequireInternalRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@internal");
|
|
7
|
+
},
|
|
8
|
+
defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
|
|
9
|
+
meta: {
|
|
10
|
+
defaultOptions: [
|
|
11
|
+
{
|
|
12
|
+
enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
|
|
13
|
+
includeNonExported: false,
|
|
14
|
+
},
|
|
15
|
+
],
|
|
16
|
+
deprecated: false,
|
|
17
|
+
docs: {
|
|
18
|
+
description: "require @internal tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
19
|
+
frozen: false,
|
|
20
|
+
recommended: false,
|
|
21
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-internal.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @internal.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-internal",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireInternalRule;
|
|
32
|
+
//# sourceMappingURL=require-internal.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-internal.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-internal.ts"],"names":[],"mappings":"AAAA,OAAO,EAQH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,QAAA,MAAM,mBAAmB,EAAE,aA+BzB,CAAC;AAEH,eAAe,mBAAmB,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
const RequireInternalRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@internal");
|
|
5
|
+
},
|
|
6
|
+
defaultOptions: defaultRuleOptions,
|
|
7
|
+
meta: {
|
|
8
|
+
defaultOptions: [
|
|
9
|
+
{
|
|
10
|
+
enforceFor: [...enforceableEntityKinds],
|
|
11
|
+
includeNonExported: false,
|
|
12
|
+
},
|
|
13
|
+
],
|
|
14
|
+
deprecated: false,
|
|
15
|
+
docs: {
|
|
16
|
+
description: "require @internal tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
17
|
+
frozen: false,
|
|
18
|
+
recommended: false,
|
|
19
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-internal.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @internal.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-internal",
|
|
28
|
+
});
|
|
29
|
+
export default RequireInternalRule;
|
|
30
|
+
//# sourceMappingURL=require-internal.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-internal.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-internal.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,mBAAmB,GAAkB,aAAa,CAGtD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC9D,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,wFAAwF;YAC5F,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,oHAAoH;SAC5H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,iEAAiE;SACxE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,kBAAkB;CAC3B,CAAC,CAAC;AAEH,eAAe,mBAAmB,CAAC"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
|
|
4
|
+
const RequireLabelRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@label");
|
|
7
|
+
},
|
|
8
|
+
defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
|
|
9
|
+
meta: {
|
|
10
|
+
defaultOptions: [
|
|
11
|
+
{
|
|
12
|
+
enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
|
|
13
|
+
includeNonExported: false,
|
|
14
|
+
},
|
|
15
|
+
],
|
|
16
|
+
deprecated: false,
|
|
17
|
+
docs: {
|
|
18
|
+
description: "require @label tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
19
|
+
frozen: false,
|
|
20
|
+
recommended: false,
|
|
21
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-label.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @label.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-label",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireLabelRule;
|
|
32
|
+
//# sourceMappingURL=require-label.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-label.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-label.ts"],"names":[],"mappings":"AAAA,OAAO,EAQH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,QAAA,MAAM,gBAAgB,EAAE,aA+BtB,CAAC;AAEH,eAAe,gBAAgB,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
const RequireLabelRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@label");
|
|
5
|
+
},
|
|
6
|
+
defaultOptions: defaultRuleOptions,
|
|
7
|
+
meta: {
|
|
8
|
+
defaultOptions: [
|
|
9
|
+
{
|
|
10
|
+
enforceFor: [...enforceableEntityKinds],
|
|
11
|
+
includeNonExported: false,
|
|
12
|
+
},
|
|
13
|
+
],
|
|
14
|
+
deprecated: false,
|
|
15
|
+
docs: {
|
|
16
|
+
description: "require @label tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
17
|
+
frozen: false,
|
|
18
|
+
recommended: false,
|
|
19
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-label.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @label.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-label",
|
|
28
|
+
});
|
|
29
|
+
export default RequireLabelRule;
|
|
30
|
+
//# sourceMappingURL=require-label.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-label.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-label.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,gBAAgB,GAAkB,aAAa,CAGnD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IACD,cAAc,EAAE,kBAAkB;IAClC,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,qFAAqF;YACzF,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,iHAAiH;SACzH;QACD,QAAQ,EAAE;YACN,UAAU,EACN,8DAA8D;SACrE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,eAAe;CACxB,CAAC,CAAC;AAEH,eAAe,gBAAgB,CAAC"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
|
|
4
|
+
const RequireLinkRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@link");
|
|
7
|
+
},
|
|
8
|
+
defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
|
|
9
|
+
meta: {
|
|
10
|
+
defaultOptions: [
|
|
11
|
+
{
|
|
12
|
+
enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
|
|
13
|
+
includeNonExported: false,
|
|
14
|
+
},
|
|
15
|
+
],
|
|
16
|
+
deprecated: false,
|
|
17
|
+
docs: {
|
|
18
|
+
description: "require @link tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
19
|
+
frozen: false,
|
|
20
|
+
recommended: false,
|
|
21
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-link.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @link.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-link",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireLinkRule;
|
|
32
|
+
//# sourceMappingURL=require-link.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-link.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-link.ts"],"names":[],"mappings":"AAAA,OAAO,EAQH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,QAAA,MAAM,eAAe,EAAE,aA+BrB,CAAC;AAEH,eAAe,eAAe,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
const RequireLinkRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@link");
|
|
5
|
+
},
|
|
6
|
+
defaultOptions: defaultRuleOptions,
|
|
7
|
+
meta: {
|
|
8
|
+
defaultOptions: [
|
|
9
|
+
{
|
|
10
|
+
enforceFor: [...enforceableEntityKinds],
|
|
11
|
+
includeNonExported: false,
|
|
12
|
+
},
|
|
13
|
+
],
|
|
14
|
+
deprecated: false,
|
|
15
|
+
docs: {
|
|
16
|
+
description: "require @link tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
17
|
+
frozen: false,
|
|
18
|
+
recommended: false,
|
|
19
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-link.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @link.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-link",
|
|
28
|
+
});
|
|
29
|
+
export default RequireLinkRule;
|
|
30
|
+
//# sourceMappingURL=require-link.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-link.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-link.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,eAAe,GAAkB,aAAa,CAGlD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1D,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,oFAAoF;YACxF,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,gHAAgH;SACxH;QACD,QAAQ,EAAE;YACN,UAAU,EACN,6DAA6D;SACpE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,cAAc;CACvB,CAAC,CAAC;AAEH,eAAe,eAAe,CAAC"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
|
|
4
|
+
const RequireOverrideRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@override");
|
|
7
|
+
},
|
|
8
|
+
defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
|
|
9
|
+
meta: {
|
|
10
|
+
defaultOptions: [
|
|
11
|
+
{
|
|
12
|
+
enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
|
|
13
|
+
includeNonExported: false,
|
|
14
|
+
},
|
|
15
|
+
],
|
|
16
|
+
deprecated: false,
|
|
17
|
+
docs: {
|
|
18
|
+
description: "require @override tag in TSDoc blocks for TypeScript declarations and default exports.",
|
|
19
|
+
frozen: false,
|
|
20
|
+
recommended: false,
|
|
21
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-override.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @override.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-override",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireOverrideRule;
|
|
32
|
+
//# sourceMappingURL=require-override.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-override.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-override.ts"],"names":[],"mappings":"AAAA,OAAO,EAQH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,QAAA,MAAM,mBAAmB,EAAE,aA+BzB,CAAC;AAEH,eAAe,mBAAmB,CAAC"}
|