eslint-plugin-primer-react 4.1.2-rc.cfb8ae8 → 4.1.3-rc.90c8886

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # eslint-plugin-primer-react
 
+## 4.1.3
+
+### Patch Changes
+
+- [#152](https://github.com/primer/eslint-plugin-primer-react/pull/152) [`7baeb96`](https://github.com/primer/eslint-plugin-primer-react/commit/7baeb9684cc5f84847f004fee282a3362517d7d0) Thanks [@siddharthkp](https://github.com/siddharthkp)! - no-system-props: Add option to ignore specific component names
+
 ## 4.1.2
 
 ### Patch Changes

package/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "eslint-plugin-primer-react",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "eslint-plugin-primer-react",
-      "version": "4.1.0",
+      "version": "4.1.1",
       "license": "MIT",
       "dependencies": {
         "@styled-system/props": "^5.1.5",
@@ -1900,9 +1900,9 @@
       }
     },
     "node_modules/@primer/primitives": {
-      "version": "7.15.8",
-      "resolved": "https://registry.npmjs.org/@primer/primitives/-/primitives-7.15.8.tgz",
-      "integrity": "sha512-AVJeqvRdNWl6EWP8HaHMHi/nPOepZ/cAPb2ECVYhs2L/X+qmXRePeWv6sAMSFBySPA+1srLAbRBRP8/9nrunWw==",
+      "version": "7.15.9",
+      "resolved": "https://registry.npmjs.org/@primer/primitives/-/primitives-7.15.9.tgz",
+      "integrity": "sha512-1dDNxokYV8sP2QDHMaAaEnRTxhYNBznf4QDTe4Gx9VzOXLexRvqrhvRitDbefbyfvO0yPr5TKI2nGCoz5T5zrQ==",
       "dev": true
     },
     "node_modules/@sinclair/typebox": {
@@ -10021,9 +10021,9 @@
       "dev": true
     },
     "@primer/primitives": {
-      "version": "7.15.8",
-      "resolved": "https://registry.npmjs.org/@primer/primitives/-/primitives-7.15.8.tgz",
-      "integrity": "sha512-AVJeqvRdNWl6EWP8HaHMHi/nPOepZ/cAPb2ECVYhs2L/X+qmXRePeWv6sAMSFBySPA+1srLAbRBRP8/9nrunWw==",
+      "version": "7.15.9",
+      "resolved": "https://registry.npmjs.org/@primer/primitives/-/primitives-7.15.9.tgz",
+      "integrity": "sha512-1dDNxokYV8sP2QDHMaAaEnRTxhYNBznf4QDTe4Gx9VzOXLexRvqrhvRitDbefbyfvO0yPr5TKI2nGCoz5T5zrQ==",
       "dev": true
     },
     "@sinclair/typebox": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-primer-react",
-  "version": "4.1.2-rc.cfb8ae8",
+  "version": "4.1.3-rc.90c8886",
   "description": "ESLint rules for Primer React",
   "main": "src/index.js",
   "scripts": {

package/src/rules/__tests__/no-system-props.test.js

@@ -23,6 +23,11 @@ ruleTester.run('no-system-props', rule, {
     `import {Button} from '@primer/react'; <Button size="large" />`,
     `import {ActionMenu} from '@primer/react'; <ActionMenu.Overlay width="large" />`,
     {code: `<img width="200px" />`, options: [{skipImportCheck: true}]},
+    {code: `<Placeholder width="200px" />`, options: [{skipImportCheck: true, ignoreNames: ['Placeholder']}]},
+    {
+      code: `<Placeholder.Header width="200px" />`,
+      options: [{skipImportCheck: true, ignoreNames: ['Placeholder.Header']}],
+    },
   ],
   invalid: [
     {

package/src/rules/no-system-props.js

@@ -32,6 +32,7 @@ const excludedComponentProps = new Map([
   ['SplitPageLayout.Pane', new Set(['padding', 'position', 'width'])],
   ['SplitPageLayout.Content', new Set(['padding', 'width'])],
   ['StyledOcticon', new Set(['size'])],
+  ['Octicon', new Set(['size', 'color'])],
   ['PointerBox', new Set(['bg'])],
   ['TextInput', new Set(['size'])],
   ['TextInputWithTokens', new Set(['size', 'maxHeight'])],
@@ -55,12 +56,9 @@ module.exports = {
     schema: [
       {
         properties: {
-          skipImportCheck: {
-            type: 'boolean',
-          },
-          includeUtilityComponents: {
-            type: 'boolean',
-          },
+          skipImportCheck: {type: 'boolean'},
+          includeUtilityComponents: {type: 'boolean'},
+          ignoreNames: {type: 'array'},
         },
       },
     ],
@@ -72,8 +70,8 @@ module.exports = {
     // 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/react`).
     const skipImportCheck = context.options[0] ? context.options[0].skipImportCheck : false
-
     const includeUtilityComponents = context.options[0] ? context.options[0].includeUtilityComponents : false
+    const ignoreNames = context.options[0] ? context.options[0].ignoreNames || [] : []
 
     const excludedComponents = new Set([
       ...alwaysExcludedComponents,
@@ -92,6 +90,7 @@ module.exports = {
         }
 
         const componentName = getJSXOpeningElementName(jsxNode)
+        if (ignoreNames.length && ignoreNames.includes(componentName)) return
 
         if (excludedComponents.has(componentName)) return