eslint-plugin-tsdoc-require-2 1.0.2 → 1.0.3
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 +23 -11
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
const RequireOverrideRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@override");
|
|
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 @override 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-override.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @override.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-override",
|
|
28
|
+
});
|
|
29
|
+
export default RequireOverrideRule;
|
|
30
|
+
//# sourceMappingURL=require-override.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-override.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-override.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 RequirePackageDocumentationRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@packageDocumentation");
|
|
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 @packageDocumentation 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-package-documentation.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @packageDocumentation.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-package-documentation",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequirePackageDocumentationRule;
|
|
32
|
+
//# sourceMappingURL=require-package-documentation.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-package-documentation.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-package-documentation.ts"],"names":[],"mappings":"AAAA,OAAO,EAQH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,QAAA,MAAM,+BAA+B,EAAE,aA+BrC,CAAC;AAEH,eAAe,+BAA+B,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
const RequirePackageDocumentationRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@packageDocumentation");
|
|
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 @packageDocumentation 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-package-documentation.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @packageDocumentation.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-package-documentation",
|
|
28
|
+
});
|
|
29
|
+
export default RequirePackageDocumentationRule;
|
|
30
|
+
//# sourceMappingURL=require-package-documentation.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-package-documentation.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-package-documentation.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,+BAA+B,GAAkB,aAAa,CAGlE;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;IAC1E,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,oGAAoG;YACxG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,iIAAiI;SACzI;QACD,QAAQ,EAAE;YACN,UAAU,EACN,6EAA6E;SACpF;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,+BAA+B;CACxC,CAAC,CAAC;AAEH,eAAe,+BAA+B,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 RequireParamRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@param");
|
|
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 @param 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-param.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @param.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-param",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireParamRule;
|
|
32
|
+
//# sourceMappingURL=require-param.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-param.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-param.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 RequireParamRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@param");
|
|
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 @param 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-param.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @param.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-param",
|
|
28
|
+
});
|
|
29
|
+
export default RequireParamRule;
|
|
30
|
+
//# sourceMappingURL=require-param.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-param.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-param.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 RequirePrivateRemarksRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@privateRemarks");
|
|
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 @privateRemarks 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-private-remarks.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @privateRemarks.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-private-remarks",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequirePrivateRemarksRule;
|
|
32
|
+
//# sourceMappingURL=require-private-remarks.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-private-remarks.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-private-remarks.ts"],"names":[],"mappings":"AAAA,OAAO,EAQH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,QAAA,MAAM,yBAAyB,EAAE,aA+B/B,CAAC;AAEH,eAAe,yBAAyB,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
const RequirePrivateRemarksRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@privateRemarks");
|
|
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 @privateRemarks 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-private-remarks.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @privateRemarks.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-private-remarks",
|
|
28
|
+
});
|
|
29
|
+
export default RequirePrivateRemarksRule;
|
|
30
|
+
//# sourceMappingURL=require-private-remarks.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-private-remarks.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-private-remarks.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,MAAM,yBAAyB,GAAkB,aAAa,CAG5D;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IACpE,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,8FAA8F;YAClG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,2HAA2H;SACnI;QACD,QAAQ,EAAE;YACN,UAAU,EACN,uEAAuE;SAC9E;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,yBAAyB;CAClC,CAAC,CAAC;AAEH,eAAe,yBAAyB,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 RequirePublicRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@public");
|
|
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 @public 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-public.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @public.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-public",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequirePublicRule;
|
|
32
|
+
//# sourceMappingURL=require-public.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-public.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-public.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"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
const RequirePublicRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@public");
|
|
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 @public 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-public.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @public.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-public",
|
|
28
|
+
});
|
|
29
|
+
export default RequirePublicRule;
|
|
30
|
+
//# sourceMappingURL=require-public.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-public.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-public.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"}
|
|
@@ -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 RequireReadonlyRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@readonly");
|
|
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 @readonly 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-readonly.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @readonly.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-readonly",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireReadonlyRule;
|
|
32
|
+
//# sourceMappingURL=require-readonly.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-readonly.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-readonly.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 RequireReadonlyRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@readonly");
|
|
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 @readonly 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-readonly.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @readonly.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-readonly",
|
|
28
|
+
});
|
|
29
|
+
export default RequireReadonlyRule;
|
|
30
|
+
//# sourceMappingURL=require-readonly.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-readonly.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-readonly.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 RequireRemarksRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@remarks");
|
|
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 @remarks 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-remarks.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @remarks.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-remarks",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireRemarksRule;
|
|
32
|
+
//# sourceMappingURL=require-remarks.js.map
|
|
@@ -0,0 +1 @@
|
|
|
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"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
const RequireRemarksRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@remarks");
|
|
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 @remarks 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-remarks.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @remarks.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-remarks",
|
|
28
|
+
});
|
|
29
|
+
export default RequireRemarksRule;
|
|
30
|
+
//# sourceMappingURL=require-remarks.js.map
|
|
@@ -0,0 +1 @@
|
|
|
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"}
|
|
@@ -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 RequireReturnsRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@returns");
|
|
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 @returns 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-returns.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @returns.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-returns",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireReturnsRule;
|
|
32
|
+
//# sourceMappingURL=require-returns.js.map
|
|
@@ -0,0 +1 @@
|
|
|
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"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
const RequireReturnsRule = createTagRule({
|
|
3
|
+
create(context) {
|
|
4
|
+
return createRequireTagRuleListener(context, "@returns");
|
|
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 @returns 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-returns.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @returns.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-returns",
|
|
28
|
+
});
|
|
29
|
+
export default RequireReturnsRule;
|
|
30
|
+
//# sourceMappingURL=require-returns.js.map
|
|
@@ -0,0 +1 @@
|
|
|
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"}
|
|
@@ -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 RequireSealedRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
5
|
+
create(context) {
|
|
6
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@sealed");
|
|
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 @sealed 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-sealed.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @sealed.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-sealed",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireSealedRule;
|
|
32
|
+
//# sourceMappingURL=require-sealed.js.map
|
|
@@ -0,0 +1 @@
|
|
|
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"}
|