eslint-plugin-primer-react 8.0.0-rc.d848c88 → 8.1.0-rc.d5a1ac8

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 (33) hide show
  1. package/.github/copilot-instructions.md +159 -0
  2. package/.github/workflows/add-to-inbox.yml +2 -2
  3. package/.markdownlint-cli2.cjs +2 -2
  4. package/CHANGELOG.md +8 -2
  5. package/docs/rules/use-styled-react-import.md +128 -0
  6. package/eslint.config.js +54 -0
  7. package/package-lock.json +2006 -8418
  8. package/package.json +15 -9
  9. package/src/index.js +1 -0
  10. package/src/rules/__tests__/a11y-explicit-heading.test.js +5 -3
  11. package/src/rules/__tests__/a11y-link-in-text-block.test.js +5 -3
  12. package/src/rules/__tests__/a11y-no-duplicate-form-labels.test.js +5 -9
  13. package/src/rules/__tests__/a11y-no-title-usage.test.js +5 -3
  14. package/src/rules/__tests__/a11y-remove-disable-tooltip.test.js +5 -3
  15. package/src/rules/__tests__/a11y-tooltip-interactive-trigger.test.js +5 -3
  16. package/src/rules/__tests__/a11y-use-accessible-tooltip.test.js +5 -3
  17. package/src/rules/__tests__/direct-slot-children.test.js +5 -3
  18. package/src/rules/__tests__/enforce-button-for-link-with-nohref.test.js +5 -3
  19. package/src/rules/__tests__/enforce-css-module-identifier-casing.test.js +5 -3
  20. package/src/rules/__tests__/new-color-css-vars.test.js +5 -3
  21. package/src/rules/__tests__/no-deprecated-entrypoints.test.js +5 -3
  22. package/src/rules/__tests__/no-deprecated-experimental-components.test.js +5 -3
  23. package/src/rules/__tests__/no-deprecated-props.test.js +5 -3
  24. package/src/rules/__tests__/no-system-props.test.js +5 -4
  25. package/src/rules/__tests__/no-unnecessary-components.test.js +6 -4
  26. package/src/rules/__tests__/no-wildcard-imports.test.js +6 -43
  27. package/src/rules/__tests__/prefer-action-list-item-onselect.test.js +6 -4
  28. package/src/rules/__tests__/use-deprecated-from-deprecated.test.js +5 -3
  29. package/src/rules/__tests__/use-styled-react-import.test.js +251 -0
  30. package/src/rules/no-deprecated-experimental-components.js +0 -1
  31. package/src/rules/use-styled-react-import.js +483 -0
  32. package/.eslintignore +0 -2
  33. package/.eslintrc.js +0 -39
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "eslint-plugin-primer-react",
3
- "version": "8.0.0-rc.d848c88",
3
+ "version": "8.1.0-rc.d5a1ac8",
4
4
  "description": "ESLint rules for Primer React",
5
5
  "main": "src/index.js",
6
6
  "engines": {
@@ -28,16 +28,16 @@
28
28
  },
29
29
  "homepage": "https://github.com/primer/eslint-plugin-primer-react#readme",
30
30
  "peerDependencies": {
31
- "eslint": "^8.42.0"
31
+ "eslint": "^9.0.0"
32
32
  },
33
33
  "dependencies": {
34
34
  "@styled-system/props": "^5.1.5",
35
- "eslint-plugin-github": "^5.0.1",
35
+ "@typescript-eslint/utils": "8.39.0",
36
+ "eslint-plugin-github": "^6.0.0",
36
37
  "eslint-plugin-jsx-a11y": "^6.7.1",
37
38
  "eslint-traverse": "^1.0.0",
38
39
  "lodash": "^4.17.21",
39
40
  "styled-system": "^5.1.5",
40
- "@typescript-eslint/utils": "8.38.0",
41
41
  "typescript": "^5.8.2"
42
42
  },
