Document checkImport option

Author: colebemis

docs/rules/no-deprecated-colors.md

@@ -2,13 +2,12 @@
 
 🔧 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.
 
-[Theming](https://primer.style/react/theming) in Primer React is made possible by a theme object that defines your application's colors, spacing, fonts, and more. The color variables in Primer React's [default theme object](https://primer.style/react/theme-reference) are pulled from [Primer Primitives](https://github.com/primer/primitives). When a color variable is deprecated in Primer Primitives, it's important to remove references to that color variable in your application before it's removed from the library.   
+[Theming](https://primer.style/react/theming) in Primer React is made possible by a theme object that defines your application's colors, spacing, fonts, and more. The color variables in Primer React's [default theme object](https://primer.style/react/theme-reference) are pulled from [Primer Primitives](https://github.com/primer/primitives). When a color variable is deprecated in Primer Primitives, it's important to remove references to that color variable in your application before it's removed from the library.
 
 ## Rule details
 
 This rule disallows references to color variables that are deprecated in [Primer Primitives](https://github.com/primer/primitives).
 
-
 👎 Examples of **incorrect** code for this rule:
 
 ```jsx
@@ -21,7 +20,7 @@ const SystemPropExample() = () => <Box color="some.deprecated.color">Incorrect</
 const SxPropExample() = () => <Box sx={{color: 'some.deprecated.color'}}>Incorrect</Box>
 
 const ThemeGetExample = styled.div`
-  color: ${themeGet('some.deprecated.color')};
+  color: ${themeGet('colors.some.deprecated.color')};
 `
 ```
 
@@ -37,6 +36,16 @@ const SystemPropExample() = () => <Box color="some.color">Incorrect</Box>
 const SxPropExample() = () => <Box sx={{color: 'some.color'}}>Incorrect</Box>
 
 const ThemeGetExample = styled.div`
-  color: ${themeGet('some.color')};
+  color: ${themeGet('colors.some.color')};
 `
 ```
+
+## Options
+
+- `checkImport` (default: `true`)
+
+  By default, the `no-deprecated-colors` rule will only check for deprecated colors used in functions and components that are imported from `@primer/components`. You can disable this behavior by setting `checkImport` to `false`. This is useful for linting custom components that that pass color-related props down to Primer React components.
+
+  ```
+  "primer-react/no-deprecated-colors": ["warn", {"checkImport": false}]
+  ```