@codeperfect/eslint-plugin 1.0.0
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/LICENSE +21 -0
- package/README.md +128 -0
- package/dist/.tsbuildinfo +1 -0
- package/dist/architecture/consistent-barrel-files/consistent-barrel-files-listeners.d.ts +16 -0
- package/dist/architecture/consistent-barrel-files/consistent-barrel-files-listeners.d.ts.map +1 -0
- package/dist/architecture/consistent-barrel-files/consistent-barrel-files-listeners.js +131 -0
- package/dist/architecture/consistent-barrel-files/consistent-barrel-files-options.d.ts +48 -0
- package/dist/architecture/consistent-barrel-files/consistent-barrel-files-options.d.ts.map +1 -0
- package/dist/architecture/consistent-barrel-files/consistent-barrel-files-options.js +126 -0
- package/dist/architecture/consistent-barrel-files/exports-only-rule-test-utilities.d.ts +40 -0
- package/dist/architecture/consistent-barrel-files/exports-only-rule-test-utilities.d.ts.map +1 -0
- package/dist/architecture/consistent-barrel-files/exports-only-rule-test-utilities.js +90 -0
- package/dist/architecture/consistent-barrel-files/exports-only-rule.d.ts +11 -0
- package/dist/architecture/consistent-barrel-files/exports-only-rule.d.ts.map +1 -0
- package/dist/architecture/consistent-barrel-files/exports-only-rule.js +218 -0
- package/dist/architecture/consistent-barrel-files/index.d.ts +5 -0
- package/dist/architecture/consistent-barrel-files/index.d.ts.map +1 -0
- package/dist/architecture/consistent-barrel-files/index.js +4 -0
- package/dist/architecture/consistent-barrel-files/no-reexports-outside-barrels-rule.d.ts +11 -0
- package/dist/architecture/consistent-barrel-files/no-reexports-outside-barrels-rule.d.ts.map +1 -0
- package/dist/architecture/consistent-barrel-files/no-reexports-outside-barrels-rule.js +100 -0
- package/dist/architecture/consistent-barrel-files/no-reexports-outside-barrels-test-utilities.d.ts +40 -0
- package/dist/architecture/consistent-barrel-files/no-reexports-outside-barrels-test-utilities.d.ts.map +1 -0
- package/dist/architecture/consistent-barrel-files/no-reexports-outside-barrels-test-utilities.js +90 -0
- package/dist/architecture/consistent-barrel-files/no-reexports-outside-barrels-utilities.d.ts +65 -0
- package/dist/architecture/consistent-barrel-files/no-reexports-outside-barrels-utilities.d.ts.map +1 -0
- package/dist/architecture/consistent-barrel-files/no-reexports-outside-barrels-utilities.js +154 -0
- package/dist/architecture/consistent-barrel-files/rule.d.ts +11 -0
- package/dist/architecture/consistent-barrel-files/rule.d.ts.map +1 -0
- package/dist/architecture/consistent-barrel-files/rule.js +58 -0
- package/dist/architecture/consistent-barrel-files/test-helpers.d.ts +141 -0
- package/dist/architecture/consistent-barrel-files/test-helpers.d.ts.map +1 -0
- package/dist/architecture/consistent-barrel-files/test-helpers.js +229 -0
- package/dist/architecture/consistent-barrel-files/types.d.ts +25 -0
- package/dist/architecture/consistent-barrel-files/types.d.ts.map +1 -0
- package/dist/architecture/consistent-barrel-files/types.js +2 -0
- package/dist/architecture/index.d.ts +2 -0
- package/dist/architecture/index.d.ts.map +1 -0
- package/dist/architecture/index.js +2 -0
- package/dist/benchmark-rules.d.ts +83 -0
- package/dist/benchmark-rules.d.ts.map +1 -0
- package/dist/benchmark-rules.js +175 -0
- package/dist/codeperfect-eslint-plugin-1.0.0.tgz +0 -0
- package/dist/codeperfect-plugin.d.ts +46 -0
- package/dist/codeperfect-plugin.d.ts.map +1 -0
- package/dist/codeperfect-plugin.js +29 -0
- package/dist/core/index.d.ts +3 -0
- package/dist/core/index.d.ts.map +1 -0
- package/dist/core/index.js +3 -0
- package/dist/core/no-multiple-declarators/index.d.ts +2 -0
- package/dist/core/no-multiple-declarators/index.d.ts.map +1 -0
- package/dist/core/no-multiple-declarators/index.js +2 -0
- package/dist/core/no-multiple-declarators/rule.d.ts +4 -0
- package/dist/core/no-multiple-declarators/rule.d.ts.map +1 -0
- package/dist/core/no-multiple-declarators/rule.js +100 -0
- package/dist/core/prefer-interface-types/index.d.ts +2 -0
- package/dist/core/prefer-interface-types/index.d.ts.map +1 -0
- package/dist/core/prefer-interface-types/index.js +2 -0
- package/dist/core/prefer-interface-types/rule.d.ts +5 -0
- package/dist/core/prefer-interface-types/rule.d.ts.map +1 -0
- package/dist/core/prefer-interface-types/rule.js +145 -0
- package/dist/core/prefer-interface-types/test-helpers.d.ts +110 -0
- package/dist/core/prefer-interface-types/test-helpers.d.ts.map +1 -0
- package/dist/core/prefer-interface-types/test-helpers.js +116 -0
- package/dist/custom-rule-documentation.d.ts +36 -0
- package/dist/custom-rule-documentation.d.ts.map +1 -0
- package/dist/custom-rule-documentation.js +35 -0
- package/dist/custom-rules.d.ts +61 -0
- package/dist/custom-rules.d.ts.map +1 -0
- package/dist/custom-rules.js +70 -0
- package/dist/docs/index.d.ts +4 -0
- package/dist/docs/index.d.ts.map +1 -0
- package/dist/docs/index.js +4 -0
- package/dist/docs/no-interface-member-docs/comment-utilities-test-helpers.d.ts +89 -0
- package/dist/docs/no-interface-member-docs/comment-utilities-test-helpers.d.ts.map +1 -0
- package/dist/docs/no-interface-member-docs/comment-utilities-test-helpers.js +129 -0
- package/dist/docs/no-interface-member-docs/comment-utilities.d.ts +48 -0
- package/dist/docs/no-interface-member-docs/comment-utilities.d.ts.map +1 -0
- package/dist/docs/no-interface-member-docs/comment-utilities.js +146 -0
- package/dist/docs/no-interface-member-docs/index.d.ts +2 -0
- package/dist/docs/no-interface-member-docs/index.d.ts.map +1 -0
- package/dist/docs/no-interface-member-docs/index.js +2 -0
- package/dist/docs/no-interface-member-docs/parameter-tags.d.ts +13 -0
- package/dist/docs/no-interface-member-docs/parameter-tags.d.ts.map +1 -0
- package/dist/docs/no-interface-member-docs/parameter-tags.js +101 -0
- package/dist/docs/no-interface-member-docs/parameter-utilities.d.ts +24 -0
- package/dist/docs/no-interface-member-docs/parameter-utilities.d.ts.map +1 -0
- package/dist/docs/no-interface-member-docs/parameter-utilities.js +125 -0
- package/dist/docs/no-interface-member-docs/rule.d.ts +5 -0
- package/dist/docs/no-interface-member-docs/rule.d.ts.map +1 -0
- package/dist/docs/no-interface-member-docs/rule.js +168 -0
- package/dist/docs/no-interface-member-docs/test-helpers.d.ts +103 -0
- package/dist/docs/no-interface-member-docs/test-helpers.d.ts.map +1 -0
- package/dist/docs/no-interface-member-docs/test-helpers.js +157 -0
- package/dist/docs/no-interface-member-docs/types.d.ts +30 -0
- package/dist/docs/no-interface-member-docs/types.d.ts.map +1 -0
- package/dist/docs/no-interface-member-docs/types.js +2 -0
- package/dist/docs/require-example-language/empty-fence-fixes.d.ts +29 -0
- package/dist/docs/require-example-language/empty-fence-fixes.d.ts.map +1 -0
- package/dist/docs/require-example-language/empty-fence-fixes.js +169 -0
- package/dist/docs/require-example-language/example-utilities.d.ts +70 -0
- package/dist/docs/require-example-language/example-utilities.d.ts.map +1 -0
- package/dist/docs/require-example-language/example-utilities.js +76 -0
- package/dist/docs/require-example-language/examples.d.ts +36 -0
- package/dist/docs/require-example-language/examples.d.ts.map +1 -0
- package/dist/docs/require-example-language/examples.js +181 -0
- package/dist/docs/require-example-language/fixes.d.ts +49 -0
- package/dist/docs/require-example-language/fixes.d.ts.map +1 -0
- package/dist/docs/require-example-language/fixes.js +182 -0
- package/dist/docs/require-example-language/index.d.ts +3 -0
- package/dist/docs/require-example-language/index.d.ts.map +1 -0
- package/dist/docs/require-example-language/index.js +2 -0
- package/dist/docs/require-example-language/reporting.d.ts +60 -0
- package/dist/docs/require-example-language/reporting.d.ts.map +1 -0
- package/dist/docs/require-example-language/reporting.js +145 -0
- package/dist/docs/require-example-language/rule.d.ts +7 -0
- package/dist/docs/require-example-language/rule.d.ts.map +1 -0
- package/dist/docs/require-example-language/rule.js +34 -0
- package/dist/docs/require-example-language/types.d.ts +22 -0
- package/dist/docs/require-example-language/types.d.ts.map +1 -0
- package/dist/docs/require-example-language/types.js +2 -0
- package/dist/docs/single-line-jsdoc/index.d.ts +2 -0
- package/dist/docs/single-line-jsdoc/index.d.ts.map +1 -0
- package/dist/docs/single-line-jsdoc/index.js +2 -0
- package/dist/docs/single-line-jsdoc/rule.d.ts +5 -0
- package/dist/docs/single-line-jsdoc/rule.d.ts.map +1 -0
- package/dist/docs/single-line-jsdoc/rule.js +196 -0
- package/dist/docs/single-line-jsdoc/single-line-jsdoc-content.d.ts +16 -0
- package/dist/docs/single-line-jsdoc/single-line-jsdoc-content.d.ts.map +1 -0
- package/dist/docs/single-line-jsdoc/single-line-jsdoc-content.js +95 -0
- package/dist/docs/single-line-jsdoc/single-line-jsdoc-utilities.d.ts +25 -0
- package/dist/docs/single-line-jsdoc/single-line-jsdoc-utilities.d.ts.map +1 -0
- package/dist/docs/single-line-jsdoc/single-line-jsdoc-utilities.js +140 -0
- package/dist/docs/test-helpers.d.ts +50 -0
- package/dist/docs/test-helpers.d.ts.map +1 -0
- package/dist/docs/test-helpers.js +107 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +6 -0
- package/dist/presets.d.ts +10 -0
- package/dist/presets.d.ts.map +1 -0
- package/dist/presets.js +50 -0
- package/dist/rules/index.d.ts +5 -0
- package/dist/rules/index.d.ts.map +1 -0
- package/dist/rules/index.js +6 -0
- package/dist/testing/aaa/analyzer.d.ts +36 -0
- package/dist/testing/aaa/analyzer.d.ts.map +1 -0
- package/dist/testing/aaa/analyzer.js +490 -0
- package/dist/testing/aaa/index.d.ts +3 -0
- package/dist/testing/aaa/index.d.ts.map +1 -0
- package/dist/testing/aaa/index.js +2 -0
- package/dist/testing/aaa/types.d.ts +31 -0
- package/dist/testing/aaa/types.d.ts.map +1 -0
- package/dist/testing/aaa/types.js +2 -0
- package/dist/testing/assert-actual-expected-names/index.d.ts +2 -0
- package/dist/testing/assert-actual-expected-names/index.d.ts.map +1 -0
- package/dist/testing/assert-actual-expected-names/index.js +2 -0
- package/dist/testing/assert-actual-expected-names/rule.d.ts +4 -0
- package/dist/testing/assert-actual-expected-names/rule.d.ts.map +1 -0
- package/dist/testing/assert-actual-expected-names/rule.js +54 -0
- package/dist/testing/enforce-aaa-phase-purity/index.d.ts +2 -0
- package/dist/testing/enforce-aaa-phase-purity/index.d.ts.map +1 -0
- package/dist/testing/enforce-aaa-phase-purity/index.js +2 -0
- package/dist/testing/enforce-aaa-phase-purity/rule.d.ts +4 -0
- package/dist/testing/enforce-aaa-phase-purity/rule.d.ts.map +1 -0
- package/dist/testing/enforce-aaa-phase-purity/rule.js +110 -0
- package/dist/testing/enforce-aaa-structure/index.d.ts +2 -0
- package/dist/testing/enforce-aaa-structure/index.d.ts.map +1 -0
- package/dist/testing/enforce-aaa-structure/index.js +2 -0
- package/dist/testing/enforce-aaa-structure/rule.d.ts +4 -0
- package/dist/testing/enforce-aaa-structure/rule.d.ts.map +1 -0
- package/dist/testing/enforce-aaa-structure/rule.js +48 -0
- package/dist/testing/index.d.ts +9 -0
- package/dist/testing/index.d.ts.map +1 -0
- package/dist/testing/index.js +9 -0
- package/dist/testing/prefer-vi-mocked-import/fix.d.ts +16 -0
- package/dist/testing/prefer-vi-mocked-import/fix.d.ts.map +1 -0
- package/dist/testing/prefer-vi-mocked-import/fix.js +224 -0
- package/dist/testing/prefer-vi-mocked-import/index.d.ts +2 -0
- package/dist/testing/prefer-vi-mocked-import/index.d.ts.map +1 -0
- package/dist/testing/prefer-vi-mocked-import/index.js +2 -0
- package/dist/testing/prefer-vi-mocked-import/match-bindings.d.ts +16 -0
- package/dist/testing/prefer-vi-mocked-import/match-bindings.d.ts.map +1 -0
- package/dist/testing/prefer-vi-mocked-import/match-bindings.js +52 -0
- package/dist/testing/prefer-vi-mocked-import/match-declarations.d.ts +16 -0
- package/dist/testing/prefer-vi-mocked-import/match-declarations.d.ts.map +1 -0
- package/dist/testing/prefer-vi-mocked-import/match-declarations.js +99 -0
- package/dist/testing/prefer-vi-mocked-import/match-helpers.d.ts +66 -0
- package/dist/testing/prefer-vi-mocked-import/match-helpers.d.ts.map +1 -0
- package/dist/testing/prefer-vi-mocked-import/match-helpers.js +102 -0
- package/dist/testing/prefer-vi-mocked-import/match-imports.d.ts +17 -0
- package/dist/testing/prefer-vi-mocked-import/match-imports.d.ts.map +1 -0
- package/dist/testing/prefer-vi-mocked-import/match-imports.js +156 -0
- package/dist/testing/prefer-vi-mocked-import/match-rewrites.d.ts +42 -0
- package/dist/testing/prefer-vi-mocked-import/match-rewrites.d.ts.map +1 -0
- package/dist/testing/prefer-vi-mocked-import/match-rewrites.js +119 -0
- package/dist/testing/prefer-vi-mocked-import/match-walk.d.ts +13 -0
- package/dist/testing/prefer-vi-mocked-import/match-walk.d.ts.map +1 -0
- package/dist/testing/prefer-vi-mocked-import/match-walk.js +62 -0
- package/dist/testing/prefer-vi-mocked-import/match.d.ts +15 -0
- package/dist/testing/prefer-vi-mocked-import/match.d.ts.map +1 -0
- package/dist/testing/prefer-vi-mocked-import/match.js +193 -0
- package/dist/testing/prefer-vi-mocked-import/rule.d.ts +5 -0
- package/dist/testing/prefer-vi-mocked-import/rule.d.ts.map +1 -0
- package/dist/testing/prefer-vi-mocked-import/rule.js +32 -0
- package/dist/testing/prefer-vi-mocked-import/types.d.ts +83 -0
- package/dist/testing/prefer-vi-mocked-import/types.d.ts.map +1 -0
- package/dist/testing/prefer-vi-mocked-import/types.js +2 -0
- package/dist/testing/require-aaa-sections/index.d.ts +2 -0
- package/dist/testing/require-aaa-sections/index.d.ts.map +1 -0
- package/dist/testing/require-aaa-sections/index.js +2 -0
- package/dist/testing/require-aaa-sections/rule.d.ts +4 -0
- package/dist/testing/require-aaa-sections/rule.d.ts.map +1 -0
- package/dist/testing/require-aaa-sections/rule.js +111 -0
- package/dist/testing/require-act-result-capture/index.d.ts +2 -0
- package/dist/testing/require-act-result-capture/index.d.ts.map +1 -0
- package/dist/testing/require-act-result-capture/index.js +2 -0
- package/dist/testing/require-act-result-capture/rule.d.ts +4 -0
- package/dist/testing/require-act-result-capture/rule.d.ts.map +1 -0
- package/dist/testing/require-act-result-capture/rule.js +34 -0
- package/dist/testing/require-test-companion/index.d.ts +3 -0
- package/dist/testing/require-test-companion/index.d.ts.map +1 -0
- package/dist/testing/require-test-companion/index.js +3 -0
- package/dist/testing/require-test-companion/require-test-companion-listeners.d.ts +16 -0
- package/dist/testing/require-test-companion/require-test-companion-listeners.d.ts.map +1 -0
- package/dist/testing/require-test-companion/require-test-companion-listeners.js +145 -0
- package/dist/testing/require-test-companion/require-test-companion-options.d.ts +54 -0
- package/dist/testing/require-test-companion/require-test-companion-options.d.ts.map +1 -0
- package/dist/testing/require-test-companion/require-test-companion-options.js +112 -0
- package/dist/testing/require-test-companion/require-test-companion-test-helpers.d.ts +51 -0
- package/dist/testing/require-test-companion/require-test-companion-test-helpers.d.ts.map +1 -0
- package/dist/testing/require-test-companion/require-test-companion-test-helpers.js +183 -0
- package/dist/testing/require-test-companion/require-test-companion-utilities.d.ts +28 -0
- package/dist/testing/require-test-companion/require-test-companion-utilities.d.ts.map +1 -0
- package/dist/testing/require-test-companion/require-test-companion-utilities.js +26 -0
- package/dist/testing/require-test-companion/rule.d.ts +5 -0
- package/dist/testing/require-test-companion/rule.d.ts.map +1 -0
- package/dist/testing/require-test-companion/rule.js +57 -0
- package/dist/testing/require-test-companion/types.d.ts +11 -0
- package/dist/testing/require-test-companion/types.d.ts.map +1 -0
- package/dist/testing/require-test-companion/types.js +2 -0
- package/dist/testing/single-act-statement/index.d.ts +2 -0
- package/dist/testing/single-act-statement/index.d.ts.map +1 -0
- package/dist/testing/single-act-statement/index.js +2 -0
- package/dist/testing/single-act-statement/rule.d.ts +4 -0
- package/dist/testing/single-act-statement/rule.d.ts.map +1 -0
- package/dist/testing/single-act-statement/rule.js +33 -0
- package/package.json +106 -0
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
import { createRuleDocumentation } from "../../custom-rule-documentation";
|
|
2
|
+
import { buildRemovalRange, getCommentLines, getCommentText, getJsdocComment, } from "./comment-utilities";
|
|
3
|
+
import { parseParameterTagLine } from "./parameter-tags";
|
|
4
|
+
import { getParameterTypeLookup, isNamedTypeReference, } from "./parameter-utilities";
|
|
5
|
+
/**
|
|
6
|
+
* Checks whether a parameter member tag matches a named type reference.
|
|
7
|
+
* @param tag Parsed parameter member tag.
|
|
8
|
+
* @param parameterTypes Parameter type lookup.
|
|
9
|
+
* @returns True when the tag matches a named type reference.
|
|
10
|
+
* @example
|
|
11
|
+
* ```typescript
|
|
12
|
+
* const ok = isMatchingMemberTag(tag, parameterTypes);
|
|
13
|
+
* ```
|
|
14
|
+
*/
|
|
15
|
+
const isMatchingMemberTag = (tag, parameterTypes) => {
|
|
16
|
+
if (tag === void 0) {
|
|
17
|
+
return false;
|
|
18
|
+
}
|
|
19
|
+
const parameterType = parameterTypes.get(tag.baseName);
|
|
20
|
+
return isNamedTypeReference(parameterType);
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Collects member tags from a JSDoc comment.
|
|
24
|
+
* @param commentText Full comment text.
|
|
25
|
+
* @param parameterTypes Parameter type lookup.
|
|
26
|
+
* @returns Member tags that match named type references.
|
|
27
|
+
* @example
|
|
28
|
+
* ```typescript
|
|
29
|
+
* const tags = collectMemberTags(commentText, parameterTypes);
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
const collectMemberTags = (commentText, parameterTypes) => getCommentLines(commentText)
|
|
33
|
+
.map((line) => parseParameterTagLine(line))
|
|
34
|
+
.filter((tag) => isMatchingMemberTag(tag, parameterTypes));
|
|
35
|
+
/**
|
|
36
|
+
* Reports interface member documentation entries for removal.
|
|
37
|
+
* @param context Rule execution context.
|
|
38
|
+
* @param details Collected rule details.
|
|
39
|
+
* @example
|
|
40
|
+
* ```typescript
|
|
41
|
+
* reportMemberDocumentation(context, details);
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
const reportMemberDocumentation = (context, details) => {
|
|
45
|
+
const { commentStart, commentText, memberTags, node } = details;
|
|
46
|
+
for (const tag of memberTags) {
|
|
47
|
+
const removalRange = buildRemovalRange(commentStart, commentText, tag.line);
|
|
48
|
+
context.report({
|
|
49
|
+
data: { parameterName: tag.fullName },
|
|
50
|
+
fix: (fixer) => fixer.removeRange(removalRange),
|
|
51
|
+
messageId: "interfaceMemberDoc",
|
|
52
|
+
node,
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
};
|
|
56
|
+
/**
|
|
57
|
+
* Gets parameter type references for a node.
|
|
58
|
+
* @param node Function-like node to inspect.
|
|
59
|
+
* @returns Parameter type lookup when present.
|
|
60
|
+
* @example
|
|
61
|
+
* ```typescript
|
|
62
|
+
* const lookup = getParameterTypes(node);
|
|
63
|
+
* ```
|
|
64
|
+
*/
|
|
65
|
+
const getParameterTypes = (node) => {
|
|
66
|
+
const parameterTypes = getParameterTypeLookup(node);
|
|
67
|
+
return parameterTypes.size > 0 ? parameterTypes : void 0;
|
|
68
|
+
};
|
|
69
|
+
/**
|
|
70
|
+
* Resolves the JSDoc comment data for a node.
|
|
71
|
+
* @param sourceCode SourceCode wrapper.
|
|
72
|
+
* @param node Node to inspect.
|
|
73
|
+
* @returns JSDoc data when available.
|
|
74
|
+
* @example
|
|
75
|
+
* ```typescript
|
|
76
|
+
* const data = getJsdocData(sourceCode, node);
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
const getJsdocData = (sourceCode, node) => {
|
|
80
|
+
const comment = getJsdocComment(sourceCode, node);
|
|
81
|
+
if (comment === void 0) {
|
|
82
|
+
return void 0;
|
|
83
|
+
}
|
|
84
|
+
const commentStart = comment.range?.[0];
|
|
85
|
+
if (typeof commentStart !== "number") {
|
|
86
|
+
return void 0;
|
|
87
|
+
}
|
|
88
|
+
const text = getCommentText(sourceCode, comment);
|
|
89
|
+
return { comment, commentStart, text };
|
|
90
|
+
};
|
|
91
|
+
/**
|
|
92
|
+
* Resolves the member tag context for a node.
|
|
93
|
+
* @param context Rule execution context.
|
|
94
|
+
* @param node Node to inspect.
|
|
95
|
+
* @returns Member tag context when available.
|
|
96
|
+
* @example
|
|
97
|
+
* ```typescript
|
|
98
|
+
* const context = resolveMemberTagContext(context, node);
|
|
99
|
+
* ```
|
|
100
|
+
*/
|
|
101
|
+
const resolveMemberTagContext = (context, node) => {
|
|
102
|
+
const parameterTypes = getParameterTypes(node);
|
|
103
|
+
const jsdocData = getJsdocData(context.sourceCode, node);
|
|
104
|
+
if (parameterTypes === void 0 || jsdocData === void 0) {
|
|
105
|
+
return void 0;
|
|
106
|
+
}
|
|
107
|
+
const memberTags = collectMemberTags(jsdocData.text, parameterTypes);
|
|
108
|
+
return memberTags.length > 0
|
|
109
|
+
? {
|
|
110
|
+
comment: jsdocData.comment,
|
|
111
|
+
commentStart: jsdocData.commentStart,
|
|
112
|
+
commentText: jsdocData.text,
|
|
113
|
+
memberTags,
|
|
114
|
+
}
|
|
115
|
+
: void 0;
|
|
116
|
+
};
|
|
117
|
+
/**
|
|
118
|
+
* Handles function-like nodes for this rule.
|
|
119
|
+
* @param context Rule execution context.
|
|
120
|
+
* @param node Node to inspect.
|
|
121
|
+
* @example
|
|
122
|
+
* ```typescript
|
|
123
|
+
* handleFunctionLike(context, node);
|
|
124
|
+
* ```
|
|
125
|
+
*/
|
|
126
|
+
const handleFunctionLike = (context, node) => {
|
|
127
|
+
const resolved = resolveMemberTagContext(context, node);
|
|
128
|
+
if (resolved === void 0) {
|
|
129
|
+
return;
|
|
130
|
+
}
|
|
131
|
+
reportMemberDocumentation(context, {
|
|
132
|
+
comment: resolved.comment,
|
|
133
|
+
commentStart: resolved.commentStart,
|
|
134
|
+
commentText: resolved.commentText,
|
|
135
|
+
memberTags: resolved.memberTags,
|
|
136
|
+
node,
|
|
137
|
+
sourceCode: context.sourceCode,
|
|
138
|
+
});
|
|
139
|
+
};
|
|
140
|
+
/** ESLint rule disallowing interface member documentation in `@param` tags. */
|
|
141
|
+
const noInterfaceMemberDocumentationRule = {
|
|
142
|
+
create(context) {
|
|
143
|
+
const listener = (node) => {
|
|
144
|
+
handleFunctionLike(context, node);
|
|
145
|
+
};
|
|
146
|
+
return {
|
|
147
|
+
ArrowFunctionExpression: listener,
|
|
148
|
+
FunctionDeclaration: listener,
|
|
149
|
+
FunctionExpression: listener,
|
|
150
|
+
TSCallSignatureDeclaration: listener,
|
|
151
|
+
TSConstructSignatureDeclaration: listener,
|
|
152
|
+
TSDeclareFunction: listener,
|
|
153
|
+
TSFunctionType: listener,
|
|
154
|
+
TSMethodSignature: listener,
|
|
155
|
+
};
|
|
156
|
+
},
|
|
157
|
+
meta: {
|
|
158
|
+
docs: createRuleDocumentation("no-interface-member-docs", "Disallow documenting interface members in @param tags; document them on the interface instead."),
|
|
159
|
+
fixable: "code",
|
|
160
|
+
messages: {
|
|
161
|
+
interfaceMemberDoc: "Document interface members on the interface instead of using @param for {{parameterName}}.",
|
|
162
|
+
},
|
|
163
|
+
schema: [],
|
|
164
|
+
type: "problem",
|
|
165
|
+
},
|
|
166
|
+
};
|
|
167
|
+
export { noInterfaceMemberDocumentationRule };
|
|
168
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"rule.js","sourceRoot":"","sources":["../../../src/docs/no-interface-member-docs/rule.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,eAAe,GAChB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EACL,sBAAsB,EACtB,oBAAoB,GACrB,MAAM,uBAAuB,CAAC;AAuB/B;;;;;;;;;GASG;AACH,MAAM,mBAAmB,GAAG,CAC1B,GAAmC,EACnC,cAA+C,EACpB,EAAE;IAC7B,IAAI,GAAG,KAAK,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,aAAa,GAAG,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAEvD,OAAO,oBAAoB,CAAC,aAAa,CAAC,CAAC;AAC7C,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,iBAAiB,GAAG,CACxB,WAAmB,EACnB,cAA+C,EACzB,EAAE,CACxB,eAAe,CAAC,WAAW,CAAC;KACzB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;KAC1C,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAmB,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC;AAE/D;;;;;;;;GAQG;AACH,MAAM,yBAAyB,GAAG,CAChC,OAAyB,EACzB,OAAyC,EACnC,EAAE;IACR,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAEhE,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAC7B,MAAM,YAAY,GAAG,iBAAiB,CAAC,YAAY,EAAE,WAAW,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QAE5E,OAAO,CAAC,MAAM,CAAC;YACb,IAAI,EAAE,EAAE,aAAa,EAAE,GAAG,CAAC,QAAQ,EAAE;YACrC,GAAG,EAAE,CAAC,KAAqB,EAAY,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC;YACzE,SAAS,EAAE,oBAAoB;YAC/B,IAAI;SACL,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,iBAAiB,GAAG,CACxB,IAAe,EAC8B,EAAE;IAC/C,MAAM,cAAc,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAEpD,OAAO,cAAc,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAC3D,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,YAAY,GAAG,CACnB,UAA0C,EAC1C,IAAe,EAYX,EAAE;IACN,MAAM,OAAO,GAAG,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAElD,IAAI,OAAO,KAAK,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IAExC,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QACrC,OAAO,KAAK,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,IAAI,GAAG,cAAc,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAEjD,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;AACzC,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,uBAAuB,GAAG,CAC9B,OAAyB,EACzB,IAAe,EAeX,EAAE;IACN,MAAM,cAAc,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAEzD,IAAI,cAAc,KAAK,KAAK,CAAC,IAAI,SAAS,KAAK,KAAK,CAAC,EAAE,CAAC;QACtD,OAAO,KAAK,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,UAAU,GAAG,iBAAiB,CAAC,SAAS,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAErE,OAAO,UAAU,CAAC,MAAM,GAAG,CAAC;QAC1B,CAAC,CAAC;YACE,OAAO,EAAE,SAAS,CAAC,OAAO;YAC1B,YAAY,EAAE,SAAS,CAAC,YAAY;YACpC,WAAW,EAAE,SAAS,CAAC,IAAI;YAC3B,UAAU;SACX;QACH,CAAC,CAAC,KAAK,CAAC,CAAC;AACb,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,kBAAkB,GAAG,CACzB,OAAyB,EACzB,IAAe,EACT,EAAE;IACR,MAAM,QAAQ,GAAG,uBAAuB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAExD,IAAI,QAAQ,KAAK,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO;IACT,CAAC;IAED,yBAAyB,CAAC,OAAO,EAAE;QACjC,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,YAAY,EAAE,QAAQ,CAAC,YAAY;QACnC,WAAW,EAAE,QAAQ,CAAC,WAAW;QACjC,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,IAAI;QACJ,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,+EAA+E;AAC/E,MAAM,kCAAkC,GAAoB;IAC1D,MAAM,CAAC,OAAyB;QAC9B,MAAM,QAAQ,GAAG,CAAC,IAAe,EAAQ,EAAE;YACzC,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC,CAAC;QAEF,OAAO;YACL,uBAAuB,EAAE,QAAQ;YACjC,mBAAmB,EAAE,QAAQ;YAC7B,kBAAkB,EAAE,QAAQ;YAC5B,0BAA0B,EAAE,QAAQ;YACpC,+BAA+B,EAAE,QAAQ;YACzC,iBAAiB,EAAE,QAAQ;YAC3B,cAAc,EAAE,QAAQ;YACxB,iBAAiB,EAAE,QAAQ;SAC5B,CAAC;IACJ,CAAC;IACD,IAAI,EAAE;QACJ,IAAI,EAAE,uBAAuB,CAC3B,0BAA0B,EAC1B,gGAAgG,CACjG;QACD,OAAO,EAAE,MAAM;QACf,QAAQ,EAAE;YACR,kBAAkB,EAChB,4FAA4F;SAC/F;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KAChB;CACF,CAAC;AAEF,OAAO,EAAE,kCAAkC,EAAE,CAAC","sourcesContent":["import type { Rule } from \"eslint\";\n\nimport type { Comment, ParameterMemberTag, TypeAnnotationNode } from \"./types\";\n\nimport { createRuleDocumentation } from \"../../custom-rule-documentation\";\nimport {\n  buildRemovalRange,\n  getCommentLines,\n  getCommentText,\n  getJsdocComment,\n} from \"./comment-utilities\";\nimport { parseParameterTagLine } from \"./parameter-tags\";\nimport {\n  getParameterTypeLookup,\n  isNamedTypeReference,\n} from \"./parameter-utilities\";\n\n/** Type definition for rule data. */\ninterface ReportMemberDocumentationContext {\n  /** Comment field value. */\n  comment: Comment;\n\n  /** CommentStart field value. */\n  commentStart: number;\n\n  /** CommentText field value. */\n  commentText: string;\n\n  /** MemberTags field value. */\n  memberTags: ParameterMemberTag[];\n\n  /** Node field value. */\n  node: Rule.Node;\n\n  /** SourceCode field value. */\n  sourceCode: Rule.RuleContext[\"sourceCode\"];\n}\n\n/**\n * Checks whether a parameter member tag matches a named type reference.\n * @param tag Parsed parameter member tag.\n * @param parameterTypes Parameter type lookup.\n * @returns True when the tag matches a named type reference.\n * @example\n * ```typescript\n * const ok = isMatchingMemberTag(tag, parameterTypes);\n * ```\n */\nconst isMatchingMemberTag = (\n  tag: ParameterMemberTag | undefined,\n  parameterTypes: Map<string, TypeAnnotationNode>,\n): tag is ParameterMemberTag => {\n  if (tag === void 0) {\n    return false;\n  }\n\n  const parameterType = parameterTypes.get(tag.baseName);\n\n  return isNamedTypeReference(parameterType);\n};\n\n/**\n * Collects member tags from a JSDoc comment.\n * @param commentText Full comment text.\n * @param parameterTypes Parameter type lookup.\n * @returns Member tags that match named type references.\n * @example\n * ```typescript\n * const tags = collectMemberTags(commentText, parameterTypes);\n * ```\n */\nconst collectMemberTags = (\n  commentText: string,\n  parameterTypes: Map<string, TypeAnnotationNode>,\n): ParameterMemberTag[] =>\n  getCommentLines(commentText)\n    .map((line) => parseParameterTagLine(line))\n    .filter((tag) => isMatchingMemberTag(tag, parameterTypes));\n\n/**\n * Reports interface member documentation entries for removal.\n * @param context Rule execution context.\n * @param details Collected rule details.\n * @example\n * ```typescript\n * reportMemberDocumentation(context, details);\n * ```\n */\nconst reportMemberDocumentation = (\n  context: Rule.RuleContext,\n  details: ReportMemberDocumentationContext,\n): void => {\n  const { commentStart, commentText, memberTags, node } = details;\n\n  for (const tag of memberTags) {\n    const removalRange = buildRemovalRange(commentStart, commentText, tag.line);\n\n    context.report({\n      data: { parameterName: tag.fullName },\n      fix: (fixer: Rule.RuleFixer): Rule.Fix => fixer.removeRange(removalRange),\n      messageId: \"interfaceMemberDoc\",\n      node,\n    });\n  }\n};\n\n/**\n * Gets parameter type references for a node.\n * @param node Function-like node to inspect.\n * @returns Parameter type lookup when present.\n * @example\n * ```typescript\n * const lookup = getParameterTypes(node);\n * ```\n */\nconst getParameterTypes = (\n  node: Rule.Node,\n): Map<string, TypeAnnotationNode> | undefined => {\n  const parameterTypes = getParameterTypeLookup(node);\n\n  return parameterTypes.size > 0 ? parameterTypes : void 0;\n};\n\n/**\n * Resolves the JSDoc comment data for a node.\n * @param sourceCode SourceCode wrapper.\n * @param node Node to inspect.\n * @returns JSDoc data when available.\n * @example\n * ```typescript\n * const data = getJsdocData(sourceCode, node);\n * ```\n */\nconst getJsdocData = (\n  sourceCode: Rule.RuleContext[\"sourceCode\"],\n  node: Rule.Node,\n):\n  | undefined\n  | {\n      /** Comment field value. */\n      comment: Comment;\n\n      /** CommentStart field value. */\n      commentStart: number;\n\n      /** Text field value. */\n      text: string;\n    } => {\n  const comment = getJsdocComment(sourceCode, node);\n\n  if (comment === void 0) {\n    return void 0;\n  }\n\n  const commentStart = comment.range?.[0];\n\n  if (typeof commentStart !== \"number\") {\n    return void 0;\n  }\n\n  const text = getCommentText(sourceCode, comment);\n\n  return { comment, commentStart, text };\n};\n\n/**\n * Resolves the member tag context for a node.\n * @param context Rule execution context.\n * @param node Node to inspect.\n * @returns Member tag context when available.\n * @example\n * ```typescript\n * const context = resolveMemberTagContext(context, node);\n * ```\n */\nconst resolveMemberTagContext = (\n  context: Rule.RuleContext,\n  node: Rule.Node,\n):\n  | undefined\n  | {\n      /** Comment field value. */\n      comment: Comment;\n\n      /** CommentStart field value. */\n      commentStart: number;\n\n      /** CommentText field value. */\n      commentText: string;\n\n      /** MemberTags field value. */\n      memberTags: ParameterMemberTag[];\n    } => {\n  const parameterTypes = getParameterTypes(node);\n  const jsdocData = getJsdocData(context.sourceCode, node);\n\n  if (parameterTypes === void 0 || jsdocData === void 0) {\n    return void 0;\n  }\n\n  const memberTags = collectMemberTags(jsdocData.text, parameterTypes);\n\n  return memberTags.length > 0\n    ? {\n        comment: jsdocData.comment,\n        commentStart: jsdocData.commentStart,\n        commentText: jsdocData.text,\n        memberTags,\n      }\n    : void 0;\n};\n\n/**\n * Handles function-like nodes for this rule.\n * @param context Rule execution context.\n * @param node Node to inspect.\n * @example\n * ```typescript\n * handleFunctionLike(context, node);\n * ```\n */\nconst handleFunctionLike = (\n  context: Rule.RuleContext,\n  node: Rule.Node,\n): void => {\n  const resolved = resolveMemberTagContext(context, node);\n\n  if (resolved === void 0) {\n    return;\n  }\n\n  reportMemberDocumentation(context, {\n    comment: resolved.comment,\n    commentStart: resolved.commentStart,\n    commentText: resolved.commentText,\n    memberTags: resolved.memberTags,\n    node,\n    sourceCode: context.sourceCode,\n  });\n};\n\n/** ESLint rule disallowing interface member documentation in `@param` tags. */\nconst noInterfaceMemberDocumentationRule: Rule.RuleModule = {\n  create(context: Rule.RuleContext): Rule.RuleListener {\n    const listener = (node: Rule.Node): void => {\n      handleFunctionLike(context, node);\n    };\n\n    return {\n      ArrowFunctionExpression: listener,\n      FunctionDeclaration: listener,\n      FunctionExpression: listener,\n      TSCallSignatureDeclaration: listener,\n      TSConstructSignatureDeclaration: listener,\n      TSDeclareFunction: listener,\n      TSFunctionType: listener,\n      TSMethodSignature: listener,\n    };\n  },\n  meta: {\n    docs: createRuleDocumentation(\n      \"no-interface-member-docs\",\n      \"Disallow documenting interface members in @param tags; document them on the interface instead.\",\n    ),\n    fixable: \"code\",\n    messages: {\n      interfaceMemberDoc:\n        \"Document interface members on the interface instead of using @param for {{parameterName}}.\",\n    },\n    schema: [],\n    type: \"problem\",\n  },\n};\n\nexport { noInterfaceMemberDocumentationRule };\n"]}
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import type { Rule } from "eslint";
|
|
2
|
+
/** Type definition for rule data. */
|
|
3
|
+
type Comment = ReturnType<Rule.RuleContext["sourceCode"]["getAllComments"]>[number];
|
|
4
|
+
/** Type definition for rule data. */
|
|
5
|
+
interface InterfaceSample {
|
|
6
|
+
/** Context field value. */
|
|
7
|
+
context: Rule.RuleContext;
|
|
8
|
+
/** Node field value. */
|
|
9
|
+
node: Rule.Node;
|
|
10
|
+
/** Reports field value. */
|
|
11
|
+
reports: ReportEntry[];
|
|
12
|
+
/** SourceText field value. */
|
|
13
|
+
sourceText: string;
|
|
14
|
+
}
|
|
15
|
+
/** Type definition for rule data. */
|
|
16
|
+
interface ReportEntry {
|
|
17
|
+
/** Fix helper value. */
|
|
18
|
+
fix?: null | Rule.ReportFixer | undefined;
|
|
19
|
+
/** MessageId helper value. */
|
|
20
|
+
messageId: string | undefined;
|
|
21
|
+
}
|
|
22
|
+
/** Type definition for rule data. */
|
|
23
|
+
interface RuleContextState {
|
|
24
|
+
/** Context field value. */
|
|
25
|
+
context: Rule.RuleContext;
|
|
26
|
+
/** Reports field value. */
|
|
27
|
+
reports: ReportEntry[];
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Creates a rule context state for the given source text.
|
|
31
|
+
* @param sourceText Source text to analyze.
|
|
32
|
+
* @param comments Comment nodes for the source.
|
|
33
|
+
* @returns Context state for tests.
|
|
34
|
+
* @example
|
|
35
|
+
* ```typescript
|
|
36
|
+
* const state = createContext("", []);
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
declare const createContext: (sourceText: string, comments: Comment[]) => RuleContextState;
|
|
40
|
+
/**
|
|
41
|
+
* Creates a JSDoc block comment for the given source text.
|
|
42
|
+
* @param commentValue Comment value without delimiters.
|
|
43
|
+
* @param sourceText Source text containing the comment.
|
|
44
|
+
* @returns Comment node for the source text.
|
|
45
|
+
* @example
|
|
46
|
+
* ```typescript
|
|
47
|
+
* const comment = createComment("*\n * ok\n ", "function demo() {}");
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
declare const createComment: (commentValue: string, sourceText: string) => Comment;
|
|
51
|
+
/**
|
|
52
|
+
* Creates a function node for the given source text.
|
|
53
|
+
* @param sourceText Source text containing the function.
|
|
54
|
+
* @param parameters Parameter nodes for the function.
|
|
55
|
+
* @returns Function declaration node.
|
|
56
|
+
* @example
|
|
57
|
+
* ```typescript
|
|
58
|
+
* const node = createFunctionNode("function demo() {}", []);
|
|
59
|
+
* ```
|
|
60
|
+
*/
|
|
61
|
+
declare const createFunctionNode: (sourceText: string, parameters: unknown[]) => Rule.Node;
|
|
62
|
+
/**
|
|
63
|
+
* Creates a parameter node with a type annotation.
|
|
64
|
+
* @param type Type annotation kind to assign.
|
|
65
|
+
* @returns Parameter node for tests.
|
|
66
|
+
* @example
|
|
67
|
+
* ```typescript
|
|
68
|
+
* const param = createParameter("TSTypeReference");
|
|
69
|
+
* ```
|
|
70
|
+
*/
|
|
71
|
+
declare const createParameter: (type: string) => unknown;
|
|
72
|
+
/**
|
|
73
|
+
* Runs the rule listener for a function declaration node.
|
|
74
|
+
* @param context Rule execution context.
|
|
75
|
+
* @param node Function node to inspect.
|
|
76
|
+
* @example
|
|
77
|
+
* ```typescript
|
|
78
|
+
* runFunctionListener(context, node);
|
|
79
|
+
* ```
|
|
80
|
+
*/
|
|
81
|
+
declare const runFunctionListener: (context: Rule.RuleContext, node: Rule.Node) => void;
|
|
82
|
+
/**
|
|
83
|
+
* Builds source text with a leading JSDoc comment.
|
|
84
|
+
* @param commentValue Comment value used in the source.
|
|
85
|
+
* @returns Source text containing the comment and function.
|
|
86
|
+
* @example
|
|
87
|
+
* ```typescript
|
|
88
|
+
* const text = buildSourceText("*\n * ok\n ");
|
|
89
|
+
* ```
|
|
90
|
+
*/
|
|
91
|
+
declare const buildSourceText: (commentValue: string) => string;
|
|
92
|
+
/**
|
|
93
|
+
* Creates a sample test fixture for interface member docs.
|
|
94
|
+
* @returns Sample context, node, and reports.
|
|
95
|
+
* @example
|
|
96
|
+
* ```typescript
|
|
97
|
+
* const sample = createInterfaceSample();
|
|
98
|
+
* ```
|
|
99
|
+
*/
|
|
100
|
+
declare const createInterfaceSample: () => InterfaceSample;
|
|
101
|
+
export { buildSourceText, createComment, createContext, createFunctionNode, createInterfaceSample, createParameter, runFunctionListener, };
|
|
102
|
+
export type { Comment };
|
|
103
|
+
//# sourceMappingURL=test-helpers.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"test-helpers.d.ts","sourceRoot":"","sources":["../../../src/docs/no-interface-member-docs/test-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAInC,qCAAqC;AACrC,KAAK,OAAO,GAAG,UAAU,CACvB,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,gBAAgB,CAAC,CACjD,CAAC,MAAM,CAAC,CAAC;AAEV,qCAAqC;AACrC,UAAU,eAAe;IACvB,2BAA2B;IAC3B,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC;IAE1B,wBAAwB;IACxB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;IAEhB,2BAA2B;IAC3B,OAAO,EAAE,WAAW,EAAE,CAAC;IAEvB,8BAA8B;IAC9B,UAAU,EAAE,MAAM,CAAC;CACpB;AAWD,qCAAqC;AACrC,UAAU,WAAW;IACnB,wBAAwB;IACxB,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;IAE1C,8BAA8B;IAC9B,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,qCAAqC;AACrC,UAAU,gBAAgB;IACxB,2BAA2B;IAC3B,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC;IAE1B,2BAA2B;IAC3B,OAAO,EAAE,WAAW,EAAE,CAAC;CACxB;AA+CD;;;;;;;;;GASG;AACH,QAAA,MAAM,aAAa,GACjB,YAAY,MAAM,EAClB,UAAU,OAAO,EAAE,KAClB,gBAKF,CAAC;AAEF;;;;;;;;;GASG;AACH,QAAA,MAAM,aAAa,GAAI,cAAc,MAAM,EAAE,YAAY,MAAM,KAAG,OAQjE,CAAC;AAEF;;;;;;;;;GASG;AACH,QAAA,MAAM,kBAAkB,GACtB,YAAY,MAAM,EAClB,YAAY,OAAO,EAAE,KACpB,IAAI,CAAC,IAKS,CAAC;AAElB;;;;;;;;GAQG;AACH,QAAA,MAAM,eAAe,GAAI,MAAM,MAAM,KAAG,OAMtC,CAAC;AAEH;;;;;;;;GAQG;AACH,QAAA,MAAM,mBAAmB,GACvB,SAAS,IAAI,CAAC,WAAW,EACzB,MAAM,IAAI,CAAC,IAAI,KACd,IAOF,CAAC;AAEF;;;;;;;;GAQG;AACH,QAAA,MAAM,eAAe,GAAI,cAAc,MAAM,KAAG,MAMlC,CAAC;AAEf;;;;;;;GAOG;AACH,QAAA,MAAM,qBAAqB,QAAO,eAmBjC,CAAC;AAEF,OAAO,EACL,eAAe,EACf,aAAa,EACb,aAAa,EACb,kBAAkB,EAClB,qBAAqB,EACrB,eAAe,EACf,mBAAmB,GACpB,CAAC;AACF,YAAY,EAAE,OAAO,EAAE,CAAC"}
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
import { noInterfaceMemberDocumentationRule } from "./rule";
|
|
2
|
+
/**
|
|
3
|
+
* Creates a SourceCode stub with the provided comments.
|
|
4
|
+
* @param text Source text to attach.
|
|
5
|
+
* @param comments Comment nodes to expose.
|
|
6
|
+
* @returns SourceCode stub for tests.
|
|
7
|
+
* @example
|
|
8
|
+
* ```typescript
|
|
9
|
+
* const sourceCode = createSourceCode("", []);
|
|
10
|
+
* ```
|
|
11
|
+
*/
|
|
12
|
+
const createSourceCode = (text, comments) => ({
|
|
13
|
+
getAllComments: () => comments,
|
|
14
|
+
text,
|
|
15
|
+
});
|
|
16
|
+
/**
|
|
17
|
+
* Builds a rule context for collecting reports.
|
|
18
|
+
* @param sourceCode SourceCode stub.
|
|
19
|
+
* @param reports Report sink.
|
|
20
|
+
* @returns Rule context that records reports.
|
|
21
|
+
* @example
|
|
22
|
+
* ```typescript
|
|
23
|
+
* const context = buildRuleContext(sourceCode, reports);
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
const buildRuleContext = (sourceCode, reports) => ({
|
|
27
|
+
id: "no-interface-member-docs",
|
|
28
|
+
options: [],
|
|
29
|
+
report: (descriptor) => {
|
|
30
|
+
const { fix, messageId } = descriptor;
|
|
31
|
+
const entry = { fix, messageId };
|
|
32
|
+
reports.push(entry);
|
|
33
|
+
},
|
|
34
|
+
sourceCode,
|
|
35
|
+
});
|
|
36
|
+
/**
|
|
37
|
+
* Creates a rule context state for the given source text.
|
|
38
|
+
* @param sourceText Source text to analyze.
|
|
39
|
+
* @param comments Comment nodes for the source.
|
|
40
|
+
* @returns Context state for tests.
|
|
41
|
+
* @example
|
|
42
|
+
* ```typescript
|
|
43
|
+
* const state = createContext("", []);
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
const createContext = (sourceText, comments) => {
|
|
47
|
+
const reports = [];
|
|
48
|
+
const sourceCode = createSourceCode(sourceText, comments);
|
|
49
|
+
return { context: buildRuleContext(sourceCode, reports), reports };
|
|
50
|
+
};
|
|
51
|
+
/**
|
|
52
|
+
* Creates a JSDoc block comment for the given source text.
|
|
53
|
+
* @param commentValue Comment value without delimiters.
|
|
54
|
+
* @param sourceText Source text containing the comment.
|
|
55
|
+
* @returns Comment node for the source text.
|
|
56
|
+
* @example
|
|
57
|
+
* ```typescript
|
|
58
|
+
* const comment = createComment("*\n * ok\n ", "function demo() {}");
|
|
59
|
+
* ```
|
|
60
|
+
*/
|
|
61
|
+
const createComment = (commentValue, sourceText) => {
|
|
62
|
+
const end = sourceText.indexOf("*/") + 2;
|
|
63
|
+
return {
|
|
64
|
+
range: [0, end],
|
|
65
|
+
type: "Block",
|
|
66
|
+
value: commentValue,
|
|
67
|
+
};
|
|
68
|
+
};
|
|
69
|
+
/**
|
|
70
|
+
* Creates a function node for the given source text.
|
|
71
|
+
* @param sourceText Source text containing the function.
|
|
72
|
+
* @param parameters Parameter nodes for the function.
|
|
73
|
+
* @returns Function declaration node.
|
|
74
|
+
* @example
|
|
75
|
+
* ```typescript
|
|
76
|
+
* const node = createFunctionNode("function demo() {}", []);
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
const createFunctionNode = (sourceText, parameters) => ({
|
|
80
|
+
params: parameters,
|
|
81
|
+
range: [sourceText.indexOf("function"), sourceText.length],
|
|
82
|
+
type: "FunctionDeclaration",
|
|
83
|
+
});
|
|
84
|
+
/**
|
|
85
|
+
* Creates a parameter node with a type annotation.
|
|
86
|
+
* @param type Type annotation kind to assign.
|
|
87
|
+
* @returns Parameter node for tests.
|
|
88
|
+
* @example
|
|
89
|
+
* ```typescript
|
|
90
|
+
* const param = createParameter("TSTypeReference");
|
|
91
|
+
* ```
|
|
92
|
+
*/
|
|
93
|
+
const createParameter = (type) => ({
|
|
94
|
+
name: "context",
|
|
95
|
+
type: "Identifier",
|
|
96
|
+
typeAnnotation: {
|
|
97
|
+
typeAnnotation: { type },
|
|
98
|
+
},
|
|
99
|
+
});
|
|
100
|
+
/**
|
|
101
|
+
* Runs the rule listener for a function declaration node.
|
|
102
|
+
* @param context Rule execution context.
|
|
103
|
+
* @param node Function node to inspect.
|
|
104
|
+
* @example
|
|
105
|
+
* ```typescript
|
|
106
|
+
* runFunctionListener(context, node);
|
|
107
|
+
* ```
|
|
108
|
+
*/
|
|
109
|
+
const runFunctionListener = (context, node) => {
|
|
110
|
+
const listeners = noInterfaceMemberDocumentationRule.create(context);
|
|
111
|
+
const listener = listeners.FunctionDeclaration;
|
|
112
|
+
listener?.(node);
|
|
113
|
+
};
|
|
114
|
+
/**
|
|
115
|
+
* Builds source text with a leading JSDoc comment.
|
|
116
|
+
* @param commentValue Comment value used in the source.
|
|
117
|
+
* @returns Source text containing the comment and function.
|
|
118
|
+
* @example
|
|
119
|
+
* ```typescript
|
|
120
|
+
* const text = buildSourceText("*\n * ok\n ");
|
|
121
|
+
* ```
|
|
122
|
+
*/
|
|
123
|
+
const buildSourceText = (commentValue) => [
|
|
124
|
+
"/**",
|
|
125
|
+
commentValue.trimEnd(),
|
|
126
|
+
"*/",
|
|
127
|
+
"function getLineMeta(context: LineMetaContext): void {}",
|
|
128
|
+
].join("\n");
|
|
129
|
+
/**
|
|
130
|
+
* Creates a sample test fixture for interface member docs.
|
|
131
|
+
* @returns Sample context, node, and reports.
|
|
132
|
+
* @example
|
|
133
|
+
* ```typescript
|
|
134
|
+
* const sample = createInterfaceSample();
|
|
135
|
+
* ```
|
|
136
|
+
*/
|
|
137
|
+
const createInterfaceSample = () => {
|
|
138
|
+
const commentValue = [
|
|
139
|
+
"*",
|
|
140
|
+
" * Compute line metadata from the raw comment value.",
|
|
141
|
+
" * @param context The metadata context.",
|
|
142
|
+
" * @param context.commentValue The full comment value.",
|
|
143
|
+
" * @param context.full The full matched example text.",
|
|
144
|
+
" * @param context.startOffset The match start offset.",
|
|
145
|
+
" * @returns The line metadata for the example.",
|
|
146
|
+
" ",
|
|
147
|
+
].join("\n");
|
|
148
|
+
const sourceText = buildSourceText(commentValue);
|
|
149
|
+
const comment = createComment(commentValue, sourceText);
|
|
150
|
+
const { context, reports } = createContext(sourceText, [comment]);
|
|
151
|
+
const node = createFunctionNode(sourceText, [
|
|
152
|
+
createParameter("TSTypeReference"),
|
|
153
|
+
]);
|
|
154
|
+
return { context, node, reports, sourceText };
|
|
155
|
+
};
|
|
156
|
+
export { buildSourceText, createComment, createContext, createFunctionNode, createInterfaceSample, createParameter, runFunctionListener, };
|
|
157
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"test-helpers.js","sourceRoot":"","sources":["../../../src/docs/no-interface-member-docs/test-helpers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kCAAkC,EAAE,MAAM,QAAQ,CAAC;AAiD5D;;;;;;;;;GASG;AACH,MAAM,gBAAgB,GAAG,CACvB,IAAY,EACZ,QAAmB,EACa,EAAE,CAClC,CAAC;IACC,cAAc,EAAE,GAAc,EAAE,CAAC,QAAQ;IACzC,IAAI;CACL,CAAmC,CAAC;AAEvC;;;;;;;;;GASG;AACH,MAAM,gBAAgB,GAAG,CACvB,UAA0C,EAC1C,OAAsB,EACJ,EAAE,CACpB,CAAC;IACC,EAAE,EAAE,0BAA0B;IAC9B,OAAO,EAAE,EAAE;IACX,MAAM,EAAE,CAAC,UAAiC,EAAQ,EAAE;QAClD,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,UAAqC,CAAC;QACjE,MAAM,KAAK,GAAgB,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;QAE9C,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtB,CAAC;IACD,UAAU;CACX,CAAgC,CAAC;AAEpC;;;;;;;;;GASG;AACH,MAAM,aAAa,GAAG,CACpB,UAAkB,EAClB,QAAmB,EACD,EAAE;IACpB,MAAM,OAAO,GAAkB,EAAE,CAAC;IAClC,MAAM,UAAU,GAAG,gBAAgB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAE1D,OAAO,EAAE,OAAO,EAAE,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;AACrE,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,aAAa,GAAG,CAAC,YAAoB,EAAE,UAAkB,EAAW,EAAE;IAC1E,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEzC,OAAO;QACL,KAAK,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC;QACf,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,YAAY;KACT,CAAC;AACf,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,kBAAkB,GAAG,CACzB,UAAkB,EAClB,UAAqB,EACV,EAAE,CACb,CAAC;IACC,MAAM,EAAE,UAAU;IAClB,KAAK,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAC1D,IAAI,EAAE,qBAAqB;CAC5B,CAAc,CAAC;AAElB;;;;;;;;GAQG;AACH,MAAM,eAAe,GAAG,CAAC,IAAY,EAAW,EAAE,CAAC,CAAC;IAClD,IAAI,EAAE,SAAS;IACf,IAAI,EAAE,YAAY;IAClB,cAAc,EAAE;QACd,cAAc,EAAE,EAAE,IAAI,EAAE;KACzB;CACF,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,mBAAmB,GAAG,CAC1B,OAAyB,EACzB,IAAe,EACT,EAAE;IACR,MAAM,SAAS,GAAG,kCAAkC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACrE,MAAM,QAAQ,GAAG,SAAS,CAAC,mBAEd,CAAC;IAEd,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC;AACnB,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,eAAe,GAAG,CAAC,YAAoB,EAAU,EAAE,CACvD;IACE,KAAK;IACL,YAAY,CAAC,OAAO,EAAE;IACtB,IAAI;IACJ,yDAAyD;CAC1D,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEf;;;;;;;GAOG;AACH,MAAM,qBAAqB,GAAG,GAAoB,EAAE;IAClD,MAAM,YAAY,GAAG;QACnB,GAAG;QACH,sDAAsD;QACtD,yCAAyC;QACzC,wDAAwD;QACxD,uDAAuD;QACvD,uDAAuD;QACvD,gDAAgD;QAChD,GAAG;KACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACb,MAAM,UAAU,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;IACjD,MAAM,OAAO,GAAG,aAAa,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IACxD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,aAAa,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAClE,MAAM,IAAI,GAAG,kBAAkB,CAAC,UAAU,EAAE;QAC1C,eAAe,CAAC,iBAAiB,CAAC;KACnC,CAAC,CAAC;IAEH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AAChD,CAAC,CAAC;AAEF,OAAO,EACL,eAAe,EACf,aAAa,EACb,aAAa,EACb,kBAAkB,EAClB,qBAAqB,EACrB,eAAe,EACf,mBAAmB,GACpB,CAAC","sourcesContent":["import type { Rule } from \"eslint\";\n\nimport { noInterfaceMemberDocumentationRule } from \"./rule\";\n\n/** Type definition for rule data. */\ntype Comment = ReturnType<\n  Rule.RuleContext[\"sourceCode\"][\"getAllComments\"]\n>[number];\n\n/** Type definition for rule data. */\ninterface InterfaceSample {\n  /** Context field value. */\n  context: Rule.RuleContext;\n\n  /** Node field value. */\n  node: Rule.Node;\n\n  /** Reports field value. */\n  reports: ReportEntry[];\n\n  /** SourceText field value. */\n  sourceText: string;\n}\n\n/** Type definition for rule data. */\ninterface ReportDescriptorDetails {\n  /** Fix field value. */\n  fix?: null | Rule.ReportFixer | undefined;\n\n  /** MessageId field value. */\n  messageId?: string;\n}\n\n/** Type definition for rule data. */\ninterface ReportEntry {\n  /** Fix helper value. */\n  fix?: null | Rule.ReportFixer | undefined;\n\n  /** MessageId helper value. */\n  messageId: string | undefined;\n}\n\n/** Type definition for rule data. */\ninterface RuleContextState {\n  /** Context field value. */\n  context: Rule.RuleContext;\n\n  /** Reports field value. */\n  reports: ReportEntry[];\n}\n\n/**\n * Creates a SourceCode stub with the provided comments.\n * @param text Source text to attach.\n * @param comments Comment nodes to expose.\n * @returns SourceCode stub for tests.\n * @example\n * ```typescript\n * const sourceCode = createSourceCode(\"\", []);\n * ```\n */\nconst createSourceCode = (\n  text: string,\n  comments: Comment[],\n): Rule.RuleContext[\"sourceCode\"] =>\n  ({\n    getAllComments: (): Comment[] => comments,\n    text,\n  }) as Rule.RuleContext[\"sourceCode\"];\n\n/**\n * Builds a rule context for collecting reports.\n * @param sourceCode SourceCode stub.\n * @param reports Report sink.\n * @returns Rule context that records reports.\n * @example\n * ```typescript\n * const context = buildRuleContext(sourceCode, reports);\n * ```\n */\nconst buildRuleContext = (\n  sourceCode: Rule.RuleContext[\"sourceCode\"],\n  reports: ReportEntry[],\n): Rule.RuleContext =>\n  ({\n    id: \"no-interface-member-docs\",\n    options: [],\n    report: (descriptor: Rule.ReportDescriptor): void => {\n      const { fix, messageId } = descriptor as ReportDescriptorDetails;\n      const entry: ReportEntry = { fix, messageId };\n\n      reports.push(entry);\n    },\n    sourceCode,\n  }) as unknown as Rule.RuleContext;\n\n/**\n * Creates a rule context state for the given source text.\n * @param sourceText Source text to analyze.\n * @param comments Comment nodes for the source.\n * @returns Context state for tests.\n * @example\n * ```typescript\n * const state = createContext(\"\", []);\n * ```\n */\nconst createContext = (\n  sourceText: string,\n  comments: Comment[],\n): RuleContextState => {\n  const reports: ReportEntry[] = [];\n  const sourceCode = createSourceCode(sourceText, comments);\n\n  return { context: buildRuleContext(sourceCode, reports), reports };\n};\n\n/**\n * Creates a JSDoc block comment for the given source text.\n * @param commentValue Comment value without delimiters.\n * @param sourceText Source text containing the comment.\n * @returns Comment node for the source text.\n * @example\n * ```typescript\n * const comment = createComment(\"*\\n * ok\\n \", \"function demo() {}\");\n * ```\n */\nconst createComment = (commentValue: string, sourceText: string): Comment => {\n  const end = sourceText.indexOf(\"*/\") + 2;\n\n  return {\n    range: [0, end],\n    type: \"Block\",\n    value: commentValue,\n  } as Comment;\n};\n\n/**\n * Creates a function node for the given source text.\n * @param sourceText Source text containing the function.\n * @param parameters Parameter nodes for the function.\n * @returns Function declaration node.\n * @example\n * ```typescript\n * const node = createFunctionNode(\"function demo() {}\", []);\n * ```\n */\nconst createFunctionNode = (\n  sourceText: string,\n  parameters: unknown[],\n): Rule.Node =>\n  ({\n    params: parameters,\n    range: [sourceText.indexOf(\"function\"), sourceText.length],\n    type: \"FunctionDeclaration\",\n  }) as Rule.Node;\n\n/**\n * Creates a parameter node with a type annotation.\n * @param type Type annotation kind to assign.\n * @returns Parameter node for tests.\n * @example\n * ```typescript\n * const param = createParameter(\"TSTypeReference\");\n * ```\n */\nconst createParameter = (type: string): unknown => ({\n  name: \"context\",\n  type: \"Identifier\",\n  typeAnnotation: {\n    typeAnnotation: { type },\n  },\n});\n\n/**\n * Runs the rule listener for a function declaration node.\n * @param context Rule execution context.\n * @param node Function node to inspect.\n * @example\n * ```typescript\n * runFunctionListener(context, node);\n * ```\n */\nconst runFunctionListener = (\n  context: Rule.RuleContext,\n  node: Rule.Node,\n): void => {\n  const listeners = noInterfaceMemberDocumentationRule.create(context);\n  const listener = listeners.FunctionDeclaration as\n    | ((node: Rule.Node) => void)\n    | undefined;\n\n  listener?.(node);\n};\n\n/**\n * Builds source text with a leading JSDoc comment.\n * @param commentValue Comment value used in the source.\n * @returns Source text containing the comment and function.\n * @example\n * ```typescript\n * const text = buildSourceText(\"*\\n * ok\\n \");\n * ```\n */\nconst buildSourceText = (commentValue: string): string =>\n  [\n    \"/**\",\n    commentValue.trimEnd(),\n    \"*/\",\n    \"function getLineMeta(context: LineMetaContext): void {}\",\n  ].join(\"\\n\");\n\n/**\n * Creates a sample test fixture for interface member docs.\n * @returns Sample context, node, and reports.\n * @example\n * ```typescript\n * const sample = createInterfaceSample();\n * ```\n */\nconst createInterfaceSample = (): InterfaceSample => {\n  const commentValue = [\n    \"*\",\n    \" * Compute line metadata from the raw comment value.\",\n    \" * @param context The metadata context.\",\n    \" * @param context.commentValue The full comment value.\",\n    \" * @param context.full The full matched example text.\",\n    \" * @param context.startOffset The match start offset.\",\n    \" * @returns The line metadata for the example.\",\n    \" \",\n  ].join(\"\\n\");\n  const sourceText = buildSourceText(commentValue);\n  const comment = createComment(commentValue, sourceText);\n  const { context, reports } = createContext(sourceText, [comment]);\n  const node = createFunctionNode(sourceText, [\n    createParameter(\"TSTypeReference\"),\n  ]);\n\n  return { context, node, reports, sourceText };\n};\n\nexport {\n  buildSourceText,\n  createComment,\n  createContext,\n  createFunctionNode,\n  createInterfaceSample,\n  createParameter,\n  runFunctionListener,\n};\nexport type { Comment };\n"]}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type { Rule } from "eslint";
|
|
2
|
+
/** Type definition for rule data. */
|
|
3
|
+
type Comment = ReturnType<Rule.RuleContext["sourceCode"]["getAllComments"]>[number];
|
|
4
|
+
/** Type definition for rule data. */
|
|
5
|
+
interface CommentLine {
|
|
6
|
+
/** End field value. */
|
|
7
|
+
end: number;
|
|
8
|
+
/** LineBreakLength field value. */
|
|
9
|
+
lineBreakLength: number;
|
|
10
|
+
/** Start field value. */
|
|
11
|
+
start: number;
|
|
12
|
+
/** Text field value. */
|
|
13
|
+
text: string;
|
|
14
|
+
}
|
|
15
|
+
/** Type definition for rule data. */
|
|
16
|
+
interface ParameterMemberTag {
|
|
17
|
+
/** BaseName field value. */
|
|
18
|
+
baseName: string;
|
|
19
|
+
/** FullName field value. */
|
|
20
|
+
fullName: string;
|
|
21
|
+
/** Line field value. */
|
|
22
|
+
line: CommentLine;
|
|
23
|
+
}
|
|
24
|
+
/** Type definition for rule data. */
|
|
25
|
+
interface TypeAnnotationNode {
|
|
26
|
+
/** Type field value. */
|
|
27
|
+
type: string;
|
|
28
|
+
}
|
|
29
|
+
export type { Comment, CommentLine, ParameterMemberTag, TypeAnnotationNode };
|
|
30
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/docs/no-interface-member-docs/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,qCAAqC;AACrC,KAAK,OAAO,GAAG,UAAU,CACvB,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,gBAAgB,CAAC,CACjD,CAAC,MAAM,CAAC,CAAC;AAEV,qCAAqC;AACrC,UAAU,WAAW;IACnB,uBAAuB;IACvB,GAAG,EAAE,MAAM,CAAC;IAEZ,mCAAmC;IACnC,eAAe,EAAE,MAAM,CAAC;IAExB,yBAAyB;IACzB,KAAK,EAAE,MAAM,CAAC;IAEd,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,qCAAqC;AACrC,UAAU,kBAAkB;IAC1B,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IAEjB,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IAEjB,wBAAwB;IACxB,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,qCAAqC;AACrC,UAAU,kBAAkB;IAC1B,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,CAAC"}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
export {};
|
|
2
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvZG9jcy9uby1pbnRlcmZhY2UtbWVtYmVyLWRvY3MvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB0eXBlIHsgUnVsZSB9IGZyb20gXCJlc2xpbnRcIjtcblxuLyoqIFR5cGUgZGVmaW5pdGlvbiBmb3IgcnVsZSBkYXRhLiAqL1xudHlwZSBDb21tZW50ID0gUmV0dXJuVHlwZTxcbiAgUnVsZS5SdWxlQ29udGV4dFtcInNvdXJjZUNvZGVcIl1bXCJnZXRBbGxDb21tZW50c1wiXVxuPltudW1iZXJdO1xuXG4vKiogVHlwZSBkZWZpbml0aW9uIGZvciBydWxlIGRhdGEuICovXG5pbnRlcmZhY2UgQ29tbWVudExpbmUge1xuICAvKiogRW5kIGZpZWxkIHZhbHVlLiAqL1xuICBlbmQ6IG51bWJlcjtcblxuICAvKiogTGluZUJyZWFrTGVuZ3RoIGZpZWxkIHZhbHVlLiAqL1xuICBsaW5lQnJlYWtMZW5ndGg6IG51bWJlcjtcblxuICAvKiogU3RhcnQgZmllbGQgdmFsdWUuICovXG4gIHN0YXJ0OiBudW1iZXI7XG5cbiAgLyoqIFRleHQgZmllbGQgdmFsdWUuICovXG4gIHRleHQ6IHN0cmluZztcbn1cblxuLyoqIFR5cGUgZGVmaW5pdGlvbiBmb3IgcnVsZSBkYXRhLiAqL1xuaW50ZXJmYWNlIFBhcmFtZXRlck1lbWJlclRhZyB7XG4gIC8qKiBCYXNlTmFtZSBmaWVsZCB2YWx1ZS4gKi9cbiAgYmFzZU5hbWU6IHN0cmluZztcblxuICAvKiogRnVsbE5hbWUgZmllbGQgdmFsdWUuICovXG4gIGZ1bGxOYW1lOiBzdHJpbmc7XG5cbiAgLyoqIExpbmUgZmllbGQgdmFsdWUuICovXG4gIGxpbmU6IENvbW1lbnRMaW5lO1xufVxuXG4vKiogVHlwZSBkZWZpbml0aW9uIGZvciBydWxlIGRhdGEuICovXG5pbnRlcmZhY2UgVHlwZUFubm90YXRpb25Ob2RlIHtcbiAgLyoqIFR5cGUgZmllbGQgdmFsdWUuICovXG4gIHR5cGU6IHN0cmluZztcbn1cblxuZXhwb3J0IHR5cGUgeyBDb21tZW50LCBDb21tZW50TGluZSwgUGFyYW1ldGVyTWVtYmVyVGFnLCBUeXBlQW5ub3RhdGlvbk5vZGUgfTtcbiJdfQ==
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/** Type definition for rule data. */
|
|
2
|
+
interface FenceLineInfo {
|
|
3
|
+
/** Language field value. */
|
|
4
|
+
language: string;
|
|
5
|
+
/** Leading field value. */
|
|
6
|
+
leading: string;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Parses a fence line for its leading prefix and language.
|
|
10
|
+
* @param line Fence line to parse.
|
|
11
|
+
* @returns Parsed fence info when matched.
|
|
12
|
+
* @example
|
|
13
|
+
* ```typescript
|
|
14
|
+
* const info = parseFenceLine(" * ```typescript");
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
17
|
+
declare function parseFenceLine(line: string): FenceLineInfo | undefined;
|
|
18
|
+
/**
|
|
19
|
+
* Removes fenced blocks that contain no content.
|
|
20
|
+
* @param original Original comment text.
|
|
21
|
+
* @returns Updated comment text when a fence is removed.
|
|
22
|
+
* @example
|
|
23
|
+
* ```typescript
|
|
24
|
+
* const updated = removeEmptyFences("* ```typescript\n* ```\n* ok");
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
declare function removeEmptyFences(original: string): string | undefined;
|
|
28
|
+
export { parseFenceLine, removeEmptyFences };
|
|
29
|
+
//# sourceMappingURL=empty-fence-fixes.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"empty-fence-fixes.d.ts","sourceRoot":"","sources":["../../../src/docs/require-example-language/empty-fence-fixes.ts"],"names":[],"mappings":"AAqBA,qCAAqC;AACrC,UAAU,aAAa;IACrB,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IAEjB,2BAA2B;IAC3B,OAAO,EAAE,MAAM,CAAC;CACjB;AAuFD;;;;;;;;GAQG;AACH,iBAAS,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAe/D;AAED;;;;;;;;GAQG;AACH,iBAAS,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CA0B/D;AAgDD,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,CAAC"}
|