Add checkImport rule

Author: colebemis

src/rules/__tests__/no-deprecated-colors.test.js

@@ -43,6 +43,16 @@ ruleTester.run('no-deprecated-colors', rule, {
         }
       ]
     },
+    {
+      code: `import {Box} from "../components"; function Example() { return <Box color="text.primary">Hello</Box> }`,
+      output: `import {Box} from "../components"; function Example() { return <Box color="fg.default">Hello</Box> }`,
+      options: [{checkImport: false}],
+      errors: [
+        {
+          message: '"text.primary" is deprecated. Use "fg.default" instead.'
+        }
+      ]
+    },
     {
       code: `import Box from '@primer/components/lib-esm/Box'; function Example() { return <Box color="text.primary">Hello</Box> }`,
       output: `import Box from '@primer/components/lib-esm/Box'; function Example() { return <Box color="fg.default">Hello</Box> }`,

src/rules/no-deprecated-colors.js

@@ -5,13 +5,28 @@ const styledSystemColorProps = ['color', 'bg', 'backgroundColor', 'borderColor',
 module.exports = {
   meta: {
     type: 'suggestion',
-    fixable: 'code'
+    fixable: 'code',
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          checkImport: {
+            type: 'boolean'
+          }
+        },
+        additionalProperties: false
+      }
+    ]
   },
   create(context) {
+    // If `shouldCheckImport` is true, this rule will only check for deprecated colors
+    // used in functions and components that are imported from `@primer/components`.
+    const shouldCheckImport = context.options[0] ? context.options[0].checkImport : true
+
     return {
       JSXOpeningElement(node) {
         // Skip if component was not imported from @primer/components
-        if (!isPrimerComponent(node.name, context.getScope(node))) {
+        if (shouldCheckImport && !isPrimerComponent(node.name, context.getScope(node))) {
           return
         }
 
@@ -49,7 +64,10 @@ module.exports = {
       CallExpression(node) {
         // Skip if not calling the `themeGet` or `get` function
         // `get` is the internal version of `themeGet` that's used in the primer/react repository
-        if (!isThemeGet(node.callee, context.getScope(node)) && !isGet(node.callee, context.getScope(node))) {
+        if (
+          !isThemeGet(node.callee, context.getScope(node), shouldCheckImport) &&
+          !isGet(node.callee, context.getScope(node))
+        ) {
           return
         }
 
@@ -95,11 +113,17 @@ function isPrimerComponent(identifier, scope) {
   return isImportedFrom(/^@primer\/components/, identifier, scope)
 }
 
-function isThemeGet(identifier, scope) {
-  return isImportedFrom(/^@primer\/components/, identifier, scope) && identifier.name === 'themeGet'
+function isThemeGet(identifier, scope, shouldCheckImport = true) {
+  if (shouldCheckImport) {
+    return isImportedFrom(/^@primer\/components/, identifier, scope) && identifier.name === 'themeGet'
+  }
+
+  return identifier.name === 'themeGet'
 }
 
+// `get` is the internal version of `themeGet` that's used in the primer/react repository.
 function isGet(identifier, scope) {
+  // This is a flaky way to check for the `get` function and should probably be improved.
   return isImportedFrom(/^\.\.?\/constants$/, identifier, scope) && identifier.name === 'get'
 }