43
43
  "devDependencies": {
@@ -45,13 +45,19 @@
45
45
  "@changesets/cli": "^2.27.9",
46
46
  "@github/markdownlint-github": "^0.6.3",
47
47
  "@github/prettier-config": "0.0.6",
48
- "eslint": "^8.42.0",
49
- "eslint-plugin-prettier": "^5.2.1",
48
+ "@types/jest": "^30.0.0",
49
+ "@typescript-eslint/rule-tester": "8.39.0",
50
+ "eslint": "^9.0.0",
51
+ "eslint-plugin-eslint-comments": "^3.2.0",
52
+ "eslint-plugin-filenames": "^1.3.2",
53
+ "eslint-plugin-i18n-text": "^1.0.1",
54
+ "eslint-plugin-import": "^2.32.0",
55
+ "eslint-plugin-no-only-tests": "^3.3.0",
56
+ "eslint-plugin-prettier": "^5.5.4",
57
+ "globals": "^16.3.0",
50
58
  "jest": "^30.0.5",
51
59
  "markdownlint-cli2": "^0.18.1",
52
- "markdownlint-cli2-formatter-pretty": "^0.0.7",
53
- "@typescript-eslint/rule-tester": "7.16.0",
54
- "@types/jest": "^30.0.0"
60
+ "markdownlint-cli2-formatter-pretty": "^0.0.8"
55
61
  },
56
62
  "prettier": "@github/prettier-config"
57
63
  }
package/src/index.js CHANGED
@@ -19,6 +19,7 @@ module.exports = {
19
19
  'prefer-action-list-item-onselect': require('./rules/prefer-action-list-item-onselect'),
20
20
  'enforce-css-module-identifier-casing': require('./rules/enforce-css-module-identifier-casing'),
21
21
  'enforce-css-module-default-import': require('./rules/enforce-css-module-default-import'),
22
+ 'use-styled-react-import': require('./rules/use-styled-react-import'),
22
23
  },
