@eslint-react/kit 2.0.0-next.2 → 2.0.0-next.200
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/dist/index.d.ts +93 -195
- package/dist/index.js +99 -200
- package/package.json +9 -10
package/dist/index.d.ts
CHANGED
|
@@ -1,170 +1,142 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
3
|
-
import {
|
|
4
|
-
import * as z from '@zod/mini';
|
|
5
|
-
import { _ } from '@eslint-react/eff';
|
|
6
|
-
import { TSESTree } from '@typescript-eslint/utils';
|
|
7
|
-
|
|
8
|
-
/**
|
|
9
|
-
* Rule severity.
|
|
10
|
-
* @since 0.0.1
|
|
11
|
-
*/
|
|
12
|
-
type RuleSeverity = "error" | "off" | "warn";
|
|
13
|
-
/**
|
|
14
|
-
* Rule declaration.
|
|
15
|
-
* @internal
|
|
16
|
-
* @since 0.0.1
|
|
17
|
-
*/
|
|
18
|
-
type RuleDeclaration = [RuleSeverity, Record<string, unknown>?] | RuleSeverity;
|
|
19
|
-
/**
|
|
20
|
-
* Rule config preset.
|
|
21
|
-
* @since 0.0.1
|
|
22
|
-
*/
|
|
23
|
-
type RulePreset = Record<string, RuleDeclaration>;
|
|
24
|
-
/**
|
|
25
|
-
* Rule context.
|
|
26
|
-
* @since 0.0.1
|
|
27
|
-
*/
|
|
28
|
-
type RuleContext<MessageIds extends string = string, Options extends readonly unknown[] = readonly unknown[]> = tseslint.RuleContext<MessageIds, Options>;
|
|
29
|
-
/**
|
|
30
|
-
* Rule feature.
|
|
31
|
-
* @since 1.20.0
|
|
32
|
-
*/
|
|
33
|
-
type RuleFeature = "CFG" | "DBG" | "FIX" | "MOD" | "TSC" | "EXP";
|
|
34
|
-
|
|
35
|
-
type JsxConfig = Pick<CompilerOptions, "reactNamespace" | "jsx" | "jsxFactory" | "jsxFragmentFactory" | "jsxImportSource">;
|
|
36
|
-
/**
|
|
37
|
-
* Create a JsxConfig object
|
|
38
|
-
* @returns JsxConfig
|
|
39
|
-
*/
|
|
40
|
-
declare function make$2(): JsxConfig;
|
|
41
|
-
/**
|
|
42
|
-
* Get JsxConfig from RuleContext
|
|
43
|
-
* @param context The RuleContext
|
|
44
|
-
* @returns JsxConfig
|
|
45
|
-
*/
|
|
46
|
-
declare function getFromContext$1(context: RuleContext): {
|
|
47
|
-
jsx: JsxEmit;
|
|
48
|
-
jsxFactory: string;
|
|
49
|
-
jsxFragmentFactory: string;
|
|
50
|
-
jsxImportSource: string;
|
|
51
|
-
reactNamespace: string;
|
|
52
|
-
};
|
|
53
|
-
/**
|
|
54
|
-
* Get JsxConfig from annotation
|
|
55
|
-
* @param context The RuleContext
|
|
56
|
-
* @returns JsxConfig
|
|
57
|
-
*/
|
|
58
|
-
declare function getFromAnnotation(context: RuleContext): JsxConfig;
|
|
59
|
-
|
|
60
|
-
type index$1_JsxConfig = JsxConfig;
|
|
61
|
-
declare const index$1_getFromAnnotation: typeof getFromAnnotation;
|
|
62
|
-
declare namespace index$1 {
|
|
63
|
-
export { type index$1_JsxConfig as JsxConfig, index$1_getFromAnnotation as getFromAnnotation, getFromContext$1 as getFromContext, make$2 as make };
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
/**
|
|
67
|
-
* @internal
|
|
68
|
-
*/
|
|
69
|
-
declare const LanguagePreferenceSchema: z.ZodMiniObject<{
|
|
70
|
-
indentStyle: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"tab">, z.ZodMiniLiteral<"space">]>>;
|
|
71
|
-
indentWidth: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
72
|
-
quoteStyle: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"single">, z.ZodMiniLiteral<"double">]>>;
|
|
73
|
-
semicolons: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"always">, z.ZodMiniLiteral<"asNeeded">]>>;
|
|
74
|
-
trailingCommas: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"all">, z.ZodMiniLiteral<"es5">, z.ZodMiniLiteral<"none">]>>;
|
|
75
|
-
jsxQuoteStyle: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"single">, z.ZodMiniLiteral<"double">]>>;
|
|
76
|
-
}, {}>;
|
|
77
|
-
|
|
78
|
-
/**
|
|
79
|
-
* @internal
|
|
80
|
-
*/
|
|
81
|
-
type LanguagePreference = z.infer<typeof LanguagePreferenceSchema>;
|
|
82
|
-
/**
|
|
83
|
-
* Get a copy of the default LanguagePreference.
|
|
84
|
-
*/
|
|
85
|
-
declare function make$1(): LanguagePreference;
|
|
86
|
-
declare function getFromContext(): void;
|
|
87
|
-
declare module "@typescript-eslint/utils/ts-eslint" {
|
|
88
|
-
interface SharedConfigurationSettings {
|
|
89
|
-
}
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
type index_LanguagePreference = LanguagePreference;
|
|
93
|
-
declare const index_LanguagePreferenceSchema: typeof LanguagePreferenceSchema;
|
|
94
|
-
declare const index_getFromContext: typeof getFromContext;
|
|
95
|
-
declare namespace index {
|
|
96
|
-
export { type index_LanguagePreference as LanguagePreference, index_LanguagePreferenceSchema as LanguagePreferenceSchema, index_getFromContext as getFromContext, make$1 as make };
|
|
97
|
-
}
|
|
1
|
+
import { unit } from "@eslint-react/eff";
|
|
2
|
+
import * as tseslint from "@typescript-eslint/utils/ts-eslint";
|
|
3
|
+
import { ReportDescriptor } from "@typescript-eslint/utils/ts-eslint";
|
|
98
4
|
|
|
5
|
+
//#region src/constants.d.ts
|
|
99
6
|
/**
|
|
100
7
|
* Regular expressions for matching a HTML tag name
|
|
101
8
|
*/
|
|
102
|
-
declare const
|
|
9
|
+
declare const RE_HTML_TAG: RegExp;
|
|
103
10
|
/**
|
|
104
11
|
* Regular expression for matching a TypeScript file extension.
|
|
105
12
|
*/
|
|
106
|
-
declare const
|
|
13
|
+
declare const RE_TS_EXT: RegExp;
|
|
107
14
|
/**
|
|
108
15
|
* Regular expression for matching a JavaScript file extension.
|
|
109
16
|
*/
|
|
110
|
-
declare const
|
|
17
|
+
declare const RE_JS_EXT: RegExp;
|
|
111
18
|
/**
|
|
112
19
|
* Regular expression for matching a PascalCase string.
|
|
113
20
|
*/
|
|
114
|
-
declare const
|
|
21
|
+
declare const RE_PASCAL_CASE: RegExp;
|
|
115
22
|
/**
|
|
116
23
|
* Regular expression for matching a camelCase string.
|
|
117
24
|
*/
|
|
118
|
-
declare const
|
|
25
|
+
declare const RE_CAMEL_CASE: RegExp;
|
|
119
26
|
/**
|
|
120
27
|
* Regular expression for matching a kebab-case string.
|
|
121
28
|
*/
|
|
122
|
-
declare const
|
|
29
|
+
declare const RE_KEBAB_CASE: RegExp;
|
|
123
30
|
/**
|
|
124
31
|
* Regular expression for matching a snake_case string.
|
|
125
32
|
*/
|
|
126
|
-
declare const
|
|
33
|
+
declare const RE_SNAKE_CASE: RegExp;
|
|
127
34
|
/**
|
|
128
35
|
* Regular expression for matching a CONSTANT_CASE string.
|
|
129
36
|
*/
|
|
130
|
-
declare const
|
|
131
|
-
declare const
|
|
37
|
+
declare const RE_CONSTANT_CASE: RegExp;
|
|
38
|
+
declare const RE_JAVASCRIPT_PROTOCOL: RegExp;
|
|
132
39
|
/**
|
|
133
40
|
* Regular expression for matching a valid JavaScript identifier.
|
|
134
41
|
*/
|
|
135
|
-
declare const
|
|
42
|
+
declare const RE_JS_IDENTIFIER: RegExp;
|
|
136
43
|
/**
|
|
137
44
|
* Regular expression for matching a RegExp string.
|
|
138
45
|
*/
|
|
139
|
-
declare const
|
|
46
|
+
declare const RE_REGEXP_STR: RegExp;
|
|
140
47
|
/**
|
|
141
48
|
* Regular expression for matching a `@jsx` annotation comment.
|
|
142
49
|
*/
|
|
143
|
-
declare const
|
|
50
|
+
declare const RE_ANNOTATION_JSX: RegExp;
|
|
144
51
|
/**
|
|
145
52
|
* Regular expression for matching a `@jsxFrag` annotation comment.
|
|
146
53
|
*/
|
|
147
|
-
declare const
|
|
54
|
+
declare const RE_ANNOTATION_JSX_FRAG: RegExp;
|
|
148
55
|
/**
|
|
149
56
|
* Regular expression for matching a `@jsxRuntime` annotation comment.
|
|
150
57
|
*/
|
|
151
|
-
declare const
|
|
58
|
+
declare const RE_ANNOTATION_JSX_RUNTIME: RegExp;
|
|
152
59
|
/**
|
|
153
60
|
* Regular expression for matching a `@jsxImportSource` annotation comment.
|
|
154
61
|
*/
|
|
155
|
-
declare const
|
|
62
|
+
declare const RE_ANNOTATION_JSX_IMPORT_SOURCE: RegExp;
|
|
156
63
|
/**
|
|
157
64
|
* Regular expression for matching a React component name.
|
|
158
65
|
*/
|
|
159
|
-
declare const
|
|
66
|
+
declare const RE_COMPONENT_NAME: RegExp;
|
|
160
67
|
/**
|
|
161
68
|
* Regular expression for matching a React component name (loose).
|
|
162
69
|
*/
|
|
163
|
-
declare const
|
|
70
|
+
declare const RE_COMPONENT_NAME_LOOSE: RegExp;
|
|
164
71
|
/**
|
|
165
72
|
* Regular expression for matching a React Hook name.
|
|
166
73
|
*/
|
|
167
|
-
declare const
|
|
74
|
+
declare const RE_HOOK_NAME: RegExp;
|
|
75
|
+
//#endregion
|
|
76
|
+
//#region src/types/index.d.ts
|
|
77
|
+
/**
|
|
78
|
+
* Rule severity.
|
|
79
|
+
* @since 0.0.1
|
|
80
|
+
*/
|
|
81
|
+
type SeverityName = "off" | "warn" | "error";
|
|
82
|
+
/**
|
|
83
|
+
* The numeric severity level for a rule.
|
|
84
|
+
*
|
|
85
|
+
* - `0` means off.
|
|
86
|
+
* - `1` means warn.
|
|
87
|
+
* - `2` means error.
|
|
88
|
+
*/
|
|
89
|
+
type SeverityLevel = 0 | 1 | 2;
|
|
90
|
+
/**
|
|
91
|
+
* The severity of a rule in a configuration.
|
|
92
|
+
*/
|
|
93
|
+
type Severity = SeverityName | SeverityLevel;
|
|
94
|
+
/**
|
|
95
|
+
* Rule declaration.
|
|
96
|
+
* @internal
|
|
97
|
+
* @since 0.0.1
|
|
98
|
+
*/
|
|
99
|
+
type RuleConfig<RuleOptions extends unknown[] = unknown[]> = Severity | [Severity, ...Partial<RuleOptions>];
|
|
100
|
+
/**
|
|
101
|
+
* Rule context.
|
|
102
|
+
* @since 0.0.1
|
|
103
|
+
*/
|
|
104
|
+
type RuleContext<MessageIds extends string = string, Options extends readonly unknown[] = readonly unknown[]> = tseslint.RuleContext<MessageIds, Options>;
|
|
105
|
+
/**
|
|
106
|
+
* Rule feature.
|
|
107
|
+
* @since 1.20.0
|
|
108
|
+
*/
|
|
109
|
+
type RuleFeature = "CFG" | "DBG" | "FIX" | "MOD" | "TSC" | "EXP";
|
|
110
|
+
type RulePolicy = number;
|
|
111
|
+
type RuleSuggest<MessageIds extends string = string> = {
|
|
112
|
+
messageId: MessageIds;
|
|
113
|
+
data?: Record<string, unknown>;
|
|
114
|
+
fix: tseslint.ReportFixFunction;
|
|
115
|
+
};
|
|
116
|
+
/**
|
|
117
|
+
* A collection of settings.
|
|
118
|
+
*/
|
|
119
|
+
interface SettingsConfig {
|
|
120
|
+
[key: string]: unknown;
|
|
121
|
+
}
|
|
122
|
+
interface CompatibleRule {
|
|
123
|
+
meta: Record<string, any>;
|
|
124
|
+
create: (...args: any[]) => any;
|
|
125
|
+
}
|
|
126
|
+
interface CompatiblePlugin {
|
|
127
|
+
meta: {
|
|
128
|
+
name: string;
|
|
129
|
+
version: string;
|
|
130
|
+
};
|
|
131
|
+
rules: Record<string, CompatibleRule>;
|
|
132
|
+
}
|
|
133
|
+
interface CompatibleConfig {
|
|
134
|
+
name?: string;
|
|
135
|
+
rules?: Record<string, RuleConfig>;
|
|
136
|
+
settings?: SettingsConfig;
|
|
137
|
+
}
|
|
138
|
+
//#endregion
|
|
139
|
+
//#region src/utils/regexp.d.ts
|
|
168
140
|
/**
|
|
169
141
|
* Convert a string to the `RegExp`.
|
|
170
142
|
* Normal strings (e.g. `"foo"`) is converted to `/^foo$/` of `RegExp`.
|
|
@@ -174,7 +146,7 @@ declare const HOOK_NAME: RegExp;
|
|
|
174
146
|
* @returns Returns the `RegExp`.
|
|
175
147
|
*/
|
|
176
148
|
declare function toRegExp(string: string): {
|
|
177
|
-
|
|
149
|
+
test(s: string): boolean;
|
|
178
150
|
};
|
|
179
151
|
/**
|
|
180
152
|
* Checks whether given string is regexp string
|
|
@@ -182,82 +154,8 @@ declare function toRegExp(string: string): {
|
|
|
182
154
|
* @returns boolean
|
|
183
155
|
*/
|
|
184
156
|
declare function isRegExp(string: string): boolean;
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
declare
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
declare const RegExp$1_CAMEL_CASE: typeof CAMEL_CASE;
|
|
191
|
-
declare const RegExp$1_COMPONENT_NAME: typeof COMPONENT_NAME;
|
|
192
|
-
declare const RegExp$1_COMPONENT_NAME_LOOSE: typeof COMPONENT_NAME_LOOSE;
|
|
193
|
-
declare const RegExp$1_CONSTANT_CASE: typeof CONSTANT_CASE;
|
|
194
|
-
declare const RegExp$1_HOOK_NAME: typeof HOOK_NAME;
|
|
195
|
-
declare const RegExp$1_HTML_TAG: typeof HTML_TAG;
|
|
196
|
-
declare const RegExp$1_JAVASCRIPT_PROTOCOL: typeof JAVASCRIPT_PROTOCOL;
|
|
197
|
-
declare const RegExp$1_JS_EXT: typeof JS_EXT;
|
|
198
|
-
declare const RegExp$1_JS_IDENTIFIER: typeof JS_IDENTIFIER;
|
|
199
|
-
declare const RegExp$1_KEBAB_CASE: typeof KEBAB_CASE;
|
|
200
|
-
declare const RegExp$1_PASCAL_CASE: typeof PASCAL_CASE;
|
|
201
|
-
declare const RegExp$1_REGEXP_STR: typeof REGEXP_STR;
|
|
202
|
-
declare const RegExp$1_SNAKE_CASE: typeof SNAKE_CASE;
|
|
203
|
-
declare const RegExp$1_TS_EXT: typeof TS_EXT;
|
|
204
|
-
declare const RegExp$1_isRegExp: typeof isRegExp;
|
|
205
|
-
declare const RegExp$1_toRegExp: typeof toRegExp;
|
|
206
|
-
declare namespace RegExp$1 {
|
|
207
|
-
export { RegExp$1_ANNOTATION_JSX as ANNOTATION_JSX, RegExp$1_ANNOTATION_JSX_FRAG as ANNOTATION_JSX_FRAG, RegExp$1_ANNOTATION_JSX_IMPORT_SOURCE as ANNOTATION_JSX_IMPORT_SOURCE, RegExp$1_ANNOTATION_JSX_RUNTIME as ANNOTATION_JSX_RUNTIME, RegExp$1_CAMEL_CASE as CAMEL_CASE, RegExp$1_COMPONENT_NAME as COMPONENT_NAME, RegExp$1_COMPONENT_NAME_LOOSE as COMPONENT_NAME_LOOSE, RegExp$1_CONSTANT_CASE as CONSTANT_CASE, RegExp$1_HOOK_NAME as HOOK_NAME, RegExp$1_HTML_TAG as HTML_TAG, RegExp$1_JAVASCRIPT_PROTOCOL as JAVASCRIPT_PROTOCOL, RegExp$1_JS_EXT as JS_EXT, RegExp$1_JS_IDENTIFIER as JS_IDENTIFIER, RegExp$1_KEBAB_CASE as KEBAB_CASE, RegExp$1_PASCAL_CASE as PASCAL_CASE, RegExp$1_REGEXP_STR as REGEXP_STR, RegExp$1_SNAKE_CASE as SNAKE_CASE, RegExp$1_TS_EXT as TS_EXT, RegExp$1_isRegExp as isRegExp, RegExp$1_toRegExp as toRegExp };
|
|
208
|
-
}
|
|
209
|
-
|
|
210
|
-
interface Reporter<TMessageID extends string> {
|
|
211
|
-
send: (descriptor: _ | null | ReportDescriptor<TMessageID>) => void;
|
|
212
|
-
sendOrElse: <TElse>(descriptor: _ | null | ReportDescriptor<TMessageID>, cb: () => TElse) => _ | TElse;
|
|
213
|
-
}
|
|
214
|
-
declare const send: {
|
|
215
|
-
<TMessageID extends string>(context: RuleContext, descriptor: _ | null | ReportDescriptor<TMessageID>): void;
|
|
216
|
-
<TMessageID extends string>(context: RuleContext): (descriptor: _ | null | ReportDescriptor<TMessageID>) => void;
|
|
217
|
-
};
|
|
218
|
-
declare const sendOrElse: {
|
|
219
|
-
<TMessageID extends string, TElse>(context: RuleContext, descriptor: _ | null | ReportDescriptor<TMessageID>, cb: () => TElse): _ | TElse;
|
|
220
|
-
<TMessageID extends string, TElse>(context: RuleContext): (descriptor: _ | null | ReportDescriptor<TMessageID>) => (cb: () => TElse) => _ | TElse;
|
|
221
|
-
};
|
|
222
|
-
declare function make<TMessageID extends string>(context: RuleContext): Reporter<TMessageID>;
|
|
223
|
-
|
|
224
|
-
type Reporter$1_Reporter<TMessageID extends string> = Reporter<TMessageID>;
|
|
225
|
-
declare const Reporter$1_make: typeof make;
|
|
226
|
-
declare const Reporter$1_send: typeof send;
|
|
227
|
-
declare const Reporter$1_sendOrElse: typeof sendOrElse;
|
|
228
|
-
declare namespace Reporter$1 {
|
|
229
|
-
export { type Reporter$1_Reporter as Reporter, Reporter$1_make as make, Reporter$1_send as send, Reporter$1_sendOrElse as sendOrElse };
|
|
230
|
-
}
|
|
231
|
-
|
|
232
|
-
type ImplicitReturnArrowFunctionExpression = TSESTree.ArrowFunctionExpression & {
|
|
233
|
-
body: TSESTree.Expression;
|
|
234
|
-
};
|
|
235
|
-
type ObjectDestructuringVariableDeclarator = TSESTree.VariableDeclarator & {
|
|
236
|
-
id: TSESTree.ObjectPattern;
|
|
237
|
-
init: TSESTree.Identifier;
|
|
238
|
-
};
|
|
239
|
-
type DisplayNameAssignmentExpression = TSESTree.AssignmentExpression & {
|
|
240
|
-
type: "AssignmentExpression";
|
|
241
|
-
left: TSESTree.MemberExpression & {
|
|
242
|
-
property: TSESTree.Identifier & {
|
|
243
|
-
name: "displayName";
|
|
244
|
-
};
|
|
245
|
-
};
|
|
246
|
-
operator: "=";
|
|
247
|
-
right: TSESTree.Literal;
|
|
248
|
-
};
|
|
249
|
-
declare const IMPLICIT_RETURN_ARROW_FUNCTION_EXPRESSION = "ArrowFunctionExpression[body.type!='BlockStatement']";
|
|
250
|
-
declare const OBJECT_DESTRUCTURING_VARIABLE_DECLARATOR: string;
|
|
251
|
-
declare const DISPLAY_NAME_ASSIGNMENT_EXPRESSION: string;
|
|
252
|
-
|
|
253
|
-
declare const Selector_DISPLAY_NAME_ASSIGNMENT_EXPRESSION: typeof DISPLAY_NAME_ASSIGNMENT_EXPRESSION;
|
|
254
|
-
type Selector_DisplayNameAssignmentExpression = DisplayNameAssignmentExpression;
|
|
255
|
-
declare const Selector_IMPLICIT_RETURN_ARROW_FUNCTION_EXPRESSION: typeof IMPLICIT_RETURN_ARROW_FUNCTION_EXPRESSION;
|
|
256
|
-
type Selector_ImplicitReturnArrowFunctionExpression = ImplicitReturnArrowFunctionExpression;
|
|
257
|
-
declare const Selector_OBJECT_DESTRUCTURING_VARIABLE_DECLARATOR: typeof OBJECT_DESTRUCTURING_VARIABLE_DECLARATOR;
|
|
258
|
-
type Selector_ObjectDestructuringVariableDeclarator = ObjectDestructuringVariableDeclarator;
|
|
259
|
-
declare namespace Selector {
|
|
260
|
-
export { Selector_DISPLAY_NAME_ASSIGNMENT_EXPRESSION as DISPLAY_NAME_ASSIGNMENT_EXPRESSION, type Selector_DisplayNameAssignmentExpression as DisplayNameAssignmentExpression, Selector_IMPLICIT_RETURN_ARROW_FUNCTION_EXPRESSION as IMPLICIT_RETURN_ARROW_FUNCTION_EXPRESSION, type Selector_ImplicitReturnArrowFunctionExpression as ImplicitReturnArrowFunctionExpression, Selector_OBJECT_DESTRUCTURING_VARIABLE_DECLARATOR as OBJECT_DESTRUCTURING_VARIABLE_DECLARATOR, type Selector_ObjectDestructuringVariableDeclarator as ObjectDestructuringVariableDeclarator };
|
|
261
|
-
}
|
|
262
|
-
|
|
263
|
-
export { index$1 as JsxConfig, index as LanguagePreference, RegExp$1 as RegExp, Reporter$1 as Reporter, type RuleContext, type RuleDeclaration, type RuleFeature, type RulePreset, type RuleSeverity, Selector };
|
|
157
|
+
//#endregion
|
|
158
|
+
//#region src/utils/reporting.d.ts
|
|
159
|
+
declare function report(context: RuleContext): (descriptor: unit | null | ReportDescriptor<string>) => void;
|
|
160
|
+
//#endregion
|
|
161
|
+
export { CompatibleConfig, CompatiblePlugin, CompatibleRule, RE_ANNOTATION_JSX, RE_ANNOTATION_JSX_FRAG, RE_ANNOTATION_JSX_IMPORT_SOURCE, RE_ANNOTATION_JSX_RUNTIME, RE_CAMEL_CASE, RE_COMPONENT_NAME, RE_COMPONENT_NAME_LOOSE, RE_CONSTANT_CASE, RE_HOOK_NAME, RE_HTML_TAG, RE_JAVASCRIPT_PROTOCOL, RE_JS_EXT, RE_JS_IDENTIFIER, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_REGEXP_STR, RE_SNAKE_CASE, RE_TS_EXT, RuleConfig, RuleContext, RuleFeature, RulePolicy, RuleSuggest, SettingsConfig, Severity, SeverityLevel, SeverityName, isRegExp, report, toRegExp };
|
package/dist/index.js
CHANGED
|
@@ -1,209 +1,108 @@
|
|
|
1
|
-
import
|
|
2
|
-
import { JsxEmit } from 'typescript';
|
|
3
|
-
import * as z from '@zod/mini';
|
|
1
|
+
import "@eslint-react/eff";
|
|
4
2
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
3
|
+
//#region src/constants.ts
|
|
4
|
+
/**
|
|
5
|
+
* Regular expressions for matching a HTML tag name
|
|
6
|
+
*/
|
|
7
|
+
const RE_HTML_TAG = /^[a-z][^-]*$/u;
|
|
8
|
+
/**
|
|
9
|
+
* Regular expression for matching a TypeScript file extension.
|
|
10
|
+
*/
|
|
11
|
+
const RE_TS_EXT = /^[cm]?tsx?$/u;
|
|
12
|
+
/**
|
|
13
|
+
* Regular expression for matching a JavaScript file extension.
|
|
14
|
+
*/
|
|
15
|
+
const RE_JS_EXT = /^[cm]?jsx?$/u;
|
|
16
|
+
/**
|
|
17
|
+
* Regular expression for matching a PascalCase string.
|
|
18
|
+
*/
|
|
19
|
+
const RE_PASCAL_CASE = /^[A-Z][\dA-Za-z]*$/u;
|
|
20
|
+
/**
|
|
21
|
+
* Regular expression for matching a camelCase string.
|
|
22
|
+
*/
|
|
23
|
+
const RE_CAMEL_CASE = /^[a-z][\dA-Za-z]*$/u;
|
|
24
|
+
/**
|
|
25
|
+
* Regular expression for matching a kebab-case string.
|
|
26
|
+
*/
|
|
27
|
+
const RE_KEBAB_CASE = /^[a-z][\d\-a-z]*$/u;
|
|
28
|
+
/**
|
|
29
|
+
* Regular expression for matching a snake_case string.
|
|
30
|
+
*/
|
|
31
|
+
const RE_SNAKE_CASE = /^[a-z][\d_a-z]*$/u;
|
|
32
|
+
/**
|
|
33
|
+
* Regular expression for matching a CONSTANT_CASE string.
|
|
34
|
+
*/
|
|
35
|
+
const RE_CONSTANT_CASE = /^[A-Z][\d_A-Z]*$/u;
|
|
36
|
+
const RE_JAVASCRIPT_PROTOCOL = /^[\u0000-\u001F ]*j[\t\n\r]*a[\t\n\r]*v[\t\n\r]*a[\t\n\r]*s[\t\n\r]*c[\t\n\r]*r[\t\n\r]*i[\t\n\r]*p[\t\n\r]*t[\t\n\r]*:/iu;
|
|
37
|
+
/**
|
|
38
|
+
* Regular expression for matching a valid JavaScript identifier.
|
|
39
|
+
*/
|
|
40
|
+
const RE_JS_IDENTIFIER = /^[_$a-z][\w$]*$/i;
|
|
41
|
+
/**
|
|
42
|
+
* Regular expression for matching a RegExp string.
|
|
43
|
+
*/
|
|
44
|
+
const RE_REGEXP_STR = /^\/(.+)\/([A-Za-z]*)$/u;
|
|
45
|
+
/**
|
|
46
|
+
* Regular expression for matching a `@jsx` annotation comment.
|
|
47
|
+
*/
|
|
48
|
+
const RE_ANNOTATION_JSX = /@jsx\s+(\S+)/u;
|
|
49
|
+
/**
|
|
50
|
+
* Regular expression for matching a `@jsxFrag` annotation comment.
|
|
51
|
+
*/
|
|
52
|
+
const RE_ANNOTATION_JSX_FRAG = /@jsxFrag\s+(\S+)/u;
|
|
53
|
+
/**
|
|
54
|
+
* Regular expression for matching a `@jsxRuntime` annotation comment.
|
|
55
|
+
*/
|
|
56
|
+
const RE_ANNOTATION_JSX_RUNTIME = /@jsxRuntime\s+(\S+)/u;
|
|
57
|
+
/**
|
|
58
|
+
* Regular expression for matching a `@jsxImportSource` annotation comment.
|
|
59
|
+
*/
|
|
60
|
+
const RE_ANNOTATION_JSX_IMPORT_SOURCE = /@jsxImportSource\s+(\S+)/u;
|
|
61
|
+
/**
|
|
62
|
+
* Regular expression for matching a React component name.
|
|
63
|
+
*/
|
|
64
|
+
const RE_COMPONENT_NAME = /^[A-Z]/u;
|
|
65
|
+
/**
|
|
66
|
+
* Regular expression for matching a React component name (loose).
|
|
67
|
+
*/
|
|
68
|
+
const RE_COMPONENT_NAME_LOOSE = /^_?[A-Z]/u;
|
|
69
|
+
/**
|
|
70
|
+
* Regular expression for matching a React Hook name.
|
|
71
|
+
*/
|
|
72
|
+
const RE_HOOK_NAME = /^use/u;
|
|
10
73
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
__export(RegExp_exports, {
|
|
22
|
-
ANNOTATION_JSX: () => ANNOTATION_JSX,
|
|
23
|
-
ANNOTATION_JSX_FRAG: () => ANNOTATION_JSX_FRAG,
|
|
24
|
-
ANNOTATION_JSX_IMPORT_SOURCE: () => ANNOTATION_JSX_IMPORT_SOURCE,
|
|
25
|
-
ANNOTATION_JSX_RUNTIME: () => ANNOTATION_JSX_RUNTIME,
|
|
26
|
-
CAMEL_CASE: () => CAMEL_CASE,
|
|
27
|
-
COMPONENT_NAME: () => COMPONENT_NAME,
|
|
28
|
-
COMPONENT_NAME_LOOSE: () => COMPONENT_NAME_LOOSE,
|
|
29
|
-
CONSTANT_CASE: () => CONSTANT_CASE,
|
|
30
|
-
HOOK_NAME: () => HOOK_NAME,
|
|
31
|
-
HTML_TAG: () => HTML_TAG,
|
|
32
|
-
JAVASCRIPT_PROTOCOL: () => JAVASCRIPT_PROTOCOL,
|
|
33
|
-
JS_EXT: () => JS_EXT,
|
|
34
|
-
JS_IDENTIFIER: () => JS_IDENTIFIER,
|
|
35
|
-
KEBAB_CASE: () => KEBAB_CASE,
|
|
36
|
-
PASCAL_CASE: () => PASCAL_CASE,
|
|
37
|
-
REGEXP_STR: () => REGEXP_STR,
|
|
38
|
-
SNAKE_CASE: () => SNAKE_CASE,
|
|
39
|
-
TS_EXT: () => TS_EXT,
|
|
40
|
-
isRegExp: () => isRegExp,
|
|
41
|
-
toRegExp: () => toRegExp
|
|
42
|
-
});
|
|
43
|
-
var HTML_TAG = /^[a-z][^-]*$/u;
|
|
44
|
-
var TS_EXT = /^[cm]?tsx?$/u;
|
|
45
|
-
var JS_EXT = /^[cm]?jsx?$/u;
|
|
46
|
-
var PASCAL_CASE = /^[A-Z][\dA-Za-z]*$/u;
|
|
47
|
-
var CAMEL_CASE = /^[a-z][\dA-Za-z]*$/u;
|
|
48
|
-
var KEBAB_CASE = /^[a-z][\d\-a-z]*$/u;
|
|
49
|
-
var SNAKE_CASE = /^[a-z][\d_a-z]*$/u;
|
|
50
|
-
var CONSTANT_CASE = /^[A-Z][\d_A-Z]*$/u;
|
|
51
|
-
var JAVASCRIPT_PROTOCOL = /^[\u0000-\u001F ]*j[\t\n\r]*a[\t\n\r]*v[\t\n\r]*a[\t\n\r]*s[\t\n\r]*c[\t\n\r]*r[\t\n\r]*i[\t\n\r]*p[\t\n\r]*t[\t\n\r]*:/iu;
|
|
52
|
-
var JS_IDENTIFIER = /^[_$a-z][\w$]*$/i;
|
|
53
|
-
var REGEXP_STR = /^\/(.+)\/([A-Za-z]*)$/u;
|
|
54
|
-
var ANNOTATION_JSX = /@jsx\s+(\S+)/u;
|
|
55
|
-
var ANNOTATION_JSX_FRAG = /@jsxFrag\s+(\S+)/u;
|
|
56
|
-
var ANNOTATION_JSX_RUNTIME = /@jsxRuntime\s+(\S+)/u;
|
|
57
|
-
var ANNOTATION_JSX_IMPORT_SOURCE = /@jsxImportSource\s+(\S+)/u;
|
|
58
|
-
var COMPONENT_NAME = /^[A-Z]/u;
|
|
59
|
-
var COMPONENT_NAME_LOOSE = /^_?[A-Z]/u;
|
|
60
|
-
var HOOK_NAME = /^use/u;
|
|
74
|
+
//#endregion
|
|
75
|
+
//#region src/utils/regexp.ts
|
|
76
|
+
/**
|
|
77
|
+
* Convert a string to the `RegExp`.
|
|
78
|
+
* Normal strings (e.g. `"foo"`) is converted to `/^foo$/` of `RegExp`.
|
|
79
|
+
* Strings like `"/^foo/i"` are converted to `/^foo/i` of `RegExp`.
|
|
80
|
+
* @see https://github.com/sveltejs/eslint-plugin-svelte/blob/main/packages/eslint-plugin-svelte/src/utils/regexp.ts
|
|
81
|
+
* @param string The string to convert.
|
|
82
|
+
* @returns Returns the `RegExp`.
|
|
83
|
+
*/
|
|
61
84
|
function toRegExp(string) {
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
85
|
+
const [, pattern, flags = "u"] = RE_REGEXP_STR.exec(string) ?? [];
|
|
86
|
+
if (pattern != null) return new RegExp(pattern, flags);
|
|
87
|
+
return { test: (s) => s === string };
|
|
65
88
|
}
|
|
89
|
+
/**
|
|
90
|
+
* Checks whether given string is regexp string
|
|
91
|
+
* @param string The string to check
|
|
92
|
+
* @returns boolean
|
|
93
|
+
*/
|
|
66
94
|
function isRegExp(string) {
|
|
67
|
-
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
// src/JsxConfig/JsxConfig.ts
|
|
71
|
-
function make() {
|
|
72
|
-
return {};
|
|
73
|
-
}
|
|
74
|
-
function getFromContext(context) {
|
|
75
|
-
const options = context.sourceCode.parserServices?.program?.getCompilerOptions() ?? {};
|
|
76
|
-
return {
|
|
77
|
-
jsx: options.jsx ?? JsxEmit.ReactJSX,
|
|
78
|
-
jsxFactory: options.jsxFactory ?? "React.createElement",
|
|
79
|
-
jsxFragmentFactory: options.jsxFragmentFactory ?? "React.Fragment",
|
|
80
|
-
jsxImportSource: options.jsxImportSource ?? "react",
|
|
81
|
-
reactNamespace: options.reactNamespace ?? "React"
|
|
82
|
-
};
|
|
83
|
-
}
|
|
84
|
-
var cache = /* @__PURE__ */ new WeakMap();
|
|
85
|
-
function getFromAnnotation(context) {
|
|
86
|
-
return getOrElseUpdate(
|
|
87
|
-
cache,
|
|
88
|
-
context.sourceCode,
|
|
89
|
-
() => {
|
|
90
|
-
const options = make();
|
|
91
|
-
if (!context.sourceCode.text.includes("@jsx")) return options;
|
|
92
|
-
let jsx, jsxFrag, jsxRuntime, jsxImportSource;
|
|
93
|
-
for (const comment of context.sourceCode.getAllComments().reverse()) {
|
|
94
|
-
const value = comment.value;
|
|
95
|
-
jsx ??= value.match(ANNOTATION_JSX)?.[1];
|
|
96
|
-
jsxFrag ??= value.match(ANNOTATION_JSX_FRAG)?.[1];
|
|
97
|
-
jsxRuntime ??= value.match(ANNOTATION_JSX_RUNTIME)?.[1];
|
|
98
|
-
jsxImportSource ??= value.match(ANNOTATION_JSX_IMPORT_SOURCE)?.[1];
|
|
99
|
-
}
|
|
100
|
-
if (jsx != null) options.jsxFactory = jsx;
|
|
101
|
-
if (jsxFrag != null) options.jsxFragmentFactory = jsxFrag;
|
|
102
|
-
if (jsxRuntime != null) options.jsx = jsxRuntime === "classic" ? JsxEmit.React : JsxEmit.ReactJSX;
|
|
103
|
-
if (jsxImportSource != null) options.jsxImportSource = jsxImportSource;
|
|
104
|
-
return options;
|
|
105
|
-
}
|
|
106
|
-
);
|
|
95
|
+
return RE_REGEXP_STR.test(string);
|
|
107
96
|
}
|
|
108
97
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
}
|
|
116
|
-
|
|
117
|
-
// src/LanguagePreference/LanguagePreference.ts
|
|
118
|
-
function make2() {
|
|
119
|
-
return {
|
|
120
|
-
indentStyle: "space",
|
|
121
|
-
indentWidth: 2,
|
|
122
|
-
jsxQuoteStyle: "double",
|
|
123
|
-
quoteStyle: "single",
|
|
124
|
-
semicolons: "always",
|
|
125
|
-
trailingCommas: "all"
|
|
126
|
-
};
|
|
127
|
-
}
|
|
128
|
-
function getFromContext2() {
|
|
129
|
-
throw new Error("getFromContext is not implemented");
|
|
98
|
+
//#endregion
|
|
99
|
+
//#region src/utils/reporting.ts
|
|
100
|
+
function report(context) {
|
|
101
|
+
return (descriptor) => {
|
|
102
|
+
if (descriptor == null) return;
|
|
103
|
+
return context.report(descriptor);
|
|
104
|
+
};
|
|
130
105
|
}
|
|
131
|
-
var LanguagePreferenceSchema = z.object({
|
|
132
|
-
indentStyle: z.optional(
|
|
133
|
-
z.union([
|
|
134
|
-
z.literal("tab"),
|
|
135
|
-
z.literal("space")
|
|
136
|
-
])
|
|
137
|
-
),
|
|
138
|
-
indentWidth: z.optional(z.number()),
|
|
139
|
-
quoteStyle: z.optional(
|
|
140
|
-
z.union([
|
|
141
|
-
z.literal("single"),
|
|
142
|
-
z.literal("double")
|
|
143
|
-
])
|
|
144
|
-
),
|
|
145
|
-
semicolons: z.optional(
|
|
146
|
-
z.union([
|
|
147
|
-
z.literal("always"),
|
|
148
|
-
z.literal("asNeeded")
|
|
149
|
-
])
|
|
150
|
-
),
|
|
151
|
-
trailingCommas: z.optional(
|
|
152
|
-
z.union([
|
|
153
|
-
z.literal("all"),
|
|
154
|
-
z.literal("es5"),
|
|
155
|
-
z.literal("none")
|
|
156
|
-
])
|
|
157
|
-
),
|
|
158
|
-
// JSX specific options
|
|
159
|
-
jsxQuoteStyle: z.optional(
|
|
160
|
-
z.union([
|
|
161
|
-
z.literal("single"),
|
|
162
|
-
z.literal("double")
|
|
163
|
-
])
|
|
164
|
-
)
|
|
165
|
-
}, {});
|
|
166
|
-
|
|
167
|
-
// src/Reporter.ts
|
|
168
|
-
var Reporter_exports = {};
|
|
169
|
-
__export(Reporter_exports, {
|
|
170
|
-
make: () => make3,
|
|
171
|
-
send: () => send,
|
|
172
|
-
sendOrElse: () => sendOrElse
|
|
173
|
-
});
|
|
174
|
-
var send = dual(2, (context, descriptor) => {
|
|
175
|
-
if (descriptor == null) return;
|
|
176
|
-
return context.report(descriptor);
|
|
177
|
-
});
|
|
178
|
-
var sendOrElse = dual(3, (context, descriptor, cb) => {
|
|
179
|
-
if (descriptor == null) return cb();
|
|
180
|
-
return context.report(descriptor);
|
|
181
|
-
});
|
|
182
|
-
function make3(context) {
|
|
183
|
-
return {
|
|
184
|
-
send: (...args) => send(context, ...args),
|
|
185
|
-
sendOrElse: (...args) => sendOrElse(context, ...args)
|
|
186
|
-
};
|
|
187
|
-
}
|
|
188
|
-
|
|
189
|
-
// src/Selector.ts
|
|
190
|
-
var Selector_exports = {};
|
|
191
|
-
__export(Selector_exports, {
|
|
192
|
-
DISPLAY_NAME_ASSIGNMENT_EXPRESSION: () => DISPLAY_NAME_ASSIGNMENT_EXPRESSION,
|
|
193
|
-
IMPLICIT_RETURN_ARROW_FUNCTION_EXPRESSION: () => IMPLICIT_RETURN_ARROW_FUNCTION_EXPRESSION,
|
|
194
|
-
OBJECT_DESTRUCTURING_VARIABLE_DECLARATOR: () => OBJECT_DESTRUCTURING_VARIABLE_DECLARATOR
|
|
195
|
-
});
|
|
196
|
-
var IMPLICIT_RETURN_ARROW_FUNCTION_EXPRESSION = "ArrowFunctionExpression[body.type!='BlockStatement']";
|
|
197
|
-
var OBJECT_DESTRUCTURING_VARIABLE_DECLARATOR = [
|
|
198
|
-
"VariableDeclarator",
|
|
199
|
-
"[id.type='ObjectPattern']",
|
|
200
|
-
"[init.type='Identifier']"
|
|
201
|
-
].join("");
|
|
202
|
-
var DISPLAY_NAME_ASSIGNMENT_EXPRESSION = [
|
|
203
|
-
"AssignmentExpression",
|
|
204
|
-
"[operator='=']",
|
|
205
|
-
"[left.type='MemberExpression']",
|
|
206
|
-
"[left.property.name='displayName']"
|
|
207
|
-
].join("");
|
|
208
106
|
|
|
209
|
-
|
|
107
|
+
//#endregion
|
|
108
|
+
export { RE_ANNOTATION_JSX, RE_ANNOTATION_JSX_FRAG, RE_ANNOTATION_JSX_IMPORT_SOURCE, RE_ANNOTATION_JSX_RUNTIME, RE_CAMEL_CASE, RE_COMPONENT_NAME, RE_COMPONENT_NAME_LOOSE, RE_CONSTANT_CASE, RE_HOOK_NAME, RE_HTML_TAG, RE_JAVASCRIPT_PROTOCOL, RE_JS_EXT, RE_JS_IDENTIFIER, RE_KEBAB_CASE, RE_PASCAL_CASE, RE_REGEXP_STR, RE_SNAKE_CASE, RE_TS_EXT, isRegExp, report, toRegExp };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@eslint-react/kit",
|
|
3
|
-
"version": "2.0.0-next.
|
|
3
|
+
"version": "2.0.0-next.200",
|
|
4
4
|
"description": "ESLint React's plugin kit for building plugins and rules.",
|
|
5
5
|
"homepage": "https://github.com/Rel1cx/eslint-react",
|
|
6
6
|
"bugs": {
|
|
@@ -27,23 +27,22 @@
|
|
|
27
27
|
"./package.json"
|
|
28
28
|
],
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@typescript-eslint/utils": "^8.
|
|
31
|
-
"
|
|
32
|
-
"
|
|
33
|
-
"@eslint-react/eff": "2.0.0-next.
|
|
30
|
+
"@typescript-eslint/utils": "^8.44.1",
|
|
31
|
+
"ts-pattern": "^5.8.0",
|
|
32
|
+
"zod": "^4.1.11",
|
|
33
|
+
"@eslint-react/eff": "2.0.0-next.200"
|
|
34
34
|
},
|
|
35
35
|
"devDependencies": {
|
|
36
|
-
"@tsconfig/node22": "^22.0.
|
|
37
|
-
"
|
|
38
|
-
"type-fest": "^
|
|
36
|
+
"@tsconfig/node22": "^22.0.2",
|
|
37
|
+
"tsdown": "^0.15.4",
|
|
38
|
+
"type-fest": "^5.0.1",
|
|
39
39
|
"@local/configs": "0.0.0"
|
|
40
40
|
},
|
|
41
41
|
"engines": {
|
|
42
|
-
"bun": ">=1.0.15",
|
|
43
42
|
"node": ">=20.19.0"
|
|
44
43
|
},
|
|
45
44
|
"scripts": {
|
|
46
|
-
"build": "
|
|
45
|
+
"build": "tsdown --dts-resolve",
|
|
47
46
|
"build:docs": "typedoc",
|
|
48
47
|
"lint:publish": "publint",
|
|
49
48
|
"lint:ts": "tsc --noEmit"
|