eslint-plugin-primer-react 0.6.1 → 0.7.1-rc.04b2811

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # eslint-plugin-primer-react
 
+## 0.7.1
+
+### Patch Changes
+
+- [#22](https://github.com/primer/eslint-plugin-primer-react/pull/22) [`87d0fd6`](https://github.com/primer/eslint-plugin-primer-react/commit/87d0fd6af8a18a2a570c3770571b16fe3b5c3a30) Thanks [@dmarcey](https://github.com/dmarcey)! - Ignore non-literal, non-string arguments to `themeGet` in `no-deprecated-colors` rule
+
+## 0.7.0
+
+### Minor Changes
+
+- [#18](https://github.com/primer/eslint-plugin-primer-react/pull/18) [`f0c7a3d`](https://github.com/primer/eslint-plugin-primer-react/commit/f0c7a3d1ab1d60df2c95b86c80d930d6ef15bde1) Thanks [@jfuchs](https://github.com/jfuchs)! - Introduced an option on no-system-props to include utility components (includeUtilityComponents).
+
+* [#20](https://github.com/primer/eslint-plugin-primer-react/pull/20) [`b0824f6`](https://github.com/primer/eslint-plugin-primer-react/commit/b0824f6c7c69cdf7d70d831626be37f606d70f73) Thanks [@jfuchs](https://github.com/jfuchs)! - Updates no-system-props rule to always exclude the 'variant' prop no matter which component.
+
 ## 0.6.1
 
 ### Patch Changes

package/README.md

@@ -12,7 +12,7 @@ ESLint rules for Primer React
    npm install --save-dev eslint-plugin-primer-react
 
    # or
-   
+
    yarn add --dev eslint-plugin-primer-react
    ```
 
@@ -30,3 +30,4 @@ ESLint rules for Primer React
 ## Rules
 
 - [no-deprecated-colors](https://github.com/primer/eslint-plugin-primer-react/blob/main/docs/rules/no-deprecated-colors.md)
+- [no-system-props](https://github.com/primer/eslint-plugin-primer-react/blob/main/docs/rules/no-system-props.md)

package/docs/rules/no-system-props.md

@@ -38,3 +38,19 @@ import {Avatar} from 'some-other-library'
 // System props passed to non-Primer components are allowed
 <Avatar mr={2} />
 ```
+
+## Options
+
+- `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`.
+
+  ```js
+  /* eslint primer-react/no-system-props: ["warn", {"includeUtilityComponents": true}] */
+  import {Box} from '@primer/components'
+
+  function App() {
+    // Enabling `includeUtilityComponents` will find system prop usage on utility components like this:
+    return <Box width={200} />
+  }
+  ```