23
24
  configs: {
24
25
  recommended: require('./configs/recommended'),
@@ -2,11 +2,13 @@ const rule = require('../a11y-explicit-heading')
2
2
  const {RuleTester} = require('eslint')
3
3
 
4
4
  const ruleTester = new RuleTester({
5
- parserOptions: {
5
+ languageOptions: {
6
6
  ecmaVersion: 'latest',
7
7
  sourceType: 'module',
8
- ecmaFeatures: {
9
- jsx: true,
8
+ parserOptions: {
9
+ ecmaFeatures: {
10
+ jsx: true,
11
+ },
10
12
  },
11
13
  },
12
14
  })
@@ -2,11 +2,13 @@ const rule = require('../a11y-link-in-text-block')
2
2
  const {RuleTester} = require('eslint')
3
3
 
4
4
  const ruleTester = new RuleTester({
5
- parserOptions: {
5
+ languageOptions: {
6
6
  ecmaVersion: 'latest',
7
7
  sourceType: 'module',
8
- ecmaFeatures: {
9
- jsx: true,
8
+ parserOptions: {
9
+ ecmaFeatures: {
10
+ jsx: true,
11
+ },
10
12
  },
11
13
  },
12
14
  })
@@ -2,11 +2,13 @@ const rule = require('../a11y-no-duplicate-form-labels')
2
2
  const {RuleTester} = require('eslint')
3
3
 
4
4
  const ruleTester = new RuleTester({
5
- parserOptions: {
5
+ languageOptions: {
6
6
  ecmaVersion: 'latest',
7
7
  sourceType: 'module',
8
- ecmaFeatures: {
9
- jsx: true,
8
+ parserOptions: {
9
+ ecmaFeatures: {
10
+ jsx: true,
11
+ },
10
12
  },
11
13
  },
12
14
  })
@@ -37,12 +39,6 @@ ruleTester.run('a11y-no-duplicate-form-labels', rule, {
37
39
  <TextInput />
38
40
  </FormControl>`,
39
41
 
40
- // FormControl without FormControl.Label but with aria-label is valid
41
- `import {FormControl, TextInput} from '@primer/react';
42
- <FormControl>
43
- <TextInput aria-label="Form Input Label" />
44
- </FormControl>`,
45
-
46
42
  // Multiple TextInputs with different approaches
47
43
  `import {FormControl, TextInput} from '@primer/react';
48
44
  <div>
@@ -2,11 +2,13 @@ const rule = require('../a11y-no-title-usage')
2
2
  const {RuleTester} = require('eslint')
3
3
 
4
4
  const ruleTester = new RuleTester({
5
- parserOptions: {
5
+ languageOptions: {
6
6
  ecmaVersion: 'latest',
7
7
  sourceType: 'module',
8
- ecmaFeatures: {
9
- jsx: true,
8
+ parserOptions: {
9
+ ecmaFeatures: {
10
+ jsx: true,
11
+ },
10
12
  },
11
13
  },
12
14
  })
@@ -4,11 +4,13 @@ const {RuleTester} = require('eslint')
4
4
  const rule = require('../a11y-remove-disable-tooltip')
5
5
 
6
6
  const ruleTester = new RuleTester({
7
- parserOptions: {
7
+ languageOptions: {
8
8
  ecmaVersion: 'latest',
9
9
  sourceType: 'module',
10
- ecmaFeatures: {
11
- jsx: true,
10
+ parserOptions: {
11
+ ecmaFeatures: {
12
+ jsx: true,
13
+ },
12
14
  },
13
15
  },
14
16
  })
@@ -2,11 +2,13 @@ const rule = require('../a11y-tooltip-interactive-trigger')
2
2
  const {RuleTester} = require('eslint')
3
3
 
4
4
  const ruleTester = new RuleTester({
5
- parserOptions: {
5
+ languageOptions: {
6
6
  ecmaVersion: 'latest',
7
7
  sourceType: 'module',
8
- ecmaFeatures: {
9
- jsx: true,
8
+ parserOptions: {
9
+ ecmaFeatures: {
10
+ jsx: true,
11
+ },
10
12
  },
11
13
  },
12
14
  })
@@ -2,11 +2,13 @@ const rule = require('../a11y-use-accessible-tooltip')
2
2
  const {RuleTester} = require('eslint')
3
3
 
4
4
  const ruleTester = new RuleTester({
5
- parserOptions: {
5
+ languageOptions: {
6
6
  ecmaVersion: 'latest',
7
7
  sourceType: 'module',
8
- ecmaFeatures: {
9
- jsx: true,
8
+ parserOptions: {
9
+ ecmaFeatures: {
10
+ jsx: true,
11
+ },
10
12
  },
11
13
  },
12
14
  })
@@ -2,11 +2,13 @@ const rule = require('../direct-slot-children')
2
2
  const {RuleTester} = require('eslint')
3
3
 
4
4
  const ruleTester = new RuleTester({
5
- parserOptions: {
5
+ languageOptions: {
6
6
  ecmaVersion: 'latest',
7
7
  sourceType: 'module',
8
- ecmaFeatures: {
9
- jsx: true,
8
+ parserOptions: {
9
+ ecmaFeatures: {
10
+ jsx: true,
11
+ },
10
12
  },
11
13
  },
12
14
  })
@@ -2,11 +2,13 @@ const rule = require('../enforce-button-for-link-with-nohref')
2
2
  const {RuleTester} = require('eslint')
3
3
 
4
4
  const ruleTester = new RuleTester({
5
- parserOptions: {
5
+ languageOptions: {
6
6
  ecmaVersion: 'latest',
7
7
  sourceType: 'module',
8
- ecmaFeatures: {
9
- jsx: true,
8
+ parserOptions: {
9
+ ecmaFeatures: {
10
+ jsx: true,
11
+ },
10
12
  },
11
13
  },
12
14
  })
@@ -2,11 +2,13 @@ const rule = require('../enforce-css-module-identifier-casing')
2
2
  const {RuleTester} = require('eslint')
3
3
 
4
4
  const ruleTester = new RuleTester({
5
- parserOptions: {
5
+ languageOptions: {
6
6
  ecmaVersion: 'latest',
7
7
  sourceType: 'module',
8
- ecmaFeatures: {
9
- jsx: true,
8
+ parserOptions: {
9
+ ecmaFeatures: {
10
+ jsx: true,
11
+ },
10
12
  },
11
13
  },
12
14
  })
@@ -2,11 +2,13 @@ const rule = require('../new-color-css-vars')
2
2
  const {RuleTester} = require('eslint')
3
3
 
4
4
  const ruleTester = new RuleTester({
5
- parserOptions: {
5
+ languageOptions: {
6
6
  ecmaVersion: 'latest',
7
7
  sourceType: 'module',
8
- ecmaFeatures: {
9
- jsx: true,
8
+ parserOptions: {
9
+ ecmaFeatures: {
10
+ jsx: true,
11
+ },
10
12
  },
11
13
  },
12
14
  })
@@ -4,11 +4,13 @@ const {RuleTester} = require('eslint')
4
4
  const rule = require('../no-deprecated-entrypoints')
5
5
 
6
6
  const ruleTester = new RuleTester({
7
- parserOptions: {
7
+ languageOptions: {
8
8
  ecmaVersion: 'latest',
9
9
  sourceType: 'module',
10
- ecmaFeatures: {
11
- jsx: true,
10
+ parserOptions: {
11
+ ecmaFeatures: {
12
+ jsx: true,
13
+ },
12
14
  },
13
15
  },
14
16
  })
@@ -4,11 +4,13 @@ const {RuleTester} = require('eslint')
4
4
  const rule = require('../no-deprecated-experimental-components')
5
5
 
6
6
  const ruleTester = new RuleTester({
7
- parserOptions: {
7
+ languageOptions: {
8
8
  ecmaVersion: 'latest',
9
9
  sourceType: 'module',
10
- ecmaFeatures: {
11
- jsx: true,
10
+ parserOptions: {
11
+ ecmaFeatures: {
12
+ jsx: true,
13
+ },
12
14
  },
13
15
  },
14
16
  })
@@ -4,11 +4,13 @@ const {RuleTester} = require('eslint')
4
4
  const rule = require('../no-deprecated-props')
5
5
 
6
6
  const ruleTester = new RuleTester({
7
- parserOptions: {
7
+ languageOptions: {
8
8
  ecmaVersion: 'latest',
9
9
  sourceType: 'module',
10
- ecmaFeatures: {
11
- jsx: true,
10
+ parserOptions: {
11
+ ecmaFeatures: {
12
+ jsx: true,
13
+ },
12
14
  },
13
15
  },
14
16
  })
@@ -2,11 +2,13 @@ const rule = require('../no-system-props')
2
2
  const {RuleTester} = require('eslint')
3
3
 
4
4
  const ruleTester = new RuleTester({
5
- parserOptions: {
5
+ languageOptions: {
6
6
  ecmaVersion: 'latest',
7
7
  sourceType: 'module',
8
- ecmaFeatures: {
9
- jsx: true,
8
+ parserOptions: {
9
+ ecmaFeatures: {
10
+ jsx: true,
11
+ },
10
12
  },
11
13
  },
12
14
  })
@@ -102,7 +104,6 @@ ruleTester.run('no-system-props', rule, {
102
104
  },
103
105
  {
104
106
  code: `import {Button} from '@primer/react'; <Button width={200} sx={myStylez} />`,
105
- output: `import {Button} from '@primer/react'; <Button width={200} sx={myStylez} />`,
106
107
  errors: [
107
108
  {
108
109
  messageId: 'noSystemProps',
@@ -20,10 +20,12 @@ const componentDeclaration = `const OtherComponent = ({children}: {children: Rea
20
20
  const asConstDeclaration = `const as = "p";`
21
21
 
22
22
  const ruleTester = new RuleTester({
23
- parser: '@typescript-eslint/parser',
24
- parserOptions: {
25
- tsconfigRootDir: path.resolve(__dirname, 'fixtures'),
26
- project: path.resolve(__dirname, 'fixtures', 'tsconfig.json'),
23
+ languageOptions: {
24
+ parser: require('@typescript-eslint/parser'),
25
+ parserOptions: {
26
+ tsconfigRootDir: path.resolve(__dirname, 'fixtures'),
27
+ project: path.resolve(__dirname, 'fixtures', 'tsconfig.json'),
28
+ },
27
29
  },
28
30
  defaultFilenames: {
29
31
  ts: 'file.ts',
@@ -4,12 +4,14 @@ const {RuleTester} = require('eslint')
4
4
  const rule = require('../no-wildcard-imports')
5
5
 
6
6
  const ruleTester = new RuleTester({
7
- parser: require.resolve('@typescript-eslint/parser'),
8
- parserOptions: {
7
+ languageOptions: {
8
+ parser: require(require.resolve('@typescript-eslint/parser', {paths: [require.resolve('eslint-plugin-github')]})),
9
9
  ecmaVersion: 'latest',
10
10
  sourceType: 'module',
11
- ecmaFeatures: {
12
- jsx: true,
11
+ parserOptions: {
12
+ ecmaFeatures: {
13
+ jsx: true,
14
+ },
13
15
  },
14
16
  },
15
17
  })
@@ -69,20 +71,6 @@ ruleTester.run('no-wildcard-imports', rule, {
69
71
  ],
70
72
  },
71
73
 
72
- // Test default import
73
- {
74
- code: `import useIsomorphicLayoutEffect from '@primer/react/lib-esm/utils/useIsomorphicLayoutEffect'`,
75
- output: `import {useIsomorphicLayoutEffect} from '@primer/react'`,
76
- errors: [
77
- {
78
- messageId: 'wildcardMigration',
79
- data: {
80
- wildcardEntrypoint: '@primer/react/lib-esm/utils/useIsomorphicLayoutEffect',
81
- },
82
- },
83
- ],
84
- },
85
-
86
74
  // Test multiple wildcard imports into single entrypoint
87
75
  {
88
76
  code: `import {useResizeObserver} from '@primer/react/lib-esm/hooks/useResizeObserver'
@@ -306,18 +294,6 @@ import {type ButtonBaseProps} from '@primer/react/experimental'`,
306
294
  },
307
295
  ],
308
296
  },
309
- {
310
- code: `import type {ItemProps} from '@primer/react/lib-esm/deprecated/ActionList/Item'`,
311
- output: `import {type ActionListItemProps as ItemProps} from '@primer/react/deprecated'`,
312
- errors: [
313
- {
314
- messageId: 'wildcardMigration',
315
- data: {
316
- wildcardEntrypoint: '@primer/react/lib-esm/deprecated/ActionList/Item',
317
- },
318
- },
319
- ],
320
- },
321
297
 
322
298
  // Hooks -------------------------------------------------------------------
323
299
 
@@ -391,19 +367,6 @@ import {type ButtonBaseProps} from '@primer/react/experimental'`,
391
367
 
392
368
  // Utilities ---------------------------------------------------------------
393
369
 
394
- // @primer/react/lib-esm/sx
395
- {
396
- code: `import type {BetterSystemStyleObject, SxProp, BetterCssProperties} from '@primer/react/lib-esm/sx'`,
397
- output: `import {type BetterSystemStyleObject, type SxProp, type BetterCssProperties} from '@primer/react'`,
398
- errors: [
399
- {
400
- messageId: 'wildcardMigration',
401
- data: {
402
- wildcardEntrypoint: '@primer/react/lib-esm/sx',
403
- },
404
- },
405
- ],
406
- },
407
370
  // @primer/react/lib-esm/FeatureFlags/DefaultFeatureFlags
408
371
  {
409
372
  code: `import {DefaultFeatureFlags} from '@primer/react/lib-esm/FeatureFlags/DefaultFeatureFlags'`,
@@ -2,12 +2,14 @@ const {RuleTester} = require('@typescript-eslint/rule-tester')
2
2
  const rule = require('../prefer-action-list-item-onselect')
3
3
 
4
4
  const ruleTester = new RuleTester({
5
- parser: require.resolve('@typescript-eslint/parser'),
6
- parserOptions: {
5
+ languageOptions: {
6
+ parser: require(require.resolve('@typescript-eslint/parser', {paths: [require.resolve('eslint-plugin-github')]})),
7
7
  ecmaVersion: 2018,
8
8
  sourceType: 'module',
9
- ecmaFeatures: {
10
- jsx: true,
9
+ parserOptions: {
10
+ ecmaFeatures: {
11
+ jsx: true,
12
+ },
11
13
  },
12
14
  },
13
15
  })
@@ -4,11 +4,13 @@ const {RuleTester} = require('eslint')
4
4
  const rule = require('../use-deprecated-from-deprecated')
5
5
 
6
6
  const ruleTester = new RuleTester({
7
- parserOptions: {
7
+ languageOptions: {
8
8
  ecmaVersion: 'latest',
9
9
  sourceType: 'module',
10
- ecmaFeatures: {
11
- jsx: true,
10
+ parserOptions: {
11
+ ecmaFeatures: {
12
+ jsx: true,
13
+ },
12
14
  },
13
15
  },
14
16
  })