eslint-plugin-primer-react 7.0.0-rc.ffaa602 → 7.0.1-rc.d09d528
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/.github/workflows/release_tracking.yml +1 -1
- package/CHANGELOG.md +12 -0
- package/README.md +1 -0
- package/docs/rules/no-deprecated-experimental-components.md +29 -0
- package/package-lock.json +421 -327
- package/package.json +3 -3
- package/src/configs/recommended.js +1 -2
- package/src/index.js +1 -0
- package/src/rules/__tests__/no-deprecated-experimental-components.test.js +44 -0
- package/src/rules/enforce-css-module-identifier-casing.js +1 -1
- package/src/rules/no-deprecated-experimental-components.js +68 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "eslint-plugin-primer-react",
|
|
3
|
-
"version": "7.0.
|
|
3
|
+
"version": "7.0.1-rc.d09d528",
|
|
4
4
|
"description": "ESLint rules for Primer React",
|
|
5
5
|
"main": "src/index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -34,8 +34,8 @@
|
|
|
34
34
|
"eslint-traverse": "^1.0.0",
|
|
35
35
|
"lodash": "^4.17.21",
|
|
36
36
|
"styled-system": "^5.1.5",
|
|
37
|
-
"@typescript-eslint/utils": "8.
|
|
38
|
-
"typescript": "^5.
|
|
37
|
+
"@typescript-eslint/utils": "8.26.0",
|
|
38
|
+
"typescript": "^5.8.2"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"@changesets/changelog-github": "^0.5.0",
|
|
@@ -12,6 +12,7 @@ module.exports = {
|
|
|
12
12
|
rules: {
|
|
13
13
|
'primer-react/direct-slot-children': 'error',
|
|
14
14
|
'primer-react/no-system-props': 'warn',
|
|
15
|
+
'primer-react/no-deprecated-experimental-components': 'warn',
|
|
15
16
|
'primer-react/a11y-tooltip-interactive-trigger': 'error',
|
|
16
17
|
'primer-react/new-color-css-vars': 'error',
|
|
17
18
|
'primer-react/a11y-explicit-heading': 'error',
|
|
@@ -21,8 +22,6 @@ module.exports = {
|
|
|
21
22
|
'primer-react/a11y-use-accessible-tooltip': 'error',
|
|
22
23
|
'primer-react/no-unnecessary-components': 'error',
|
|
23
24
|
'primer-react/prefer-action-list-item-onselect': 'error',
|
|
24
|
-
'primer-react/enforce-css-module-identifier-casing': 'error',
|
|
25
|
-
'primer-react/enforce-css-module-default-import': ['error', {enforceName: '(^classes$|Classes$)'}],
|
|
26
25
|
},
|
|
27
26
|
settings: {
|
|
28
27
|
github: {
|
package/src/index.js
CHANGED
|
@@ -3,6 +3,7 @@ module.exports = {
|
|
|
3
3
|
'direct-slot-children': require('./rules/direct-slot-children'),
|
|
4
4
|
'no-deprecated-entrypoints': require('./rules/no-deprecated-entrypoints'),
|
|
5
5
|
'no-system-props': require('./rules/no-system-props'),
|
|
6
|
+
'no-deprecated-experimental-components': require('./rules/no-deprecated-experimental-components'),
|
|
6
7
|
'a11y-tooltip-interactive-trigger': require('./rules/a11y-tooltip-interactive-trigger'),
|
|
7
8
|
'new-color-css-vars': require('./rules/new-color-css-vars'),
|
|
8
9
|
'a11y-explicit-heading': require('./rules/a11y-explicit-heading'),
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
'use strict'
|
|
2
|
+
|
|
3
|
+
const {RuleTester} = require('eslint')
|
|
4
|
+
const rule = require('../no-deprecated-experimental-components')
|
|
5
|
+
|
|
6
|
+
const ruleTester = new RuleTester({
|
|
7
|
+
parserOptions: {
|
|
8
|
+
ecmaVersion: 'latest',
|
|
9
|
+
sourceType: 'module',
|
|
10
|
+
ecmaFeatures: {
|
|
11
|
+
jsx: true,
|
|
12
|
+
},
|
|
13
|
+
},
|
|
14
|
+
})
|
|
15
|
+
|
|
16
|
+
ruleTester.run('no-deprecated-experimental-components', rule, {
|
|
17
|
+
valid: [
|
|
18
|
+
{
|
|
19
|
+
code: `import {SelectPanel} from '@primer/react'`,
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
code: `import {DataTable} from '@primer/react/experimental'`,
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
code: `import {DataTable, ActionBar} from '@primer/react/experimental'`,
|
|
26
|
+
},
|
|
27
|
+
],
|
|
28
|
+
invalid: [
|
|
29
|
+
// Single experimental import
|
|
30
|
+
{
|
|
31
|
+
code: `import {SelectPanel} from '@primer/react/experimental'`,
|
|
32
|
+
errors: [
|
|
33
|
+
'The experimental SelectPanel is deprecated. Please import from the stable entrypoint (@primer/react) if available, or check https://primer.style/product/components/ for alternative components.',
|
|
34
|
+
],
|
|
35
|
+
},
|
|
36
|
+
// Multiple experimental import
|
|
37
|
+
{
|
|
38
|
+
code: `import {SelectPanel, DataTable, ActionBar} from '@primer/react/experimental'`,
|
|
39
|
+
errors: [
|
|
40
|
+
'The experimental SelectPanel is deprecated. Please import from the stable entrypoint (@primer/react) if available, or check https://primer.style/product/components/ for alternative components.',
|
|
41
|
+
],
|
|
42
|
+
},
|
|
43
|
+
],
|
|
44
|
+
})
|
|
@@ -57,7 +57,7 @@ module.exports = {
|
|
|
57
57
|
const ref = context.sourceCode
|
|
58
58
|
.getScope(node)
|
|
59
59
|
.references.find(reference => reference.identifier.name === node.property.name)
|
|
60
|
-
const def = ref
|
|
60
|
+
const def = ref?.resolved?.defs?.[0]
|
|
61
61
|
if (def?.node?.init?.type === 'Literal') {
|
|
62
62
|
if (!casingMatches(def.node.init.value || '', casing)) {
|
|
63
63
|
context.report({
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
'use strict'
|
|
2
|
+
|
|
3
|
+
const url = require('../url')
|
|
4
|
+
|
|
5
|
+
const components = [
|
|
6
|
+
{
|
|
7
|
+
identifier: 'SelectPanel',
|
|
8
|
+
entrypoint: '@primer/react/experimental',
|
|
9
|
+
},
|
|
10
|
+
]
|
|
11
|
+
|
|
12
|
+
const entrypoints = new Map()
|
|
13
|
+
|
|
14
|
+
for (const component of components) {
|
|
15
|
+
if (!entrypoints.has(component.entrypoint)) {
|
|
16
|
+
entrypoints.set(component.entrypoint, new Set())
|
|
17
|
+
}
|
|
18
|
+
entrypoints.get(component.entrypoint).add(component.identifier)
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* @type {import('eslint').Rule.RuleModule}
|
|
23
|
+
*/
|
|
24
|
+
module.exports = {
|
|
25
|
+
meta: {
|
|
26
|
+
type: 'problem',
|
|
27
|
+
docs: {
|
|
28
|
+
description: 'Use a stable component from the `@primer/react` entrypoint, or check the docs for alternatives',
|
|
29
|
+
recommended: true,
|
|
30
|
+
url: url(module),
|
|
31
|
+
},
|
|
32
|
+
fixable: true,
|
|
33
|
+
schema: [],
|
|
34
|
+
},
|
|
35
|
+
create(context) {
|
|
36
|
+
return {
|
|
37
|
+
ImportDeclaration(node) {
|
|
38
|
+
if (!entrypoints.has(node.source.value)) {
|
|
39
|
+
return
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
const entrypoint = entrypoints.get(node.source.value)
|
|
43
|
+
|
|
44
|
+
const experimental = node.specifiers.filter(specifier => {
|
|
45
|
+
return entrypoint.has(specifier.imported.name)
|
|
46
|
+
})
|
|
47
|
+
|
|
48
|
+
const components = experimental.map(specifier => specifier.imported.name)
|
|
49
|
+
|
|
50
|
+
if (experimental.length === 0) {
|
|
51
|
+
return
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
if (experimental.length > 0) {
|
|
55
|
+
// eslint-disable-next-line i18n-text/no-en
|
|
56
|
+
const message = `The experimental ${components.join(', ')} ${
|
|
57
|
+
components.length > 1 ? 'are' : 'is'
|
|
58
|
+
} deprecated. Please import from the stable entrypoint (@primer/react) if available, or check https://primer.style/product/components/ for alternative components.`
|
|
59
|
+
|
|
60
|
+
context.report({
|
|
61
|
+
node,
|
|
62
|
+
message,
|
|
63
|
+
})
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
}
|
|
67
|
+
},
|
|
68
|
+
}
|