Merge pull request #21 from SferaDev/skip-import-system-props

Add Skip import option to system props rule

.changeset/gorgeous-dots-promise.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-primer-react": minor
+---
+
+`no-system-props`: Add `skipImportCheck` option

docs/rules/no-system-props.md

@@ -1,4 +1,4 @@
-# Disallow use of styled-system props (no-system-colors)
+# Disallow use of styled-system props (no-system-props)
 
 🔧 The `--fix` option on the [ESLint CLI](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule.
 
@@ -41,6 +41,10 @@ import {Avatar} from 'some-other-library'
 
 ## Options
 
+- `skipImportCheck` (default: `false`)
+
+  By default, the `no-system-props` rule will only check for styled system props used in functions and components that are imported from `@primer/react`. You can disable this behavior by setting `skipImportCheck` to `true`. This is useful for linting custom components that pass styled system props down to Primer React components.
+
 - `includeUtilityComponents` (default: `false`)
 
   By default, `Box` and `Text` are excluded because styled system props are not deprecated in our utility components. If you prefer to avoid styled system props there as well for consistency, you can set `includeUtilityComponents` to `true`.

src/rules/no-system-props.js

@@ -13,7 +13,16 @@ const utilityComponents = new Set(['Box', 'Text'])
 // Components for which we allow a set of prop names
 const excludedComponentProps = new Map([
   ['AnchoredOverlay', new Set(['width', 'height'])],
+  ['Avatar', new Set(['size'])],
+  ['AvatarToken', new Set(['size'])],
+  ['CircleOcticon', new Set(['size'])],
   ['Dialog', new Set(['width', 'height'])],
+  ['IssueLabelToken', new Set(['size'])],
+  ['ProgressBar', new Set(['bg'])],
+  ['Spinner', new Set(['size'])],
+  ['StyledOcticon', new Set(['size'])],
+  ['PointerBox', new Set(['bg'])],
+  ['Token', new Set(['size'])],
   ['PageLayout', new Set(['padding'])],
   ['ProgressBar', new Set(['bg'])],
   ['PointerBox', new Set(['bg'])]
@@ -28,6 +37,9 @@ module.exports = {
     schema: [
       {
         properties: {
+          skipImportCheck: {
+            type: 'boolean'
+          },
           includeUtilityComponents: {
             type: 'boolean'
           }
@@ -39,6 +51,10 @@ module.exports = {
     }
   },
   create(context) {
+    // If `skipImportCheck` is true, this rule will check for deprecated styled system props
+    // used in any components (not just ones that are imported from `@primer/components`).
+    const skipImportCheck = context.options[0] ? context.options[0].skipImportCheck : false
+
     const includeUtilityComponents = context.options[0] ? context.options[0].includeUtilityComponents : false
 
     const excludedComponents = new Set([
@@ -48,7 +64,7 @@ module.exports = {
 
     return {
       JSXOpeningElement(jsxNode) {
-        if (!isPrimerComponent(jsxNode.name, context.getScope(jsxNode))) return
+        if (!skipImportCheck && !isPrimerComponent(jsxNode.name, context.getScope(jsxNode))) return
         if (excludedComponents.has(jsxNode.name.name)) return
 
         // Create an object mapping from prop name to the AST node for that attribute
@@ -64,7 +80,7 @@ module.exports = {
         // Create an array of system prop attribute nodes
         let systemProps = Object.values(pick(propsByNameObject))
 
-        let excludedProps = excludedComponentProps.has(jsxNode.name.name)
+        const excludedProps = excludedComponentProps.has(jsxNode.name.name)
           ? new Set([...alwaysExcludedProps, ...excludedComponentProps.get(jsxNode.name.name)])
           : alwaysExcludedProps
 
@@ -142,12 +158,12 @@ const excludeSxEntriesFromStyleMap = (stylesMap, sxProp) => {
   if (
     !sxProp.value ||
     sxProp.value.type !== 'JSXExpressionContainer' ||
-    sxProp.value.expression.type != 'ObjectExpression'
+    sxProp.value.expression.type !== 'ObjectExpression'
   ) {
     return stylesMap
   }
   return new Map(
-    [...stylesMap].filter(([key, _value]) => {
+    [...stylesMap].filter(([key]) => {
       return !some(sxProp.value.expression.properties, p => p.type === 'Property' && p.key.name === key)
     })
   )