eslint-plugin-primer-react 7.0.0-rc.ffaa602 → 7.0.1-rc.134f18c

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-primer-react",
-  "version": "7.0.0-rc.ffaa602",
+  "version": "7.0.1-rc.134f18c",
   "description": "ESLint rules for Primer React",
   "main": "src/index.js",
   "scripts": {
@@ -34,8 +34,8 @@
     "eslint-traverse": "^1.0.0",
     "lodash": "^4.17.21",
     "styled-system": "^5.1.5",
-    "@typescript-eslint/utils": "8.24.0",
-    "typescript": "^5.5.3"
+    "@typescript-eslint/utils": "8.26.0",
+    "typescript": "^5.8.2"
   },
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.0",

package/src/configs/recommended.js

@@ -12,6 +12,7 @@ module.exports = {
   rules: {
     'primer-react/direct-slot-children': 'error',
     'primer-react/no-system-props': 'warn',
+    'primer-react/no-deprecated-experimental-components': 'warn',
     'primer-react/a11y-tooltip-interactive-trigger': 'error',
     'primer-react/new-color-css-vars': 'error',
     'primer-react/a11y-explicit-heading': 'error',
@@ -21,8 +22,6 @@ module.exports = {
     'primer-react/a11y-use-accessible-tooltip': 'error',
     'primer-react/no-unnecessary-components': 'error',
     'primer-react/prefer-action-list-item-onselect': 'error',
-    'primer-react/enforce-css-module-identifier-casing': 'error',
-    'primer-react/enforce-css-module-default-import': ['error', {enforceName: '(^classes$|Classes$)'}],
   },
   settings: {
     github: {

package/src/index.js

@@ -3,6 +3,7 @@ module.exports = {
     'direct-slot-children': require('./rules/direct-slot-children'),
     'no-deprecated-entrypoints': require('./rules/no-deprecated-entrypoints'),
     'no-system-props': require('./rules/no-system-props'),
+    'no-deprecated-experimental-components': require('./rules/no-deprecated-experimental-components'),
     'a11y-tooltip-interactive-trigger': require('./rules/a11y-tooltip-interactive-trigger'),
     'new-color-css-vars': require('./rules/new-color-css-vars'),
     'a11y-explicit-heading': require('./rules/a11y-explicit-heading'),

package/src/rules/__tests__/no-deprecated-experimental-components.test.js

@@ -0,0 +1,44 @@
+'use strict'
+
+const {RuleTester} = require('eslint')
+const rule = require('../no-deprecated-experimental-components')
+
+const ruleTester = new RuleTester({
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
+})
+
+ruleTester.run('no-deprecated-experimental-components', rule, {
+  valid: [
+    {
+      code: `import {SelectPanel} from '@primer/react'`,
+    },
+    {
+      code: `import {DataTable} from '@primer/react/experimental'`,
+    },
+    {
+      code: `import {DataTable, ActionBar} from '@primer/react/experimental'`,
+    },
+  ],
+  invalid: [
+    // Single experimental import
+    {
+      code: `import {SelectPanel} from '@primer/react/experimental'`,
+      errors: [
+        'The experimental SelectPanel is deprecated. Please import from the stable entrypoint (@primer/react) if available. Check https://primer.style/product/getting-started/react/migration-guides/ for migration guidance or https://primer.style/product/components/ for alternative components.',
+      ],
+    },
+    // Multiple experimental import
+    {
+      code: `import {SelectPanel, DataTable, ActionBar} from '@primer/react/experimental'`,
+      errors: [
+        'The experimental SelectPanel is deprecated. Please import from the stable entrypoint (@primer/react) if available. Check https://primer.style/product/getting-started/react/migration-guides/ for migration guidance or https://primer.style/product/components/ for alternative components.',
+      ],
+    },
+  ],
+})

package/src/rules/enforce-css-module-identifier-casing.js

@@ -57,7 +57,7 @@ module.exports = {
             const ref = context.sourceCode
               .getScope(node)
               .references.find(reference => reference.identifier.name === node.property.name)
-            const def = ref.resolved?.defs?.[0]
+            const def = ref?.resolved?.defs?.[0]
             if (def?.node?.init?.type === 'Literal') {
               if (!casingMatches(def.node.init.value || '', casing)) {
                 context.report({

package/src/rules/no-deprecated-experimental-components.js

@@ -0,0 +1,68 @@
+'use strict'
+
+const url = require('../url')
+
+const components = [
+  {
+    identifier: 'SelectPanel',
+    entrypoint: '@primer/react/experimental',
+  },
+]
+
+const entrypoints = new Map()
+
+for (const component of components) {
+  if (!entrypoints.has(component.entrypoint)) {
+    entrypoints.set(component.entrypoint, new Set())
+  }
+  entrypoints.get(component.entrypoint).add(component.identifier)
+}
+
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Use a stable component from the `@primer/react` entrypoint, or check the docs for alternatives',
+      recommended: true,
+      url: url(module),
+    },
+    fixable: true,
+    schema: [],
+  },
+  create(context) {
+    return {
+      ImportDeclaration(node) {
+        if (!entrypoints.has(node.source.value)) {
+          return
+        }
+
+        const entrypoint = entrypoints.get(node.source.value)
+
+        const experimental = node.specifiers.filter(specifier => {
+          return entrypoint.has(specifier.imported.name)
+        })
+
+        const components = experimental.map(specifier => specifier.imported.name)
+
+        if (experimental.length === 0) {
+          return
+        }
+
+        if (experimental.length > 0) {
+          // eslint-disable-next-line i18n-text/no-en
+          const message = `The experimental ${components.join(', ')} ${
+            components.length > 1 ? 'are' : 'is'
+          } deprecated. Please import from the stable entrypoint (@primer/react) if available. Check https://primer.style/product/getting-started/react/migration-guides/ for migration guidance or https://primer.style/product/components/ for alternative components.`
+
+          context.report({
+            node,
+            message,
+          })
+        }
+      },
+    }
+  },
+}