feat: add no-sx-prop rule

Author: joshblack

docs/rules/no-sx-prop.md

@@ -0,0 +1,33 @@
+# No Wildcard Imports
+
+## Rule Details
+
+This rule enforces that no sx props are used with `@primer/react`.
+
+👎 Examples of **incorrect** code for this rule
+
+```jsx
+import {Button} from '@primer/react'
+
+function ExampleComponent() {
+  return (
+    <Button
+      sx={
+        {
+          /* ... */
+        }
+      }
+    />
+  )
+}
+```
+
+👍 Examples of **correct** code for this rule:
+
+```jsx
+import {Button} from '@primer/react'
+
+function ExampleComponent() {
+  return <Button className="..." />
+}
+```

src/index.js

@@ -12,6 +12,7 @@ module.exports = {
     'a11y-use-next-tooltip': require('./rules/a11y-use-next-tooltip'),
     'use-deprecated-from-deprecated': require('./rules/use-deprecated-from-deprecated'),
     'no-wildcard-imports': require('./rules/no-wildcard-imports'),
+    'no-sx-prop': require('./rules/no-sx-prop'),
     'no-unnecessary-components': require('./rules/no-unnecessary-components'),
     'prefer-action-list-item-onselect': require('./rules/prefer-action-list-item-onselect'),
   },

src/rules/__tests__/no-sx-prop.test.js

@@ -0,0 +1,34 @@
+'use strict'
+
+const {RuleTester} = require('eslint')
+const rule = require('../no-sx-prop')
+
+const ruleTester = new RuleTester({
+  parser: require.resolve('@typescript-eslint/parser'),
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
+})
+
+ruleTester.run('no-sx-prop', rule, {
+  valid: [`import {Button} from '@primer/react'`],
+  invalid: [
+    {
+      code: `
+        import {SegmentedControl} from '@primer/react';
+        function Example() {
+          return <SegmentedControl sx={{color: 'red'}} />
+        }
+      `,
+      errors: [
+        {
+          messageId: 'sxProp',
+        },
+      ],
+    },
+  ],
+})

src/rules/no-sx-prop.js

@@ -0,0 +1,50 @@
+'use strict'
+
+const url = require('../url')
+
+const forbidden = new Set([
+  'SegmentedControl',
+  // 'ActionList',
+  // 'ActionList.Divider',
+  // 'ActionList.Group',
+  // 'ActionList.Item',
+  // 'ActionList.LeadingVisual',
+  // 'ActionList.LinkItem',
+
+  // 'UnderlineNav',
+  // 'UnderlineNav.Item',
+])
+
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'The sx prop is discouraged. Use CSS Modules instead',
+      recommended: true,
+      url: url(module),
+    },
+    fixable: true,
+    schema: [],
+    messages: {
+      sxProp:
+        'The `sx` prop has been deprecated by @primer/react and will be removed in the next major release. Please migrate to CSS Modules instead.',
+    },
+  },
+  create(context) {
+    return {
+      JSXOpeningElement(node) {
+        if (!forbidden.has(node.name.name)) {
+          return
+        }
+
+        context.report({
+          node,
+          messageId: 'sxProp',
+        })
+      },
+    }
+  },
+}