@flint.fyi/plugin-flint 0.2.1 → 0.5.1

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.
Files changed (48) hide show
  1. package/lib/index.d.ts +97 -1
  2. package/lib/index.js +836 -1
  3. package/lib/plugin.d.ts +93 -0
  4. package/lib/rules/getStartSourceFile.d.ts +10 -0
  5. package/lib/rules/invalidCodeLines.d.ts +5 -2
  6. package/lib/rules/missingPlaceholders.d.ts +10 -0
  7. package/lib/rules/nodePropertyInChecks.d.ts +10 -0
  8. package/lib/rules/placeholderFormats.d.ts +10 -0
  9. package/lib/rules/pluginRuleOrdering.d.ts +10 -0
  10. package/lib/rules/ruleCreationMethods.d.ts +10 -0
  11. package/lib/rules/ruleCreator.d.ts +3 -0
  12. package/lib/rules/testCaseDuplicates.d.ts +5 -2
  13. package/lib/rules/testCaseNameDuplicates.d.ts +10 -0
  14. package/lib/rules/testCaseNonStaticCode.d.ts +10 -0
  15. package/lib/rules/testCaseOnlyFlags.d.ts +10 -0
  16. package/lib/rules/testShorthands.d.ts +10 -0
  17. package/lib/rules/unusedMessageIds.d.ts +10 -0
  18. package/lib/utils/findProperty.d.ts +4 -0
  19. package/lib/utils/getRuleTesterCaseArrays.d.ts +6 -0
  20. package/lib/utils/getRuleTesterDescribedCases.d.ts +6 -0
  21. package/lib/utils/importHelpers.d.ts +5 -0
  22. package/lib/utils/isTypeFromTS.d.ts +3 -0
  23. package/lib/utils/messageHelpers.d.ts +12 -0
  24. package/lib/utils/parseTestCases.d.ts +5 -0
  25. package/lib/utils/ruleCreatorHelpers.d.ts +5 -0
  26. package/lib/utils/tsAstToLiteral.d.ts +6 -0
  27. package/lib/utils/types.d.ts +21 -0
  28. package/package.json +14 -9
  29. package/lib/findProperty.d.ts +0 -3
  30. package/lib/findProperty.js +0 -8
  31. package/lib/flint.d.ts +0 -10
  32. package/lib/flint.js +0 -8
  33. package/lib/getRuleTesterDescribedCases.d.ts +0 -6
  34. package/lib/getRuleTesterDescribedCases.js +0 -32
  35. package/lib/parseTestCases.d.ts +0 -5
  36. package/lib/parseTestCases.js +0 -63
  37. package/lib/rules/invalidCodeLines.js +0 -77
  38. package/lib/rules/invalidCodeLines.test.d.ts +0 -2
  39. package/lib/rules/invalidCodeLines.test.js +0 -198
  40. package/lib/rules/ruleTester.d.ts +0 -3
  41. package/lib/rules/ruleTester.js +0 -8
  42. package/lib/rules/testCaseDuplicates.js +0 -56
  43. package/lib/rules/testCaseDuplicates.test.d.ts +0 -2
  44. package/lib/rules/testCaseDuplicates.test.js +0 -174
  45. package/lib/tsAstToLiteral.d.ts +0 -5
  46. package/lib/tsAstToLiteral.js +0 -38
  47. package/lib/types.d.ts +0 -18
  48. package/lib/types.js +0 -2
