eslint-plugin-primer-react 6.0.2 → 6.1.0-rc.b2a68e1
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/.eslintignore +2 -0
- package/CHANGELOG.md +6 -0
- package/docs/rules/no-wildcard-imports.md +25 -0
- package/package-lock.json +14002 -0
- package/package.json +3 -3
- package/src/index.js +1 -0
- package/src/rules/__tests__/no-wildcard-imports.test.js +363 -0
- package/src/rules/no-wildcard-imports.js +368 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "eslint-plugin-primer-react",
|
|
3
|
-
"version": "6.0.
|
|
3
|
+
"version": "6.1.0-rc.b2a68e1",
|
|
4
4
|
"description": "ESLint rules for Primer React",
|
|
5
5
|
"main": "src/index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -45,8 +45,8 @@
|
|
|
45
45
|
"eslint": "^8.42.0",
|
|
46
46
|
"eslint-plugin-prettier": "^5.0.1",
|
|
47
47
|
"jest": "^29.7.0",
|
|
48
|
-
"markdownlint-cli2": "^0.
|
|
49
|
-
"markdownlint-cli2-formatter-pretty": "^0.0.
|
|
48
|
+
"markdownlint-cli2": "^0.14.0",
|
|
49
|
+
"markdownlint-cli2-formatter-pretty": "^0.0.7",
|
|
50
50
|
"@typescript-eslint/rule-tester": "7.16.0",
|
|
51
51
|
"@types/jest": "^29.5.12"
|
|
52
52
|
},
|
package/src/index.js
CHANGED
|
@@ -11,6 +11,7 @@ module.exports = {
|
|
|
11
11
|
'a11y-remove-disable-tooltip': require('./rules/a11y-remove-disable-tooltip'),
|
|
12
12
|
'a11y-use-next-tooltip': require('./rules/a11y-use-next-tooltip'),
|
|
13
13
|
'use-deprecated-from-deprecated': require('./rules/use-deprecated-from-deprecated'),
|
|
14
|
+
'no-wildcard-imports': require('./rules/no-wildcard-imports'),
|
|
14
15
|
'no-unnecessary-components': require('./rules/no-unnecessary-components'),
|
|
15
16
|
'prefer-action-list-item-onselect': require('./rules/prefer-action-list-item-onselect'),
|
|
16
17
|
},
|
|
@@ -0,0 +1,363 @@
|
|
|
1
|
+
'use strict'
|
|
2
|
+
|
|
3
|
+
const {RuleTester} = require('eslint')
|
|
4
|
+
const rule = require('../no-wildcard-imports')
|
|
5
|
+
|
|
6
|
+
const ruleTester = new RuleTester({
|
|
7
|
+
parser: require.resolve('@typescript-eslint/parser'),
|
|
8
|
+
parserOptions: {
|
|
9
|
+
ecmaVersion: 'latest',
|
|
10
|
+
sourceType: 'module',
|
|
11
|
+
ecmaFeatures: {
|
|
12
|
+
jsx: true,
|
|
13
|
+
},
|
|
14
|
+
},
|
|
15
|
+
})
|
|
16
|
+
|
|
17
|
+
ruleTester.run('no-wildcard-imports', rule, {
|
|
18
|
+
valid: [`import {Button} from '@primer/react'`],
|
|
19
|
+
invalid: [
|
|
20
|
+
// Test unknown path from wildcard import
|
|
21
|
+
{
|
|
22
|
+
code: `import type {UnknownImport} from '@primer/react/lib-esm/unknown-path'`,
|
|
23
|
+
errors: [
|
|
24
|
+
{
|
|
25
|
+
messageId: 'unknownWildcardImport',
|
|
26
|
+
},
|
|
27
|
+
],
|
|
28
|
+
},
|
|
29
|
+
|
|
30
|
+
// Test type import
|
|
31
|
+
{
|
|
32
|
+
code: `import type {SxProp} from '@primer/react/lib-esm/sx'`,
|
|
33
|
+
output: `import type {SxProp} from '@primer/react'`,
|
|
34
|
+
errors: [
|
|
35
|
+
{
|
|
36
|
+
messageId: 'wildcardMigration',
|
|
37
|
+
data: {
|
|
38
|
+
wildcardEntrypoint: '@primer/react/lib-esm/sx',
|
|
39
|
+
},
|
|
40
|
+
},
|
|
41
|
+
],
|
|
42
|
+
},
|
|
43
|
+
|
|
44
|
+
// Test multiple type imports
|
|
45
|
+
{
|
|
46
|
+
code: `import type {BetterSystemStyleObject, SxProp, BetterCssProperties} from '@primer/react/lib-esm/sx'`,
|
|
47
|
+
output: `import type {BetterSystemStyleObject, SxProp, BetterCssProperties} from '@primer/react'`,
|
|
48
|
+
errors: [
|
|
49
|
+
{
|
|
50
|
+
messageId: 'wildcardMigration',
|
|
51
|
+
data: {
|
|
52
|
+
wildcardEntrypoint: '@primer/react/lib-esm/sx',
|
|
53
|
+
},
|
|
54
|
+
},
|
|
55
|
+
],
|
|
56
|
+
},
|
|
57
|
+
|
|
58
|
+
// Test import alias
|
|
59
|
+
{
|
|
60
|
+
code: `import type {SxProp as RenamedSxProp} from '@primer/react/lib-esm/sx'`,
|
|
61
|
+
output: `import type {SxProp as RenamedSxProp} from '@primer/react'`,
|
|
62
|
+
errors: [
|
|
63
|
+
{
|
|
64
|
+
messageId: 'wildcardMigration',
|
|
65
|
+
data: {
|
|
66
|
+
wildcardEntrypoint: '@primer/react/lib-esm/sx',
|
|
67
|
+
},
|
|
68
|
+
},
|
|
69
|
+
],
|
|
70
|
+
},
|
|
71
|
+
|
|
72
|
+
// Test default import
|
|
73
|
+
{
|
|
74
|
+
code: `import useIsomorphicLayoutEffect from '@primer/react/lib-esm/useIsomorphicLayoutEffect'`,
|
|
75
|
+
output: `import {useIsomorphicLayoutEffect} from '@primer/react'`,
|
|
76
|
+
errors: [
|
|
77
|
+
{
|
|
78
|
+
messageId: 'wildcardMigration',
|
|
79
|
+
data: {
|
|
80
|
+
wildcardEntrypoint: '@primer/react/lib-esm/useIsomorphicLayoutEffect',
|
|
81
|
+
},
|
|
82
|
+
},
|
|
83
|
+
],
|
|
84
|
+
},
|
|
85
|
+
|
|
86
|
+
// Test multiple wildcard imports into single entrypoint
|
|
87
|
+
{
|
|
88
|
+
code: `import useResizeObserver from '@primer/react/lib-esm/hooks/useResizeObserver'
|
|
89
|
+
import useIsomorphicLayoutEffect from '@primer/react/lib-esm/useIsomorphicLayoutEffect'`,
|
|
90
|
+
output: `import {useResizeObserver} from '@primer/react'
|
|
91
|
+
import {useIsomorphicLayoutEffect} from '@primer/react'`,
|
|
92
|
+
errors: [
|
|
93
|
+
{
|
|
94
|
+
messageId: 'wildcardMigration',
|
|
95
|
+
data: {
|
|
96
|
+
wildcardEntrypoint: '@primer/react/lib-esm/hooks/useResizeObserver',
|
|
97
|
+
},
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
messageId: 'wildcardMigration',
|
|
101
|
+
data: {
|
|
102
|
+
wildcardEntrypoint: '@primer/react/lib-esm/useIsomorphicLayoutEffect',
|
|
103
|
+
},
|
|
104
|
+
},
|
|
105
|
+
],
|
|
106
|
+
},
|
|
107
|
+
|
|
108
|
+
// Test migrations
|
|
109
|
+
|
|
110
|
+
// Components --------------------------------------------------------------
|
|
111
|
+
{
|
|
112
|
+
code: `import {ButtonBase} from '@primer/react/lib-esm/Button/ButtonBase';
|
|
113
|
+
import type {ButtonBaseProps} from '@primer/react/lib-esm/Button/ButtonBase'`,
|
|
114
|
+
output: `import {ButtonBase} from '@primer/react'
|
|
115
|
+
import type {ButtonBaseProps} from '@primer/react'`,
|
|
116
|
+
errors: [
|
|
117
|
+
{
|
|
118
|
+
messageId: 'wildcardMigration',
|
|
119
|
+
data: {
|
|
120
|
+
wildcardEntrypoint: '@primer/react/lib-esm/Button/ButtonBase',
|
|
121
|
+
},
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
messageId: 'wildcardMigration',
|
|
125
|
+
data: {
|
|
126
|
+
wildcardEntrypoint: '@primer/react/lib-esm/Button/ButtonBase',
|
|
127
|
+
},
|
|
128
|
+
},
|
|
129
|
+
],
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
code: `import type {ButtonBaseProps} from '@primer/react/lib-esm/Button/types'`,
|
|
133
|
+
output: `import type {ButtonBaseProps} from '@primer/react'`,
|
|
134
|
+
errors: [
|
|
135
|
+
{
|
|
136
|
+
messageId: 'wildcardMigration',
|
|
137
|
+
data: {
|
|
138
|
+
wildcardEntrypoint: '@primer/react/lib-esm/Button/types',
|
|
139
|
+
},
|
|
140
|
+
},
|
|
141
|
+
],
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
code: `import {Dialog} from '@primer/react/lib-esm/Dialog/Dialog'`,
|
|
145
|
+
output: `import {Dialog} from '@primer/react/experimental'`,
|
|
146
|
+
errors: [
|
|
147
|
+
{
|
|
148
|
+
messageId: 'wildcardMigration',
|
|
149
|
+
data: {
|
|
150
|
+
wildcardEntrypoint: '@primer/react/lib-esm/Dialog/Dialog',
|
|
151
|
+
},
|
|
152
|
+
},
|
|
153
|
+
],
|
|
154
|
+
},
|
|
155
|
+
{
|
|
156
|
+
code: `import {SelectPanel} from '@primer/react/lib-esm/SelectPanel/SelectPanel'`,
|
|
157
|
+
output: `import {SelectPanel} from '@primer/react/experimental'`,
|
|
158
|
+
errors: [
|
|
159
|
+
{
|
|
160
|
+
messageId: 'wildcardMigration',
|
|
161
|
+
data: {
|
|
162
|
+
wildcardEntrypoint: '@primer/react/lib-esm/SelectPanel/SelectPanel',
|
|
163
|
+
},
|
|
164
|
+
},
|
|
165
|
+
],
|
|
166
|
+
},
|
|
167
|
+
{
|
|
168
|
+
code: `import type {SelectPanelProps} from '@primer/react/lib-esm/SelectPanel/SelectPanel'`,
|
|
169
|
+
output: `import type {SelectPanelProps} from '@primer/react/experimental'`,
|
|
170
|
+
errors: [
|
|
171
|
+
{
|
|
172
|
+
messageId: 'wildcardMigration',
|
|
173
|
+
data: {
|
|
174
|
+
wildcardEntrypoint: '@primer/react/lib-esm/SelectPanel/SelectPanel',
|
|
175
|
+
},
|
|
176
|
+
},
|
|
177
|
+
],
|
|
178
|
+
},
|
|
179
|
+
{
|
|
180
|
+
code: `import type {LabelColorOptions} from '@primer/react/lib-esm/Label/Label'`,
|
|
181
|
+
output: `import type {LabelColorOptions} from '@primer/react'`,
|
|
182
|
+
errors: [
|
|
183
|
+
{
|
|
184
|
+
messageId: 'wildcardMigration',
|
|
185
|
+
data: {
|
|
186
|
+
wildcardEntrypoint: '@primer/react/lib-esm/Label/Label',
|
|
187
|
+
},
|
|
188
|
+
},
|
|
189
|
+
],
|
|
190
|
+
},
|
|
191
|
+
{
|
|
192
|
+
code: `import VisuallyHidden from '@primer/react/lib-esm/_VisuallyHidden'`,
|
|
193
|
+
output: `import {VisuallyHidden} from '@primer/react'`,
|
|
194
|
+
errors: [
|
|
195
|
+
{
|
|
196
|
+
messageId: 'wildcardMigration',
|
|
197
|
+
data: {
|
|
198
|
+
wildcardEntrypoint: '@primer/react/lib-esm/_VisuallyHidden',
|
|
199
|
+
},
|
|
200
|
+
},
|
|
201
|
+
],
|
|
202
|
+
},
|
|
203
|
+
{
|
|
204
|
+
code: `import type {IssueLabelTokenProps} from '@primer/react/lib-esm/Token/IssueLabelToken'`,
|
|
205
|
+
output: `import type {IssueLabelTokenProps} from '@primer/react'`,
|
|
206
|
+
errors: [
|
|
207
|
+
{
|
|
208
|
+
messageId: 'wildcardMigration',
|
|
209
|
+
data: {
|
|
210
|
+
wildcardEntrypoint: '@primer/react/lib-esm/Token/IssueLabelToken',
|
|
211
|
+
},
|
|
212
|
+
},
|
|
213
|
+
],
|
|
214
|
+
},
|
|
215
|
+
{
|
|
216
|
+
code: `import type {TokenSizeKeys} from '@primer/react/lib-esm/Token/TokenBase'`,
|
|
217
|
+
output: `import type {TokenSizeKeys} from '@primer/react'`,
|
|
218
|
+
errors: [
|
|
219
|
+
{
|
|
220
|
+
messageId: 'wildcardMigration',
|
|
221
|
+
data: {
|
|
222
|
+
wildcardEntrypoint: '@primer/react/lib-esm/Token/TokenBase',
|
|
223
|
+
},
|
|
224
|
+
},
|
|
225
|
+
],
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
code: `import type {ItemProps} from '@primer/react/lib-esm/deprecated/ActionList'`,
|
|
229
|
+
output: `import type {ActionListItemProps} from '@primer/react/deprecated'`,
|
|
230
|
+
errors: [
|
|
231
|
+
{
|
|
232
|
+
messageId: 'wildcardMigration',
|
|
233
|
+
data: {
|
|
234
|
+
wildcardEntrypoint: '@primer/react/lib-esm/deprecated/ActionList',
|
|
235
|
+
},
|
|
236
|
+
},
|
|
237
|
+
],
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
code: `import type {GroupedListProps} from '@primer/react/lib-esm/deprecated/ActionList/List'`,
|
|
241
|
+
output: `import type {ActionListGroupedListProps} from '@primer/react/deprecated'`,
|
|
242
|
+
errors: [
|
|
243
|
+
{
|
|
244
|
+
messageId: 'wildcardMigration',
|
|
245
|
+
data: {
|
|
246
|
+
wildcardEntrypoint: '@primer/react/lib-esm/deprecated/ActionList/List',
|
|
247
|
+
},
|
|
248
|
+
},
|
|
249
|
+
],
|
|
250
|
+
},
|
|
251
|
+
{
|
|
252
|
+
code: `import {ItemInput} from '@primer/react/lib-esm/deprecated/ActionList/List'`,
|
|
253
|
+
output: `import {ActionListItemInput} from '@primer/react/deprecated'`,
|
|
254
|
+
errors: [
|
|
255
|
+
{
|
|
256
|
+
messageId: 'wildcardMigration',
|
|
257
|
+
data: {
|
|
258
|
+
wildcardEntrypoint: '@primer/react/lib-esm/deprecated/ActionList/List',
|
|
259
|
+
},
|
|
260
|
+
},
|
|
261
|
+
],
|
|
262
|
+
},
|
|
263
|
+
{
|
|
264
|
+
code: `import type {ItemProps} from '@primer/react/lib-esm/deprecated/ActionList/Item'`,
|
|
265
|
+
output: `import type {ActionListItemProps} from '@primer/react/deprecated'`,
|
|
266
|
+
errors: [
|
|
267
|
+
{
|
|
268
|
+
messageId: 'wildcardMigration',
|
|
269
|
+
data: {
|
|
270
|
+
wildcardEntrypoint: '@primer/react/lib-esm/deprecated/ActionList/Item',
|
|
271
|
+
},
|
|
272
|
+
},
|
|
273
|
+
],
|
|
274
|
+
},
|
|
275
|
+
|
|
276
|
+
// Hooks -------------------------------------------------------------------
|
|
277
|
+
|
|
278
|
+
// @primer/react/lib-esm/useIsomorphicLayoutEffect
|
|
279
|
+
{
|
|
280
|
+
code: `import useIsomorphicLayoutEffect from '@primer/react/lib-esm/useIsomorphicLayoutEffect'`,
|
|
281
|
+
output: `import {useIsomorphicLayoutEffect} from '@primer/react'`,
|
|
282
|
+
errors: [
|
|
283
|
+
{
|
|
284
|
+
messageId: 'wildcardMigration',
|
|
285
|
+
data: {
|
|
286
|
+
wildcardEntrypoint: '@primer/react/lib-esm/useIsomorphicLayoutEffect',
|
|
287
|
+
},
|
|
288
|
+
},
|
|
289
|
+
],
|
|
290
|
+
},
|
|
291
|
+
|
|
292
|
+
// @primer/react/lib-esm/hooks/useResizeObserver
|
|
293
|
+
{
|
|
294
|
+
code: `import useResizeObserver from '@primer/react/lib-esm/hooks/useResizeObserver'`,
|
|
295
|
+
output: `import {useResizeObserver} from '@primer/react'`,
|
|
296
|
+
errors: [
|
|
297
|
+
{
|
|
298
|
+
messageId: 'wildcardMigration',
|
|
299
|
+
data: {
|
|
300
|
+
wildcardEntrypoint: '@primer/react/lib-esm/hooks/useResizeObserver',
|
|
301
|
+
},
|
|
302
|
+
},
|
|
303
|
+
],
|
|
304
|
+
},
|
|
305
|
+
|
|
306
|
+
// @primer/react/lib-esm/hooks/useProvidedRefOrCreate
|
|
307
|
+
{
|
|
308
|
+
code: `import useProvidedRefOrCreate from '@primer/react/lib-esm/hooks/useProvidedRefOrCreate'`,
|
|
309
|
+
output: `import {useProvidedRefOrCreate} from '@primer/react'`,
|
|
310
|
+
errors: [
|
|
311
|
+
{
|
|
312
|
+
messageId: 'wildcardMigration',
|
|
313
|
+
data: {
|
|
314
|
+
wildcardEntrypoint: '@primer/react/lib-esm/hooks/useProvidedRefOrCreate',
|
|
315
|
+
},
|
|
316
|
+
},
|
|
317
|
+
],
|
|
318
|
+
},
|
|
319
|
+
|
|
320
|
+
// @primer/react/lib-esm/hooks/useResponsiveValue
|
|
321
|
+
{
|
|
322
|
+
code: `import useResponsiveValue from '@primer/react/lib-esm/hooks/useResponsiveValue'`,
|
|
323
|
+
output: `import {useResponsiveValue} from '@primer/react'`,
|
|
324
|
+
errors: [
|
|
325
|
+
{
|
|
326
|
+
messageId: 'wildcardMigration',
|
|
327
|
+
data: {
|
|
328
|
+
wildcardEntrypoint: '@primer/react/lib-esm/hooks/useResponsiveValue',
|
|
329
|
+
},
|
|
330
|
+
},
|
|
331
|
+
],
|
|
332
|
+
},
|
|
333
|
+
|
|
334
|
+
// Utilities ---------------------------------------------------------------
|
|
335
|
+
|
|
336
|
+
// @primer/react/lib-esm/sx
|
|
337
|
+
{
|
|
338
|
+
code: `import type {BetterSystemStyleObject, SxProp, BetterCssProperties} from '@primer/react/lib-esm/sx'`,
|
|
339
|
+
output: `import type {BetterSystemStyleObject, SxProp, BetterCssProperties} from '@primer/react'`,
|
|
340
|
+
errors: [
|
|
341
|
+
{
|
|
342
|
+
messageId: 'wildcardMigration',
|
|
343
|
+
data: {
|
|
344
|
+
wildcardEntrypoint: '@primer/react/lib-esm/sx',
|
|
345
|
+
},
|
|
346
|
+
},
|
|
347
|
+
],
|
|
348
|
+
},
|
|
349
|
+
// @primer/react/lib-esm/FeatureFlags/DefaultFeatureFlags
|
|
350
|
+
{
|
|
351
|
+
code: `import {DefaultFeatureFlags} from '@primer/react/lib-esm/FeatureFlags/DefaultFeatureFlags'`,
|
|
352
|
+
output: `import {DefaultFeatureFlags} from '@primer/react/experimental'`,
|
|
353
|
+
errors: [
|
|
354
|
+
{
|
|
355
|
+
messageId: 'wildcardMigration',
|
|
356
|
+
data: {
|
|
357
|
+
wildcardEntrypoint: '@primer/react/lib-esm/FeatureFlags/DefaultFeatureFlags',
|
|
358
|
+
},
|
|
359
|
+
},
|
|
360
|
+
],
|
|
361
|
+
},
|
|
362
|
+
],
|
|
363
|
+
})
|