Merge branch 'main' into bs/rule-for-tooltip-v2

Author: broccolinisoup

CHANGELOG.md

@@ -1,5 +1,15 @@
 # eslint-plugin-primer-react
 
+## 4.1.0
+
+### Minor Changes
+
+- [#129](https://github.com/primer/eslint-plugin-primer-react/pull/129) [`eb04624`](https://github.com/primer/eslint-plugin-primer-react/commit/eb046249daaa9ab72d9ca4bbfba30fd494a79e23) Thanks [@joshblack](https://github.com/joshblack)! - Add no-deprecated-entrypoints rule to lint against deprecated import usage in @primer/react
+
+### Patch Changes
+
+- [#133](https://github.com/primer/eslint-plugin-primer-react/pull/133) [`5cc9630`](https://github.com/primer/eslint-plugin-primer-react/commit/5cc96305bfa884cf9f447d1e033bc2f5c9e110b7) Thanks [@siddharthkp](https://github.com/siddharthkp)! - no-system-props: Add alignContent to allowed props for Button
+
 ## 4.0.4
 
 ### Patch Changes

docs/rules/no-deprecated-entrypoints.md

@@ -0,0 +1,25 @@
+# No Deprecated Entrypoints
+
+## Rule Details
+
+This rule enforces the usage of non-deprecated entrypoints from `@primer/react`.
+
+👎 Examples of **incorrect** code for this rule
+
+```jsx
+import {DataTable} from '@primer/react/drafts'
+
+function ExampleComponent() {
+  return <DataTable>{/* ... */}</DataTable>
+}
+```
+
+👍 Examples of **correct** code for this rule:
+
+```jsx
+import {ExampleComponent} from '@primer/react/experimental'
+
+function ExampleComponent() {
+  return <DataTable>{/* ... */}</DataTable>
+}
+```

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-primer-react",
-  "version": "4.0.4",
+  "version": "4.1.0",
   "description": "ESLint rules for Primer React",
   "main": "src/index.js",
   "scripts": {
@@ -36,7 +36,7 @@
     "styled-system": "^5.1.5"
   },
   "devDependencies": {
-    "@changesets/changelog-github": "^0.4.0",
+    "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.16.0",
     "@github/markdownlint-github": "^0.6.0",
     "@github/prettier-config": "0.0.6",

package.json

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

src/index.js

@@ -0,0 +1,30 @@
+'use strict'
+
+const {RuleTester} = require('eslint')
+const rule = require('../no-deprecated-entrypoints')
+
+const ruleTester = new RuleTester({
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
+})
+
+ruleTester.run('no-deprecated-entrypoints', rule, {
+  valid: [`import {Box} from '@primer/react';`],
+  invalid: [
+    {
+      code: `import {DataTable} from '@primer/react/drafts';`,
+      output: `import {DataTable} from '@primer/react/experimental';`,
+      errors: [
+        {
+          message:
+            'The drafts entrypoint is deprecated and will be removed in the next major release. Use the experimental entrypoint instead',
+        },
+      ],
+    },
+  ],
+})

src/rules/__tests__/no-deprecated-entrypoints.test.js

@@ -0,0 +1,35 @@
+'use strict'
+
+const url = require('../url')
+
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Avoid using deprecated entrypoints from @primer/react',
+      recommended: true,
+      url: url(module),
+    },
+    fixable: true,
+    schema: [],
+  },
+  create(context) {
+    return {
+      ImportDeclaration(node) {
+        if (node.source.value === '@primer/react/drafts') {
+          context.report({
+            node,
+            message:
+              'The drafts entrypoint is deprecated and will be removed in the next major release. Use the experimental entrypoint instead',
+            fix(fixer) {
+              return fixer.replaceText(node.source, `'@primer/react/experimental'`)
+            },
+          })
+        }
+      },
+    }
+  },
+}

src/rules/no-deprecated-entrypoints.js

@@ -19,6 +19,7 @@ const excludedComponentProps = new Map([
   ['Avatar', new Set(['size'])],
   ['AvatarToken', new Set(['size'])],
   ['Blankslate', new Set(['border'])],
+  ['Button', new Set(['alignContent'])],
   ['CircleOcticon', new Set(['size'])],
   ['Dialog', new Set(['width', 'height'])],
   ['IssueLabelToken', new Set(['size'])],