@@ -1,198 +0,0 @@
1
- import rule from "./invalidCodeLines.js";
2
- import { ruleTester } from "./ruleTester.js";
3
- ruleTester.describe(rule, {
4
- invalid: [
5
- {
6
- code: `
7
- ruleTester.describe(rule, {
8
- valid: ['a', 'a'],
9
- invalid: [
10
- {
11
- code: "",
12
- snapshot: \`
13
- ~
14
- Rule report message.
15
- \`,
16
- }
17
- ],
18
- });
19
- `,
20
- output: `
21
- ruleTester.describe(rule, {
22
- valid: ['a', 'a'],
23
- invalid: [
24
- {
25
- code: \`
26
-
27
- \`,
28
- snapshot: \`
29
- ~
30
- Rule report message.
31
- \`,
32
- }
33
- ],
34
- });
35
- `,
36
- snapshot: `
37
- ruleTester.describe(rule, {
38
- valid: ['a', 'a'],
39
- invalid: [
40
- {
41
- code: "",
42
- ~~
43
- This code block should be formatted across multiple lines for more readable reports.
44
- snapshot: \`
45
- ~
46
- Rule report message.
47
- \`,
48
- }
49
- ],
50
- });
51
- `,
52
- },
53
- {
54
- code: `
55
- ruleTester.describe(rule, {
56
- valid: ['a', 'a'],
57
- invalid: [
58
- {
59
- code: \`console.log(
60
- );\`,
61
- snapshot: \`console.log(
62
- );
63
- ~
64
- Rule report message.
65
- \`,
66
- }
67
- ],
68
- });
69
- `,
70
- output: `
71
- ruleTester.describe(rule, {
72
- valid: ['a', 'a'],
73
- invalid: [
74
- {
75
- code: \`
76
- console.log(
77
- );
78
- \`,
79
- snapshot: \`
80
- console.log(
81
- );
82
- ~
83
- Rule report message.
84
- \`,
85
- }
86
- ],
87
- });
88
- `,
89
- snapshot: `
90
- ruleTester.describe(rule, {
91
- valid: ['a', 'a'],
92
- invalid: [
93
- {
94
- code: \`console.log(
95
- ~~~~~~~~~~~~~
96
- This code block should be formatted across multiple lines for more readable reports.
97
- );\`,
98
- ~~~
99
- snapshot: \`console.log(
100
- );
101
- ~
102
- Rule report message.
103
- \`,
104
- }
105
- ],
106
- });
107
- `,
108
- },
109
- {
110
- code: `
111
- ruleTester.describe(rule, {
112
- valid: ['a', 'a'],
113
- invalid: [
114
- {
115
- code: \`console.log();\`,
116
- snapshot: \`console.log();
117
- ~~~~~~~~~~~~
118
- Rule report message.
119
- \`,
120
- }
121
- ],
122
- });
123
- `,
124
- output: `
125
- ruleTester.describe(rule, {
126
- valid: ['a', 'a'],
127
- invalid: [
128
- {
129
- code: \`
130
- console.log();
131
- \`,
132
- snapshot: \`
133
- console.log();
134
- ~~~~~~~~~~~~~
135
- Rule report message.
136
- \`,
137
- }
138
- ],
139
- });
140
- `,
141
- snapshot: `
142
- ruleTester.describe(rule, {
143
- valid: ['a', 'a'],
144
- invalid: [
145
- {
146
- code: \`console.log();\`,
147
- ~~~~~~~~~~~~~~~~
148
- This code block should be formatted across multiple lines for more readable reports.
149
- snapshot: \`console.log();
150
- ~~~~~~~~~~~~
151
- Rule report message.
152
- \`,
153
- }
154
- ],
155
- });
156
- `,
157
- },
158
- ],
159
- valid: [
160
- `
161
- ruleTester.describe(rule, {
162
- valid: [],
163
- invalid: []
164
- });
165
- `,
166
- `
167
- ruleTester.describe(rule, {
168
- valid: [],
169
- invalid: [
170
- {
171
- code: \`
172
- \`,
173
- snapshot: \`
174
- ~
175
- \`,
176
- }
177
- ],
178
- });
179
- `,
180
- `
181
- ruleTester.describe(rule, {
182
- valid: [],
183
- invalid: [
184
- {
185
- code: \`
186
- console.log();
187
- \`,
188
- snapshot: \`
189
- ~~~~~~~~~~~~
190
- Rule report message.
191
- \`,
192
- }
193
- ],
194
- });
195
- `,
196
- ],
197
- });
198
- //# sourceMappingURL=invalidCodeLines.test.js.map
@@ -1,3 +0,0 @@
1
- import { RuleTester } from "@flint.fyi/rule-tester";
2
- export declare const ruleTester: RuleTester;
3
- //# sourceMappingURL=ruleTester.d.ts.map
@@ -1,8 +0,0 @@
1
- import { RuleTester } from "@flint.fyi/rule-tester";
2
- import { describe, it } from "vitest";
3
- export const ruleTester = new RuleTester({
4
- defaults: { fileName: "file.test.ts" },
5
- describe,
6
- it,
7
- });
8
- //# sourceMappingURL=ruleTester.js.map
@@ -1,56 +0,0 @@
1
- import { getTSNodeRange, typescriptLanguage } from "@flint.fyi/ts";
2
- import { getRuleTesterDescribedCases } from "../getRuleTesterDescribedCases.js";
3
- export default typescriptLanguage.createRule({
4
- about: {
5
- description: "Reports test cases that are identical to previous test cases.",
6
- id: "testCaseDuplicates",
7
- preset: "logical",
8
- },
9
- messages: {
10
- duplicateTest: {
11
- primary: "This test code already appeared in a previous test.",
12
- secondary: [
13
- "When writing tests for lint rules, it's possible to accidentally create deeply identical test cases.",
14
- "Doing so provides no added benefit for testing and is unnecessary.",
15
- ],
16
- suggestions: [
17
- "Delete this redundant test case.",
18
- "Change a property to make the test case unique.",
19
- ],
20
- },
21
- },
22
- setup(context) {
23
- function checkTestCases(testCases, sourceFile) {
24
- const seen = new Set();
25
- for (const testCase of testCases) {
26
- const key = JSON.stringify({
27
- code: testCase.code,
28
- fileName: testCase.fileName,
29
- options: testCase.options,
30
- });
31
- if (seen.has(key)) {
32
- context.report({
33
- message: "duplicateTest",
34
- range: getTSNodeRange(testCase.nodes.case, sourceFile),
35
- });
36
- }
37
- else {
38
- seen.add(key);
39
- }
40
- }
41
- }
42
- return {
43
- visitors: {
44
- CallExpression(node, { sourceFile }) {
45
- const describedCases = getRuleTesterDescribedCases(node);
46
- if (!describedCases) {
47
- return;
48
- }
49
- checkTestCases(describedCases.invalid, sourceFile);
50
- checkTestCases(describedCases.valid, sourceFile);
51
- },
52
- },
53
- };
54
- },
55
- });
56
- //# sourceMappingURL=testCaseDuplicates.js.map
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=testCaseDuplicates.test.d.ts.map
@@ -1,174 +0,0 @@
1
- import { ruleTester } from "./ruleTester.js";
2
- import rule from "./testCaseDuplicates.js";
3
- ruleTester.describe(rule, {
4
- invalid: [
5
- {
6
- code: `
7
- ruleTester.describe(rule, {
8
- valid: ['a', 'a'],
9
- invalid: []
10
- });
11
- `,
12
- snapshot: `
13
- ruleTester.describe(rule, {
14
- valid: ['a', 'a'],
15
- ~~~
16
- This test code already appeared in a previous test.
17
- invalid: []
18
- });
19
- `,
20
- },
21
- {
22
- code: `
23
- ruleTester.describe(rule, {
24
- valid: [
25
- 'a',
26
- "a",
27
- ],
28
- invalid: []
29
- });
30
- `,
31
- snapshot: `
32
- ruleTester.describe(rule, {
33
- valid: [
34
- 'a',
35
- "a",
36
- ~~~
37
- This test code already appeared in a previous test.
38
- ],
39
- invalid: []
40
- });
41
- `,
42
- },
43
- {
44
- code: `
45
- ruleTester.describe(rule, {
46
- valid: [
47
- \`a\`,
48
- \`a\`,
49
- ],
50
- invalid: []
51
- });
52
- `,
53
- snapshot: `
54
- ruleTester.describe(rule, {
55
- valid: [
56
- \`a\`,
57
- \`a\`,
58
- ~~~
59
- This test code already appeared in a previous test.
60
- ],
61
- invalid: []
62
- });
63
- `,
64
- },
65
- {
66
- code: `
67
- ruleTester.describe(rule, {
68
- valid: [
69
- { code: "a" },
70
- { code: "a" },
71
- ],
72
- invalid: []
73
- });
74
- `,
75
- snapshot: `
76
- ruleTester.describe(rule, {
77
- valid: [
78
- { code: "a" },
79
- { code: "a" },
80
- ~~~~~~~~~~~~~
81
- This test code already appeared in a previous test.
82
- ],
83
- invalid: []
84
- });
85
- `,
86
- },
87
- {
88
- code: `
89
- ruleTester.describe(rule, {
90
- valid: [
91
- { code: "a", fileName: "b.ts" },
92
- { code: "a", fileName: "b.ts" },
93
- ],
94
- invalid: []
95
- });
96
- `,
97
- snapshot: `
98
- ruleTester.describe(rule, {
99
- valid: [
100
- { code: "a", fileName: "b.ts" },
101
- { code: "a", fileName: "b.ts" },
102
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103
- This test code already appeared in a previous test.
104
- ],
105
- invalid: []
106
- });
107
- `,
108
- },
109
- {
110
- code: `
111
- ruleTester.describe(rule, {
112
- valid: [
113
- { code: "a", fileName: "b.ts", options: { c: "d" } },
114
- { code: "a", fileName: "b.ts", options: { c: "d" } },
115
- ],
116
- invalid: []
117
- });
118
- `,
119
- snapshot: `
120
- ruleTester.describe(rule, {
121
- valid: [
122
- { code: "a", fileName: "b.ts", options: { c: "d" } },
123
- { code: "a", fileName: "b.ts", options: { c: "d" } },
124
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125
- This test code already appeared in a previous test.
126
- ],
127
- invalid: []
128
- });
129
- `,
130
- },
131
- ],
132
- valid: [
133
- `
134
- describe(rule, {
135
- valid: ['a', 'a'],
136
- invalid: []
137
- });
138
- `,
139
- `
140
- ruleTester.describe(rule, {
141
- valid: ['a', 'b'],
142
- invalid: []
143
- });
144
- `,
145
- `
146
- ruleTester.describe(rule, {
147
- valid: [
148
- { code: \`a\`, fileName: "b.ts" },
149
- { code: \`a\`, fileName: "c.ts" },
150
- ],
151
- invalid: []
152
- });
153
- `,
154
- `
155
- ruleTester.describe(rule, {
156
- valid: [
157
- { code: \`a\`, fileName: "b.ts", options: { c: "d" } },
158
- { code: \`a\`, fileName: "b.ts", options: { c: "e" } },
159
- ],
160
- invalid: []
161
- });
162
- `,
163
- `
164
- ruleTester.describe(rule, {
165
- valid: [
166
- { code: \`a\`, fileName: "b.ts", options: { c: "d" } },
167
- { code: \`a\`, fileName: "c.ts", options: { c: "d" } },
168
- ],
169
- invalid: []
170
- });
171
- `,
172
- ],
173
- });
174
- //# sourceMappingURL=testCaseDuplicates.test.js.map
@@ -1,5 +0,0 @@
1
- import ts from "typescript";
2
- export declare function tsAstToLiteral(node: ts.ArrayLiteralExpression): unknown[];
3
- export declare function tsAstToLiteral(node: ts.ObjectLiteralExpression): object;
4
- export declare function tsAstToLiteral(node: ts.Node): unknown;
5
- //# sourceMappingURL=tsAstToLiteral.d.ts.map
@@ -1,38 +0,0 @@
1
- // Fork of ts-ast-to-literal pending:
2
- // https://github.com/dword-design/ts-ast-to-literal/issues/89
3
- // Changing from the switch to manual ifs is due to:
4
- // https://github.com/Microsoft/TypeScript/issues/56275
5
- import ts from "typescript";
6
- export function tsAstToLiteral(node) {
7
- switch (node.kind) {
8
- case ts.SyntaxKind.FalseKeyword:
9
- return false;
10
- case ts.SyntaxKind.NullKeyword:
11
- return null;
12
- case ts.SyntaxKind.TrueKeyword:
13
- return true;
14
- }
15
- if (ts.isArrayLiteralExpression(node)) {
16
- return node.elements
17
- .filter((element) => element.kind !== ts.SyntaxKind.SpreadElement)
18
- .map((element) => tsAstToLiteral(element));
19
- }
20
- if (ts.isNumericLiteral(node)) {
21
- return parseFloat(node.text);
22
- }
23
- if (ts.isObjectLiteralExpression(node)) {
24
- return Object.fromEntries(node.properties
25
- .filter((property) => ts.isPropertyAssignment(property) &&
26
- (property.name.kind === ts.SyntaxKind.Identifier ||
27
- property.name.kind === ts.SyntaxKind.StringLiteral))
28
- .map((property) => [
29
- property.name.escapedText || property.name.text,
30
- tsAstToLiteral(property.initializer),
31
- ]));
32
- }
33
- if (ts.isStringLiteral(node)) {
34
- return node.text;
35
- }
36
- return undefined;
37
- }
38
- //# sourceMappingURL=tsAstToLiteral.js.map
package/lib/types.d.ts DELETED
@@ -1,18 +0,0 @@
1
- import type { InvalidTestCase, TestCase } from "@flint.fyi/rule-tester";
2
- import * as ts from "typescript";
3
- export interface ParsedTestCase extends TestCase {
4
- nodes: ParsedTestCaseNodes;
5
- }
6
- export interface ParsedTestCaseInvalid extends InvalidTestCase {
7
- nodes: ParsedTestCaseNodesInvalid;
8
- }
9
- export interface ParsedTestCaseNodes {
10
- case: ts.Node;
11
- code: ts.StringLiteralLike;
12
- fileName?: ts.StringLiteralLike;
13
- options?: ts.ObjectLiteralExpression;
14
- }
15
- export interface ParsedTestCaseNodesInvalid extends ParsedTestCaseNodes {
16
- snapshot: ts.Node;
17
- }
18
- //# sourceMappingURL=types.d.ts.map
package/lib/types.js DELETED
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=types.js.map