@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,146 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Checks isJsdocComment.
|
|
3
|
+
* @param comment Input comment value.
|
|
4
|
+
* @returns Return value output.
|
|
5
|
+
* @example
|
|
6
|
+
* ```typescript
|
|
7
|
+
* isJsdocComment();
|
|
8
|
+
* ```
|
|
9
|
+
*/
|
|
10
|
+
const isJsdocComment = (comment) => comment.type === "Block" && comment.value.startsWith("*");
|
|
11
|
+
/**
|
|
12
|
+
* Gets getCommentEnd.
|
|
13
|
+
* @param comment Input comment value.
|
|
14
|
+
* @returns Return value output.
|
|
15
|
+
* @example
|
|
16
|
+
* ```typescript
|
|
17
|
+
* getCommentEnd();
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
const getCommentEnd = (comment) => {
|
|
21
|
+
const commentEnd = comment.range?.[1];
|
|
22
|
+
return typeof commentEnd === "number" ? commentEnd : void 0;
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* Finds the closest JSDoc comment before a node.
|
|
26
|
+
* @param comments Comment list to search.
|
|
27
|
+
* @param nodeStart Start offset of the node.
|
|
28
|
+
* @returns The closest JSDoc comment when present.
|
|
29
|
+
* @example
|
|
30
|
+
* ```typescript
|
|
31
|
+
* const comment = findClosestComment(comments, nodeStart);
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
const findClosestComment = (comments, nodeStart) => {
|
|
35
|
+
let closest = void 0;
|
|
36
|
+
let closestEnd = -1;
|
|
37
|
+
for (const comment of comments) {
|
|
38
|
+
const commentEnd = getCommentEnd(comment);
|
|
39
|
+
const shouldConsider = isJsdocComment(comment) && commentEnd !== void 0;
|
|
40
|
+
if (shouldConsider && commentEnd <= nodeStart && commentEnd > closestEnd) {
|
|
41
|
+
closest = comment;
|
|
42
|
+
closestEnd = commentEnd;
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
return closest;
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* Gets the closest JSDoc comment for a node.
|
|
49
|
+
* @param sourceCode Source code wrapper.
|
|
50
|
+
* @param node Node to inspect.
|
|
51
|
+
* @returns The closest JSDoc comment when present.
|
|
52
|
+
* @example
|
|
53
|
+
* ```typescript
|
|
54
|
+
* const comment = getJsdocComment(sourceCode, node);
|
|
55
|
+
* ```
|
|
56
|
+
*/
|
|
57
|
+
const getJsdocComment = (sourceCode, node) => {
|
|
58
|
+
const comments = sourceCode.getAllComments();
|
|
59
|
+
const nodeStart = node.range?.[0];
|
|
60
|
+
if (comments.length === 0 || typeof nodeStart !== "number") {
|
|
61
|
+
return void 0;
|
|
62
|
+
}
|
|
63
|
+
return findClosestComment(comments, nodeStart);
|
|
64
|
+
};
|
|
65
|
+
/**
|
|
66
|
+
* Extracts the full text for a comment range.
|
|
67
|
+
* @param sourceCode Source code wrapper.
|
|
68
|
+
* @param comment Comment to read.
|
|
69
|
+
* @returns Comment contents from the source.
|
|
70
|
+
* @example
|
|
71
|
+
* ```typescript
|
|
72
|
+
* const text = getCommentText(sourceCode, comment);
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
const getCommentText = (sourceCode, comment) => {
|
|
76
|
+
const start = comment.range?.[0];
|
|
77
|
+
const end = comment.range?.[1];
|
|
78
|
+
if (typeof start !== "number" || typeof end !== "number") {
|
|
79
|
+
return "";
|
|
80
|
+
}
|
|
81
|
+
return sourceCode.text.slice(start, end);
|
|
82
|
+
};
|
|
83
|
+
/**
|
|
84
|
+
* Gets getCommentLines.
|
|
85
|
+
* @param commentText Input commentText value.
|
|
86
|
+
* @returns Return value output.
|
|
87
|
+
* @example
|
|
88
|
+
* ```typescript
|
|
89
|
+
* getCommentLines();
|
|
90
|
+
* ```
|
|
91
|
+
*/
|
|
92
|
+
const getCommentLines = (commentText) => {
|
|
93
|
+
const lines = commentText.split(/\r?\n/u);
|
|
94
|
+
const results = [];
|
|
95
|
+
let offset = 0;
|
|
96
|
+
for (const line of lines) {
|
|
97
|
+
const lineEnd = offset + line.length;
|
|
98
|
+
const nextSlice = commentText.slice(lineEnd, lineEnd + 2);
|
|
99
|
+
const lineBreakLength = nextSlice.startsWith("\r\n")
|
|
100
|
+
? 2
|
|
101
|
+
: nextSlice.startsWith("\n")
|
|
102
|
+
? 1
|
|
103
|
+
: 0;
|
|
104
|
+
results.push({
|
|
105
|
+
end: lineEnd,
|
|
106
|
+
lineBreakLength,
|
|
107
|
+
start: offset,
|
|
108
|
+
text: line,
|
|
109
|
+
});
|
|
110
|
+
offset = lineEnd + lineBreakLength;
|
|
111
|
+
}
|
|
112
|
+
return results;
|
|
113
|
+
};
|
|
114
|
+
/**
|
|
115
|
+
* Builds a removal range for the specified comment line.
|
|
116
|
+
* @param commentStart Comment start offset in the source.
|
|
117
|
+
* @param commentText Full comment text.
|
|
118
|
+
* @param line Line metadata for the comment.
|
|
119
|
+
* @returns The range to remove.
|
|
120
|
+
* @example
|
|
121
|
+
* ```typescript
|
|
122
|
+
* const range = buildRemovalRange(0, commentText, line);
|
|
123
|
+
* ```
|
|
124
|
+
*/
|
|
125
|
+
const buildRemovalRange = (commentStart, commentText, line) => {
|
|
126
|
+
if (line.lineBreakLength > 0) {
|
|
127
|
+
return [
|
|
128
|
+
commentStart + line.start,
|
|
129
|
+
commentStart + line.end + line.lineBreakLength,
|
|
130
|
+
];
|
|
131
|
+
}
|
|
132
|
+
if (line.start > 0) {
|
|
133
|
+
const previousChar = commentText[line.start - 1];
|
|
134
|
+
const previousIsLineBreak = previousChar === "\n";
|
|
135
|
+
if (previousIsLineBreak) {
|
|
136
|
+
const lineBreakLength = line.start > 1 && commentText[line.start - 2] === "\r" ? 2 : 1;
|
|
137
|
+
return [
|
|
138
|
+
commentStart + line.start - lineBreakLength,
|
|
139
|
+
commentStart + line.end,
|
|
140
|
+
];
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
return [commentStart + line.start, commentStart + line.end];
|
|
144
|
+
};
|
|
145
|
+
export { buildRemovalRange, getCommentLines, getCommentText, getJsdocComment };
|
|
146
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"comment-utilities.js","sourceRoot":"","sources":["../../../src/docs/no-interface-member-docs/comment-utilities.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,MAAM,cAAc,GAAG,CAAC,OAAgB,EAAW,EAAE,CACnD,OAAO,CAAC,IAAI,KAAK,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AAE5D;;;;;;;;GAQG;AACH,MAAM,aAAa,GAAG,CAAC,OAAgB,EAAsB,EAAE;IAC7D,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IAEtC,OAAO,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAC9D,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,kBAAkB,GAAG,CACzB,QAAmB,EACnB,SAAiB,EACI,EAAE;IACvB,IAAI,OAAO,GAAwB,KAAK,CAAC,CAAC;IAC1C,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC;IAEpB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,UAAU,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;QAC1C,MAAM,cAAc,GAAG,cAAc,CAAC,OAAO,CAAC,IAAI,UAAU,KAAK,KAAK,CAAC,CAAC;QAExE,IAAI,cAAc,IAAI,UAAU,IAAI,SAAS,IAAI,UAAU,GAAG,UAAU,EAAE,CAAC;YACzE,OAAO,GAAG,OAAO,CAAC;YAClB,UAAU,GAAG,UAAU,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,eAAe,GAAG,CACtB,UAA0C,EAC1C,IAAe,EACM,EAAE;IACvB,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,EAAE,CAAC;IAC7C,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IAElC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC3D,OAAO,KAAK,CAAC,CAAC;IAChB,CAAC;IAED,OAAO,kBAAkB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,cAAc,GAAG,CACrB,UAA0C,EAC1C,OAAgB,EACR,EAAE;IACV,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IAE/B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACzD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,eAAe,GAAG,CAAC,WAAmB,EAAiB,EAAE;IAC7D,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,OAAO,GAAkB,EAAE,CAAC;IAClC,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACrC,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC;QAC1D,MAAM,eAAe,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC;YAClD,CAAC,CAAC,CAAC;YACH,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC;gBAC1B,CAAC,CAAC,CAAC;gBACH,CAAC,CAAC,CAAC,CAAC;QAER,OAAO,CAAC,IAAI,CAAC;YACX,GAAG,EAAE,OAAO;YACZ,eAAe;YACf,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,IAAI;SACX,CAAC,CAAC;QAEH,MAAM,GAAG,OAAO,GAAG,eAAe,CAAC;IACrC,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,iBAAiB,GAAG,CACxB,YAAoB,EACpB,WAAmB,EACnB,IAAiB,EACC,EAAE;IACpB,IAAI,IAAI,CAAC,eAAe,GAAG,CAAC,EAAE,CAAC;QAC7B,OAAO;YACL,YAAY,GAAG,IAAI,CAAC,KAAK;YACzB,YAAY,GAAG,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,eAAe;SAC/C,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;QACnB,MAAM,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QACjD,MAAM,mBAAmB,GAAG,YAAY,KAAK,IAAI,CAAC;QAElD,IAAI,mBAAmB,EAAE,CAAC;YACxB,MAAM,eAAe,GACnB,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACjE,OAAO;gBACL,YAAY,GAAG,IAAI,CAAC,KAAK,GAAG,eAAe;gBAC3C,YAAY,GAAG,IAAI,CAAC,GAAG;aACxB,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;AAC9D,CAAC,CAAC;AAEF,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,cAAc,EAAE,eAAe,EAAE,CAAC","sourcesContent":["import type { Rule } from \"eslint\";\n\nimport type { Comment, CommentLine } from \"./types\";\n\n/**\n * Checks isJsdocComment.\n * @param comment Input comment value.\n * @returns Return value output.\n * @example\n * ```typescript\n * isJsdocComment();\n * ```\n */\nconst isJsdocComment = (comment: Comment): boolean =>\n  comment.type === \"Block\" && comment.value.startsWith(\"*\");\n\n/**\n * Gets getCommentEnd.\n * @param comment Input comment value.\n * @returns Return value output.\n * @example\n * ```typescript\n * getCommentEnd();\n * ```\n */\nconst getCommentEnd = (comment: Comment): number | undefined => {\n  const commentEnd = comment.range?.[1];\n\n  return typeof commentEnd === \"number\" ? commentEnd : void 0;\n};\n\n/**\n * Finds the closest JSDoc comment before a node.\n * @param comments Comment list to search.\n * @param nodeStart Start offset of the node.\n * @returns The closest JSDoc comment when present.\n * @example\n * ```typescript\n * const comment = findClosestComment(comments, nodeStart);\n * ```\n */\nconst findClosestComment = (\n  comments: Comment[],\n  nodeStart: number,\n): Comment | undefined => {\n  let closest: Comment | undefined = void 0;\n  let closestEnd = -1;\n\n  for (const comment of comments) {\n    const commentEnd = getCommentEnd(comment);\n    const shouldConsider = isJsdocComment(comment) && commentEnd !== void 0;\n\n    if (shouldConsider && commentEnd <= nodeStart && commentEnd > closestEnd) {\n      closest = comment;\n      closestEnd = commentEnd;\n    }\n  }\n\n  return closest;\n};\n\n/**\n * Gets the closest JSDoc comment for a node.\n * @param sourceCode Source code wrapper.\n * @param node Node to inspect.\n * @returns The closest JSDoc comment when present.\n * @example\n * ```typescript\n * const comment = getJsdocComment(sourceCode, node);\n * ```\n */\nconst getJsdocComment = (\n  sourceCode: Rule.RuleContext[\"sourceCode\"],\n  node: Rule.Node,\n): Comment | undefined => {\n  const comments = sourceCode.getAllComments();\n  const nodeStart = node.range?.[0];\n\n  if (comments.length === 0 || typeof nodeStart !== \"number\") {\n    return void 0;\n  }\n\n  return findClosestComment(comments, nodeStart);\n};\n\n/**\n * Extracts the full text for a comment range.\n * @param sourceCode Source code wrapper.\n * @param comment Comment to read.\n * @returns Comment contents from the source.\n * @example\n * ```typescript\n * const text = getCommentText(sourceCode, comment);\n * ```\n */\nconst getCommentText = (\n  sourceCode: Rule.RuleContext[\"sourceCode\"],\n  comment: Comment,\n): string => {\n  const start = comment.range?.[0];\n  const end = comment.range?.[1];\n\n  if (typeof start !== \"number\" || typeof end !== \"number\") {\n    return \"\";\n  }\n\n  return sourceCode.text.slice(start, end);\n};\n\n/**\n * Gets getCommentLines.\n * @param commentText Input commentText value.\n * @returns Return value output.\n * @example\n * ```typescript\n * getCommentLines();\n * ```\n */\nconst getCommentLines = (commentText: string): CommentLine[] => {\n  const lines = commentText.split(/\\r?\\n/u);\n  const results: CommentLine[] = [];\n  let offset = 0;\n\n  for (const line of lines) {\n    const lineEnd = offset + line.length;\n    const nextSlice = commentText.slice(lineEnd, lineEnd + 2);\n    const lineBreakLength = nextSlice.startsWith(\"\\r\\n\")\n      ? 2\n      : nextSlice.startsWith(\"\\n\")\n        ? 1\n        : 0;\n\n    results.push({\n      end: lineEnd,\n      lineBreakLength,\n      start: offset,\n      text: line,\n    });\n\n    offset = lineEnd + lineBreakLength;\n  }\n\n  return results;\n};\n\n/**\n * Builds a removal range for the specified comment line.\n * @param commentStart Comment start offset in the source.\n * @param commentText Full comment text.\n * @param line Line metadata for the comment.\n * @returns The range to remove.\n * @example\n * ```typescript\n * const range = buildRemovalRange(0, commentText, line);\n * ```\n */\nconst buildRemovalRange = (\n  commentStart: number,\n  commentText: string,\n  line: CommentLine,\n): [number, number] => {\n  if (line.lineBreakLength > 0) {\n    return [\n      commentStart + line.start,\n      commentStart + line.end + line.lineBreakLength,\n    ];\n  }\n\n  if (line.start > 0) {\n    const previousChar = commentText[line.start - 1];\n    const previousIsLineBreak = previousChar === \"\\n\";\n\n    if (previousIsLineBreak) {\n      const lineBreakLength =\n        line.start > 1 && commentText[line.start - 2] === \"\\r\" ? 2 : 1;\n      return [\n        commentStart + line.start - lineBreakLength,\n        commentStart + line.end,\n      ];\n    }\n  }\n\n  return [commentStart + line.start, commentStart + line.end];\n};\n\nexport { buildRemovalRange, getCommentLines, getCommentText, getJsdocComment };\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/docs/no-interface-member-docs/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kCAAkC,EAAE,MAAM,QAAQ,CAAC"}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
export { noInterfaceMemberDocumentationRule } from "./rule";
|
|
2
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvZG9jcy9uby1pbnRlcmZhY2UtbWVtYmVyLWRvY3MvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLGtDQUFrQyxFQUFFLE1BQU0sUUFBUSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IHsgbm9JbnRlcmZhY2VNZW1iZXJEb2N1bWVudGF0aW9uUnVsZSB9IGZyb20gXCIuL3J1bGVcIjtcbiJdfQ==
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { CommentLine, ParameterMemberTag } from "./types";
|
|
2
|
+
/**
|
|
3
|
+
* Parses a `@param` tag line into a member tag when applicable.
|
|
4
|
+
* @param line Comment line metadata.
|
|
5
|
+
* @returns Parsed parameter member tag when present.
|
|
6
|
+
* @example
|
|
7
|
+
* ```typescript
|
|
8
|
+
* const tag = parseParameterTagLine(line);
|
|
9
|
+
* ```
|
|
10
|
+
*/
|
|
11
|
+
declare const parseParameterTagLine: (line: CommentLine) => ParameterMemberTag | undefined;
|
|
12
|
+
export { parseParameterTagLine };
|
|
13
|
+
//# sourceMappingURL=parameter-tags.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parameter-tags.d.ts","sourceRoot":"","sources":["../../../src/docs/no-interface-member-docs/parameter-tags.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAoG/D;;;;;;;;GAQG;AACH,QAAA,MAAM,qBAAqB,GACzB,MAAM,WAAW,KAChB,kBAAkB,GAAG,SAmBvB,CAAC;AAEF,OAAO,EAAE,qBAAqB,EAAE,CAAC"}
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
/** Extracts the parameter name from an `@param` tag line. */
|
|
2
|
+
const parameterTagPattern = /@param\s+(?:\{[^}]*\}\s+)?(?<name>[^\s-]+)/u;
|
|
3
|
+
/**
|
|
4
|
+
* Defines stripJsdocLine.
|
|
5
|
+
* @param line Input line value.
|
|
6
|
+
* @returns Return value output.
|
|
7
|
+
* @example
|
|
8
|
+
* ```typescript
|
|
9
|
+
* stripJsdocLine();
|
|
10
|
+
* ```
|
|
11
|
+
*/
|
|
12
|
+
const stripJsdocLine = (line) => line.replace(/^\s*\/?\**\s?/u, "").trim();
|
|
13
|
+
/**
|
|
14
|
+
* Defines stripDefaultValue.
|
|
15
|
+
* @param rawName Input rawName value.
|
|
16
|
+
* @returns Return value output.
|
|
17
|
+
* @example
|
|
18
|
+
* ```typescript
|
|
19
|
+
* stripDefaultValue();
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
const stripDefaultValue = (rawName) => {
|
|
23
|
+
const [head = ""] = rawName.split("=");
|
|
24
|
+
return head;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* Normalizes normalizeParameterName.
|
|
28
|
+
* @param rawName Input rawName value.
|
|
29
|
+
* @returns Return value output.
|
|
30
|
+
* @example
|
|
31
|
+
* ```typescript
|
|
32
|
+
* normalizeParameterName();
|
|
33
|
+
* ```
|
|
34
|
+
*/
|
|
35
|
+
const normalizeParameterName = (rawName) => stripDefaultValue(rawName)
|
|
36
|
+
.replace(/^\[/u, "")
|
|
37
|
+
.replace(/\]$/u, "")
|
|
38
|
+
.replace(/\?$/u, "");
|
|
39
|
+
/**
|
|
40
|
+
* Gets getParameterName.
|
|
41
|
+
* @param content Input content value.
|
|
42
|
+
* @returns Return value output.
|
|
43
|
+
* @example
|
|
44
|
+
* ```typescript
|
|
45
|
+
* getParameterName();
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
const getParameterName = (content) => {
|
|
49
|
+
if (!content.startsWith("@param")) {
|
|
50
|
+
return void 0;
|
|
51
|
+
}
|
|
52
|
+
const match = parameterTagPattern.exec(content);
|
|
53
|
+
const rawName = match?.groups?.["name"] ?? "";
|
|
54
|
+
const normalized = normalizeParameterName(rawName);
|
|
55
|
+
return normalized.length > 0 ? normalized : void 0;
|
|
56
|
+
};
|
|
57
|
+
/**
|
|
58
|
+
* Extracts member path details from a normalized parameter name.
|
|
59
|
+
* @param normalized Normalized parameter name.
|
|
60
|
+
* @returns Member path details when available.
|
|
61
|
+
* @example
|
|
62
|
+
* ```typescript
|
|
63
|
+
* const member = getMemberName("props.title");
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
const getMemberName = (normalized) => {
|
|
67
|
+
const dotIndex = normalized.indexOf(".");
|
|
68
|
+
if (dotIndex <= 0) {
|
|
69
|
+
return void 0;
|
|
70
|
+
}
|
|
71
|
+
const baseName = normalized.slice(0, dotIndex);
|
|
72
|
+
const memberPath = normalized.slice(dotIndex + 1).trim();
|
|
73
|
+
return memberPath.length > 0 ? { baseName, memberPath } : void 0;
|
|
74
|
+
};
|
|
75
|
+
/**
|
|
76
|
+
* Parses a `@param` tag line into a member tag when applicable.
|
|
77
|
+
* @param line Comment line metadata.
|
|
78
|
+
* @returns Parsed parameter member tag when present.
|
|
79
|
+
* @example
|
|
80
|
+
* ```typescript
|
|
81
|
+
* const tag = parseParameterTagLine(line);
|
|
82
|
+
* ```
|
|
83
|
+
*/
|
|
84
|
+
const parseParameterTagLine = (line) => {
|
|
85
|
+
const content = stripJsdocLine(line.text);
|
|
86
|
+
const normalized = getParameterName(content);
|
|
87
|
+
if (normalized === void 0) {
|
|
88
|
+
return void 0;
|
|
89
|
+
}
|
|
90
|
+
const member = getMemberName(normalized);
|
|
91
|
+
if (member === void 0) {
|
|
92
|
+
return void 0;
|
|
93
|
+
}
|
|
94
|
+
return {
|
|
95
|
+
baseName: member.baseName,
|
|
96
|
+
fullName: normalized,
|
|
97
|
+
line,
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
export { parseParameterTagLine };
|
|
101
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGFyYW1ldGVyLXRhZ3MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvZG9jcy9uby1pbnRlcmZhY2UtbWVtYmVyLWRvY3MvcGFyYW1ldGVyLXRhZ3MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBRUEsNkRBQTZEO0FBQzdELE1BQU0sbUJBQW1CLEdBQUcsNkNBQTZDLENBQUM7QUFFMUU7Ozs7Ozs7O0dBUUc7QUFDSCxNQUFNLGNBQWMsR0FBRyxDQUFDLElBQVksRUFBVSxFQUFFLENBQzlDLElBQUksQ0FBQyxPQUFPLENBQUMsZ0JBQWdCLEVBQUUsRUFBRSxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUM7QUFFNUM7Ozs7Ozs7O0dBUUc7QUFDSCxNQUFNLGlCQUFpQixHQUFHLENBQUMsT0FBZSxFQUFVLEVBQUU7SUFDcEQsTUFBTSxDQUFDLElBQUksR0FBRyxFQUFFLENBQUMsR0FBRyxPQUFPLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBRXZDLE9BQU8sSUFBSSxDQUFDO0FBQ2QsQ0FBQyxDQUFDO0FBRUY7Ozs7Ozs7O0dBUUc7QUFDSCxNQUFNLHNCQUFzQixHQUFHLENBQUMsT0FBZSxFQUFVLEVBQUUsQ0FDekQsaUJBQWlCLENBQUMsT0FBTyxDQUFDO0tBQ3ZCLE9BQU8sQ0FBQyxNQUFNLEVBQUUsRUFBRSxDQUFDO0tBQ25CLE9BQU8sQ0FBQyxNQUFNLEVBQUUsRUFBRSxDQUFDO0tBQ25CLE9BQU8sQ0FBQyxNQUFNLEVBQUUsRUFBRSxDQUFDLENBQUM7QUFFekI7Ozs7Ozs7O0dBUUc7QUFDSCxNQUFNLGdCQUFnQixHQUFHLENBQUMsT0FBZSxFQUFzQixFQUFFO0lBQy9ELElBQUksQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQUM7UUFDbEMsT0FBTyxLQUFLLENBQUMsQ0FBQztJQUNoQixDQUFDO0lBRUQsTUFBTSxLQUFLLEdBQUcsbUJBQW1CLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQ2hELE1BQU0sT0FBTyxHQUFHLEtBQUssRUFBRSxNQUFNLEVBQUUsQ0FBQyxNQUFNLENBQUMsSUFBSSxFQUFFLENBQUM7SUFDOUMsTUFBTSxVQUFVLEdBQUcsc0JBQXNCLENBQUMsT0FBTyxDQUFDLENBQUM7SUFFbkQsT0FBTyxVQUFVLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQztBQUNyRCxDQUFDLENBQUM7QUFFRjs7Ozs7Ozs7R0FRRztBQUNILE1BQU0sYUFBYSxHQUFHLENBQ3BCLFVBQWtCLEVBU2QsRUFBRTtJQUNOLE1BQU0sUUFBUSxHQUFHLFVBQVUsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUM7SUFFekMsSUFBSSxRQUFRLElBQUksQ0FBQyxFQUFFLENBQUM7UUFDbEIsT0FBTyxLQUFLLENBQUMsQ0FBQztJQUNoQixDQUFDO0lBRUQsTUFBTSxRQUFRLEdBQUcsVUFBVSxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsUUFBUSxDQUFDLENBQUM7SUFDL0MsTUFBTSxVQUFVLEdBQUcsVUFBVSxDQUFDLEtBQUssQ0FBQyxRQUFRLEdBQUcsQ0FBQyxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUM7SUFFekQsT0FBTyxVQUFVLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsRUFBRSxRQUFRLEVBQUUsVUFBVSxFQUFFLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDO0FBQ25FLENBQUMsQ0FBQztBQUVGOzs7Ozs7OztHQVFHO0FBQ0gsTUFBTSxxQkFBcUIsR0FBRyxDQUM1QixJQUFpQixFQUNlLEVBQUU7SUFDbEMsTUFBTSxPQUFPLEdBQUcsY0FBYyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUMxQyxNQUFNLFVBQVUsR0FBRyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUU3QyxJQUFJLFVBQVUsS0FBSyxLQUFLLENBQUMsRUFBRSxDQUFDO1FBQzFCLE9BQU8sS0FBSyxDQUFDLENBQUM7SUFDaEIsQ0FBQztJQUVELE1BQU0sTUFBTSxHQUFHLGFBQWEsQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUV6QyxJQUFJLE1BQU0sS0FBSyxLQUFLLENBQUMsRUFBRSxDQUFDO1FBQ3RCLE9BQU8sS0FBSyxDQUFDLENBQUM7SUFDaEIsQ0FBQztJQUVELE9BQU87UUFDTCxRQUFRLEVBQUUsTUFBTSxDQUFDLFFBQVE7UUFDekIsUUFBUSxFQUFFLFVBQVU7UUFDcEIsSUFBSTtLQUNMLENBQUM7QUFDSixDQUFDLENBQUM7QUFFRixPQUFPLEVBQUUscUJBQXFCLEVBQUUsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB0eXBlIHsgQ29tbWVudExpbmUsIFBhcmFtZXRlck1lbWJlclRhZyB9IGZyb20gXCIuL3R5cGVzXCI7XG5cbi8qKiBFeHRyYWN0cyB0aGUgcGFyYW1ldGVyIG5hbWUgZnJvbSBhbiBgQHBhcmFtYCB0YWcgbGluZS4gKi9cbmNvbnN0IHBhcmFtZXRlclRhZ1BhdHRlcm4gPSAvQHBhcmFtXFxzKyg/Olxce1tefV0qXFx9XFxzKyk/KD88bmFtZT5bXlxccy1dKykvdTtcblxuLyoqXG4gKiBEZWZpbmVzIHN0cmlwSnNkb2NMaW5lLlxuICogQHBhcmFtIGxpbmUgSW5wdXQgbGluZSB2YWx1ZS5cbiAqIEByZXR1cm5zIFJldHVybiB2YWx1ZSBvdXRwdXQuXG4gKiBAZXhhbXBsZVxuICogYGBgdHlwZXNjcmlwdFxuICogc3RyaXBKc2RvY0xpbmUoKTtcbiAqIGBgYFxuICovXG5jb25zdCBzdHJpcEpzZG9jTGluZSA9IChsaW5lOiBzdHJpbmcpOiBzdHJpbmcgPT5cbiAgbGluZS5yZXBsYWNlKC9eXFxzKlxcLz9cXCoqXFxzPy91LCBcIlwiKS50cmltKCk7XG5cbi8qKlxuICogRGVmaW5lcyBzdHJpcERlZmF1bHRWYWx1ZS5cbiAqIEBwYXJhbSByYXdOYW1lIElucHV0IHJhd05hbWUgdmFsdWUuXG4gKiBAcmV0dXJucyBSZXR1cm4gdmFsdWUgb3V0cHV0LlxuICogQGV4YW1wbGVcbiAqIGBgYHR5cGVzY3JpcHRcbiAqIHN0cmlwRGVmYXVsdFZhbHVlKCk7XG4gKiBgYGBcbiAqL1xuY29uc3Qgc3RyaXBEZWZhdWx0VmFsdWUgPSAocmF3TmFtZTogc3RyaW5nKTogc3RyaW5nID0+IHtcbiAgY29uc3QgW2hlYWQgPSBcIlwiXSA9IHJhd05hbWUuc3BsaXQoXCI9XCIpO1xuXG4gIHJldHVybiBoZWFkO1xufTtcblxuLyoqXG4gKiBOb3JtYWxpemVzIG5vcm1hbGl6ZVBhcmFtZXRlck5hbWUuXG4gKiBAcGFyYW0gcmF3TmFtZSBJbnB1dCByYXdOYW1lIHZhbHVlLlxuICogQHJldHVybnMgUmV0dXJuIHZhbHVlIG91dHB1dC5cbiAqIEBleGFtcGxlXG4gKiBgYGB0eXBlc2NyaXB0XG4gKiBub3JtYWxpemVQYXJhbWV0ZXJOYW1lKCk7XG4gKiBgYGBcbiAqL1xuY29uc3Qgbm9ybWFsaXplUGFyYW1ldGVyTmFtZSA9IChyYXdOYW1lOiBzdHJpbmcpOiBzdHJpbmcgPT5cbiAgc3RyaXBEZWZhdWx0VmFsdWUocmF3TmFtZSlcbiAgICAucmVwbGFjZSgvXlxcWy91LCBcIlwiKVxuICAgIC5yZXBsYWNlKC9cXF0kL3UsIFwiXCIpXG4gICAgLnJlcGxhY2UoL1xcPyQvdSwgXCJcIik7XG5cbi8qKlxuICogR2V0cyBnZXRQYXJhbWV0ZXJOYW1lLlxuICogQHBhcmFtIGNvbnRlbnQgSW5wdXQgY29udGVudCB2YWx1ZS5cbiAqIEByZXR1cm5zIFJldHVybiB2YWx1ZSBvdXRwdXQuXG4gKiBAZXhhbXBsZVxuICogYGBgdHlwZXNjcmlwdFxuICogZ2V0UGFyYW1ldGVyTmFtZSgpO1xuICogYGBgXG4gKi9cbmNvbnN0IGdldFBhcmFtZXRlck5hbWUgPSAoY29udGVudDogc3RyaW5nKTogc3RyaW5nIHwgdW5kZWZpbmVkID0+IHtcbiAgaWYgKCFjb250ZW50LnN0YXJ0c1dpdGgoXCJAcGFyYW1cIikpIHtcbiAgICByZXR1cm4gdm9pZCAwO1xuICB9XG5cbiAgY29uc3QgbWF0Y2ggPSBwYXJhbWV0ZXJUYWdQYXR0ZXJuLmV4ZWMoY29udGVudCk7XG4gIGNvbnN0IHJhd05hbWUgPSBtYXRjaD8uZ3JvdXBzPy5bXCJuYW1lXCJdID8/IFwiXCI7XG4gIGNvbnN0IG5vcm1hbGl6ZWQgPSBub3JtYWxpemVQYXJhbWV0ZXJOYW1lKHJhd05hbWUpO1xuXG4gIHJldHVybiBub3JtYWxpemVkLmxlbmd0aCA+IDAgPyBub3JtYWxpemVkIDogdm9pZCAwO1xufTtcblxuLyoqXG4gKiBFeHRyYWN0cyBtZW1iZXIgcGF0aCBkZXRhaWxzIGZyb20gYSBub3JtYWxpemVkIHBhcmFtZXRlciBuYW1lLlxuICogQHBhcmFtIG5vcm1hbGl6ZWQgTm9ybWFsaXplZCBwYXJhbWV0ZXIgbmFtZS5cbiAqIEByZXR1cm5zIE1lbWJlciBwYXRoIGRldGFpbHMgd2hlbiBhdmFpbGFibGUuXG4gKiBAZXhhbXBsZVxuICogYGBgdHlwZXNjcmlwdFxuICogY29uc3QgbWVtYmVyID0gZ2V0TWVtYmVyTmFtZShcInByb3BzLnRpdGxlXCIpO1xuICogYGBgXG4gKi9cbmNvbnN0IGdldE1lbWJlck5hbWUgPSAoXG4gIG5vcm1hbGl6ZWQ6IHN0cmluZyxcbik6XG4gIHwgdW5kZWZpbmVkXG4gIHwge1xuICAgICAgLyoqIEJhc2VOYW1lIGZpZWxkIHZhbHVlLiAqL1xuICAgICAgYmFzZU5hbWU6IHN0cmluZztcblxuICAgICAgLyoqIE1lbWJlclBhdGggZmllbGQgdmFsdWUuICovXG4gICAgICBtZW1iZXJQYXRoOiBzdHJpbmc7XG4gICAgfSA9PiB7XG4gIGNvbnN0IGRvdEluZGV4ID0gbm9ybWFsaXplZC5pbmRleE9mKFwiLlwiKTtcblxuICBpZiAoZG90SW5kZXggPD0gMCkge1xuICAgIHJldHVybiB2b2lkIDA7XG4gIH1cblxuICBjb25zdCBiYXNlTmFtZSA9IG5vcm1hbGl6ZWQuc2xpY2UoMCwgZG90SW5kZXgpO1xuICBjb25zdCBtZW1iZXJQYXRoID0gbm9ybWFsaXplZC5zbGljZShkb3RJbmRleCArIDEpLnRyaW0oKTtcblxuICByZXR1cm4gbWVtYmVyUGF0aC5sZW5ndGggPiAwID8geyBiYXNlTmFtZSwgbWVtYmVyUGF0aCB9IDogdm9pZCAwO1xufTtcblxuLyoqXG4gKiBQYXJzZXMgYSBgQHBhcmFtYCB0YWcgbGluZSBpbnRvIGEgbWVtYmVyIHRhZyB3aGVuIGFwcGxpY2FibGUuXG4gKiBAcGFyYW0gbGluZSBDb21tZW50IGxpbmUgbWV0YWRhdGEuXG4gKiBAcmV0dXJucyBQYXJzZWQgcGFyYW1ldGVyIG1lbWJlciB0YWcgd2hlbiBwcmVzZW50LlxuICogQGV4YW1wbGVcbiAqIGBgYHR5cGVzY3JpcHRcbiAqIGNvbnN0IHRhZyA9IHBhcnNlUGFyYW1ldGVyVGFnTGluZShsaW5lKTtcbiAqIGBgYFxuICovXG5jb25zdCBwYXJzZVBhcmFtZXRlclRhZ0xpbmUgPSAoXG4gIGxpbmU6IENvbW1lbnRMaW5lLFxuKTogUGFyYW1ldGVyTWVtYmVyVGFnIHwgdW5kZWZpbmVkID0+IHtcbiAgY29uc3QgY29udGVudCA9IHN0cmlwSnNkb2NMaW5lKGxpbmUudGV4dCk7XG4gIGNvbnN0IG5vcm1hbGl6ZWQgPSBnZXRQYXJhbWV0ZXJOYW1lKGNvbnRlbnQpO1xuXG4gIGlmIChub3JtYWxpemVkID09PSB2b2lkIDApIHtcbiAgICByZXR1cm4gdm9pZCAwO1xuICB9XG5cbiAgY29uc3QgbWVtYmVyID0gZ2V0TWVtYmVyTmFtZShub3JtYWxpemVkKTtcblxuICBpZiAobWVtYmVyID09PSB2b2lkIDApIHtcbiAgICByZXR1cm4gdm9pZCAwO1xuICB9XG5cbiAgcmV0dXJuIHtcbiAgICBiYXNlTmFtZTogbWVtYmVyLmJhc2VOYW1lLFxuICAgIGZ1bGxOYW1lOiBub3JtYWxpemVkLFxuICAgIGxpbmUsXG4gIH07XG59O1xuXG5leHBvcnQgeyBwYXJzZVBhcmFtZXRlclRhZ0xpbmUgfTtcbiJdfQ==
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { Rule } from "eslint";
|
|
2
|
+
import type { TypeAnnotationNode } from "./types";
|
|
3
|
+
/**
|
|
4
|
+
* Builds a lookup of parameter names to type annotations.
|
|
5
|
+
* @param node Function-like node.
|
|
6
|
+
* @returns Lookup of parameter names to annotations.
|
|
7
|
+
* @example
|
|
8
|
+
* ```typescript
|
|
9
|
+
* const lookup = getParameterTypeLookup(node);
|
|
10
|
+
* ```
|
|
11
|
+
*/
|
|
12
|
+
declare const getParameterTypeLookup: (node: Rule.Node) => Map<string, TypeAnnotationNode>;
|
|
13
|
+
/**
|
|
14
|
+
* Checks whether a type annotation is a named type reference.
|
|
15
|
+
* @param typeAnnotation Type annotation to inspect.
|
|
16
|
+
* @returns True when the annotation is a named reference.
|
|
17
|
+
* @example
|
|
18
|
+
* ```typescript
|
|
19
|
+
* const ok = isNamedTypeReference(annotation);
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
declare const isNamedTypeReference: (typeAnnotation: TypeAnnotationNode | undefined) => boolean;
|
|
23
|
+
export { getParameterTypeLookup, isNamedTypeReference };
|
|
24
|
+
//# sourceMappingURL=parameter-utilities.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parameter-utilities.d.ts","sourceRoot":"","sources":["../../../src/docs/no-interface-member-docs/parameter-utilities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AA0KlD;;;;;;;;GAQG;AACH,QAAA,MAAM,sBAAsB,GAC1B,MAAM,IAAI,CAAC,IAAI,KACd,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAYhC,CAAC;AAEF;;;;;;;;GAQG;AACH,QAAA,MAAM,oBAAoB,GACxB,gBAAgB,kBAAkB,GAAG,SAAS,KAC7C,OAAqD,CAAC;AAEzD,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,CAAC"}
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Gets a type annotation node from an identifier.
|
|
3
|
+
* @param node Identifier node to inspect.
|
|
4
|
+
* @returns The type annotation node when present.
|
|
5
|
+
* @example
|
|
6
|
+
* ```typescript
|
|
7
|
+
* const annotation = getTypeAnnotationNode(identifier);
|
|
8
|
+
* ```
|
|
9
|
+
*/
|
|
10
|
+
const getTypeAnnotationNode = (node) => node.typeAnnotation?.typeAnnotation;
|
|
11
|
+
/**
|
|
12
|
+
* Defines resolveParameterNode.
|
|
13
|
+
* @param node Input node value.
|
|
14
|
+
* @returns Return value output.
|
|
15
|
+
* @example
|
|
16
|
+
* ```typescript
|
|
17
|
+
* resolveParameterNode();
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
const resolveParameterNode = (node) => {
|
|
21
|
+
if (node === null || typeof node !== "object") {
|
|
22
|
+
return node;
|
|
23
|
+
}
|
|
24
|
+
const container = node;
|
|
25
|
+
if (container.argument !== void 0) {
|
|
26
|
+
return container.argument;
|
|
27
|
+
}
|
|
28
|
+
if (container.parameter !== void 0) {
|
|
29
|
+
return container.parameter;
|
|
30
|
+
}
|
|
31
|
+
if (container.type === "AssignmentPattern" && container.left !== void 0) {
|
|
32
|
+
return container.left;
|
|
33
|
+
}
|
|
34
|
+
return node;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* Gets the parameter identifier for a parameter node.
|
|
38
|
+
* @param node Parameter node to inspect.
|
|
39
|
+
* @returns The identifier node when present.
|
|
40
|
+
* @example
|
|
41
|
+
* ```typescript
|
|
42
|
+
* const identifier = getParameterIdentifier(node);
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
const getParameterIdentifier = (node) => {
|
|
46
|
+
const resolved = resolveParameterNode(node);
|
|
47
|
+
if (resolved === null || typeof resolved !== "object") {
|
|
48
|
+
return void 0;
|
|
49
|
+
}
|
|
50
|
+
const identifier = resolved;
|
|
51
|
+
const { name } = identifier;
|
|
52
|
+
if (identifier.type !== "Identifier" || typeof name !== "string") {
|
|
53
|
+
return void 0;
|
|
54
|
+
}
|
|
55
|
+
return { ...identifier, name };
|
|
56
|
+
};
|
|
57
|
+
/**
|
|
58
|
+
* Gets parameter info for the given node.
|
|
59
|
+
* @param node Parameter node to inspect.
|
|
60
|
+
* @returns Parameter info when available.
|
|
61
|
+
* @example
|
|
62
|
+
* ```typescript
|
|
63
|
+
* const info = getParameterInfo(node);
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
const getParameterInfo = (node) => {
|
|
67
|
+
const identifier = getParameterIdentifier(node);
|
|
68
|
+
if (identifier === void 0) {
|
|
69
|
+
return void 0;
|
|
70
|
+
}
|
|
71
|
+
const typeAnnotation = getTypeAnnotationNode(identifier);
|
|
72
|
+
return typeAnnotation === void 0
|
|
73
|
+
? { name: identifier.name }
|
|
74
|
+
: {
|
|
75
|
+
name: identifier.name,
|
|
76
|
+
typeAnnotation,
|
|
77
|
+
};
|
|
78
|
+
};
|
|
79
|
+
/**
|
|
80
|
+
* Gets getParameters.
|
|
81
|
+
* @param node Input node value.
|
|
82
|
+
* @returns Return value output.
|
|
83
|
+
* @example
|
|
84
|
+
* ```typescript
|
|
85
|
+
* getParameters();
|
|
86
|
+
* ```
|
|
87
|
+
*/
|
|
88
|
+
const getParameters = (node) => {
|
|
89
|
+
if (node === null || typeof node !== "object") {
|
|
90
|
+
return [];
|
|
91
|
+
}
|
|
92
|
+
const typedNode = node;
|
|
93
|
+
return Array.isArray(typedNode.params) ? typedNode.params : [];
|
|
94
|
+
};
|
|
95
|
+
/**
|
|
96
|
+
* Builds a lookup of parameter names to type annotations.
|
|
97
|
+
* @param node Function-like node.
|
|
98
|
+
* @returns Lookup of parameter names to annotations.
|
|
99
|
+
* @example
|
|
100
|
+
* ```typescript
|
|
101
|
+
* const lookup = getParameterTypeLookup(node);
|
|
102
|
+
* ```
|
|
103
|
+
*/
|
|
104
|
+
const getParameterTypeLookup = (node) => {
|
|
105
|
+
const lookup = new Map();
|
|
106
|
+
for (const parameter of getParameters(node)) {
|
|
107
|
+
const info = getParameterInfo(parameter);
|
|
108
|
+
if (info !== void 0 && info.typeAnnotation !== void 0) {
|
|
109
|
+
lookup.set(info.name, info.typeAnnotation);
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
return lookup;
|
|
113
|
+
};
|
|
114
|
+
/**
|
|
115
|
+
* Checks whether a type annotation is a named type reference.
|
|
116
|
+
* @param typeAnnotation Type annotation to inspect.
|
|
117
|
+
* @returns True when the annotation is a named reference.
|
|
118
|
+
* @example
|
|
119
|
+
* ```typescript
|
|
120
|
+
* const ok = isNamedTypeReference(annotation);
|
|
121
|
+
* ```
|
|
122
|
+
*/
|
|
123
|
+
const isNamedTypeReference = (typeAnnotation) => typeAnnotation?.type === "TSTypeReference";
|
|
124
|
+
export { getParameterTypeLookup, isNamedTypeReference };
|
|
125
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"parameter-utilities.js","sourceRoot":"","sources":["../../../src/docs/no-interface-member-docs/parameter-utilities.ts"],"names":[],"mappings":"AAuDA;;;;;;;;GAQG;AACH,MAAM,qBAAqB,GAAG,CAC5B,IAAoB,EACY,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC;AAEzE;;;;;;;;GAQG;AACH,MAAM,oBAAoB,GAAG,CAAC,IAAa,EAAW,EAAE;IACtD,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,SAAS,GAAG,IAA0B,CAAC;IAE7C,IAAI,SAAS,CAAC,QAAQ,KAAK,KAAK,CAAC,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC,QAAQ,CAAC;IAC5B,CAAC;IAED,IAAI,SAAS,CAAC,SAAS,KAAK,KAAK,CAAC,EAAE,CAAC;QACnC,OAAO,SAAS,CAAC,SAAS,CAAC;IAC7B,CAAC;IAED,IAAI,SAAS,CAAC,IAAI,KAAK,mBAAmB,IAAI,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QACxE,OAAO,SAAS,CAAC,IAAI,CAAC;IACxB,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,sBAAsB,GAAG,CAC7B,IAAa,EACoB,EAAE;IACnC,MAAM,QAAQ,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAE5C,IAAI,QAAQ,KAAK,IAAI,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACtD,OAAO,KAAK,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,UAAU,GAAG,QAA0B,CAAC;IAC9C,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAE5B,IAAI,UAAU,CAAC,IAAI,KAAK,YAAY,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACjE,OAAO,KAAK,CAAC,CAAC;IAChB,CAAC;IAED,OAAO,EAAE,GAAG,UAAU,EAAE,IAAI,EAAyB,CAAC;AACxD,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,gBAAgB,GAAG,CAAC,IAAa,EAA6B,EAAE;IACpE,MAAM,UAAU,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAEhD,IAAI,UAAU,KAAK,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,cAAc,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC;IAEzD,OAAO,cAAc,KAAK,KAAK,CAAC;QAC9B,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE;QAC3B,CAAC,CAAC;YACE,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,cAAc;SACf,CAAC;AACR,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,aAAa,GAAG,CAAC,IAAa,EAAa,EAAE;IACjD,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC9C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,SAAS,GAAG,IAAwB,CAAC;IAE3C,OAAO,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;AACjE,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,sBAAsB,GAAG,CAC7B,IAAe,EACkB,EAAE;IACnC,MAAM,MAAM,GAAG,IAAI,GAAG,EAA8B,CAAC;IAErD,KAAK,MAAM,SAAS,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5C,MAAM,IAAI,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAEzC,IAAI,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,EAAE,CAAC;YACtD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,oBAAoB,GAAG,CAC3B,cAA8C,EACrC,EAAE,CAAC,cAAc,EAAE,IAAI,KAAK,iBAAiB,CAAC;AAEzD,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,CAAC","sourcesContent":["import type { Rule } from \"eslint\";\n\nimport type { TypeAnnotationNode } from \"./types\";\n\n/** Type definition for rule data. */\ninterface FunctionLikeNode {\n  /** Params helper value. */\n  params?: unknown[];\n}\n\n/** Type definition for rule data. */\ninterface IdentifierNode {\n  /** Name helper value. */\n  name?: string;\n\n  /** Type helper value. */\n  type?: string;\n\n  /** TypeAnnotation helper value. */\n  typeAnnotation?: {\n    /** TypeAnnotation helper value. */\n    typeAnnotation?: TypeAnnotationNode;\n  };\n}\n\n/** Type definition for rule data. */\ninterface NamedIdentifierNode extends IdentifierNode {\n  /** Name field value. */\n  name: string;\n}\n\n/** Type definition for rule data. */\ninterface ParameterContainer {\n  /** Argument helper value. */\n  argument?: unknown;\n\n  /** Left helper value. */\n  left?: unknown;\n\n  /** Parameter helper value. */\n  parameter?: unknown;\n\n  /** Type helper value. */\n  type?: string;\n}\n\n/** Type definition for rule data. */\ninterface ParameterInfo {\n  /** Name field value. */\n  name: string;\n\n  /** TypeAnnotation helper value. */\n  typeAnnotation?: TypeAnnotationNode;\n}\n\n/**\n * Gets a type annotation node from an identifier.\n * @param node Identifier node to inspect.\n * @returns The type annotation node when present.\n * @example\n * ```typescript\n * const annotation = getTypeAnnotationNode(identifier);\n * ```\n */\nconst getTypeAnnotationNode = (\n  node: IdentifierNode,\n): TypeAnnotationNode | undefined => node.typeAnnotation?.typeAnnotation;\n\n/**\n * Defines resolveParameterNode.\n * @param node Input node value.\n * @returns Return value output.\n * @example\n * ```typescript\n * resolveParameterNode();\n * ```\n */\nconst resolveParameterNode = (node: unknown): unknown => {\n  if (node === null || typeof node !== \"object\") {\n    return node;\n  }\n\n  const container = node as ParameterContainer;\n\n  if (container.argument !== void 0) {\n    return container.argument;\n  }\n\n  if (container.parameter !== void 0) {\n    return container.parameter;\n  }\n\n  if (container.type === \"AssignmentPattern\" && container.left !== void 0) {\n    return container.left;\n  }\n\n  return node;\n};\n\n/**\n * Gets the parameter identifier for a parameter node.\n * @param node Parameter node to inspect.\n * @returns The identifier node when present.\n * @example\n * ```typescript\n * const identifier = getParameterIdentifier(node);\n * ```\n */\nconst getParameterIdentifier = (\n  node: unknown,\n): NamedIdentifierNode | undefined => {\n  const resolved = resolveParameterNode(node);\n\n  if (resolved === null || typeof resolved !== \"object\") {\n    return void 0;\n  }\n\n  const identifier = resolved as IdentifierNode;\n  const { name } = identifier;\n\n  if (identifier.type !== \"Identifier\" || typeof name !== \"string\") {\n    return void 0;\n  }\n\n  return { ...identifier, name } as NamedIdentifierNode;\n};\n\n/**\n * Gets parameter info for the given node.\n * @param node Parameter node to inspect.\n * @returns Parameter info when available.\n * @example\n * ```typescript\n * const info = getParameterInfo(node);\n * ```\n */\nconst getParameterInfo = (node: unknown): ParameterInfo | undefined => {\n  const identifier = getParameterIdentifier(node);\n\n  if (identifier === void 0) {\n    return void 0;\n  }\n\n  const typeAnnotation = getTypeAnnotationNode(identifier);\n\n  return typeAnnotation === void 0\n    ? { name: identifier.name }\n    : {\n        name: identifier.name,\n        typeAnnotation,\n      };\n};\n\n/**\n * Gets getParameters.\n * @param node Input node value.\n * @returns Return value output.\n * @example\n * ```typescript\n * getParameters();\n * ```\n */\nconst getParameters = (node: unknown): unknown[] => {\n  if (node === null || typeof node !== \"object\") {\n    return [];\n  }\n\n  const typedNode = node as FunctionLikeNode;\n\n  return Array.isArray(typedNode.params) ? typedNode.params : [];\n};\n\n/**\n * Builds a lookup of parameter names to type annotations.\n * @param node Function-like node.\n * @returns Lookup of parameter names to annotations.\n * @example\n * ```typescript\n * const lookup = getParameterTypeLookup(node);\n * ```\n */\nconst getParameterTypeLookup = (\n  node: Rule.Node,\n): Map<string, TypeAnnotationNode> => {\n  const lookup = new Map<string, TypeAnnotationNode>();\n\n  for (const parameter of getParameters(node)) {\n    const info = getParameterInfo(parameter);\n\n    if (info !== void 0 && info.typeAnnotation !== void 0) {\n      lookup.set(info.name, info.typeAnnotation);\n    }\n  }\n\n  return lookup;\n};\n\n/**\n * Checks whether a type annotation is a named type reference.\n * @param typeAnnotation Type annotation to inspect.\n * @returns True when the annotation is a named reference.\n * @example\n * ```typescript\n * const ok = isNamedTypeReference(annotation);\n * ```\n */\nconst isNamedTypeReference = (\n  typeAnnotation: TypeAnnotationNode | undefined,\n): boolean => typeAnnotation?.type === \"TSTypeReference\";\n\nexport { getParameterTypeLookup, isNamedTypeReference };\n"]}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { Rule } from "eslint";
|
|
2
|
+
/** ESLint rule disallowing interface member documentation in `@param` tags. */
|
|
3
|
+
declare const noInterfaceMemberDocumentationRule: Rule.RuleModule;
|
|
4
|
+
export { noInterfaceMemberDocumentationRule };
|
|
5
|
+
//# sourceMappingURL=rule.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../../../src/docs/no-interface-member-docs/rule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAiPnC,+EAA+E;AAC/E,QAAA,MAAM,kCAAkC,EAAE,IAAI,CAAC,UA8B9C,CAAC;AAEF,OAAO,EAAE,kCAAkC,EAAE,CAAC"}
|