@atlaskit/eslint-plugin-design-system 8.18.0 → 8.18.1

package/dist/es2019/rules/use-primitives/transformers/styled-component-to-primitive.js

@@ -0,0 +1,59 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { updateJSXElementName, upsertImportDeclaration } from '../utils';
+import { styledObjectToXcssTokens } from './css-to-xcss';
+/**
+ * All required validation steps have been taken care of before this
+ * transformer is called, so it just goes ahead providing all necessary fixes
+ */
+export const styledComponentToPrimitive = ({
+  stylesRef,
+  jsxRef
+}, context) => {
+  return fixer => {
+    // generates the new variable name: MyComponent -> myComponentStyles
+    const calculatedStylesVariableName = isNodeOfType(stylesRef.id, 'Identifier') && `${stylesRef.id.name.replace(stylesRef.id.name[0], stylesRef.id.name[0].toLowerCase())}Styles`;
+    if (!calculatedStylesVariableName) {
+      return [];
+    }
+    const importFixes = upsertImportDeclaration({
+      packageName: '@atlaskit/primitives',
+      specifiers: ['Box', 'xcss']
+    }, context, fixer);
+    const stylesFixes = convertStyledComponentToXcss(stylesRef, calculatedStylesVariableName, fixer);
+    const jsxFixes = convertJsxCallSite(jsxRef, calculatedStylesVariableName, fixer);
+    return [importFixes, ...stylesFixes, ...jsxFixes].filter(fix => Boolean(fix)); // Some of the transformers can return arrays with undefined, so filter them out
+  };
+};
+
+const convertStyledComponentToXcss = (stylesRef, newStylesVariableName, fixer) => {
+  const fixes = [];
+
+  // renames the variable from MyComponent to myComponentStyles
+  fixes.push(fixer.replaceText(stylesRef.id, newStylesVariableName));
+
+  // renames the function call from styled.<tag> to xcss
+  if (stylesRef.init && isNodeOfType(stylesRef.init, 'CallExpression')) {
+    fixes.push(fixer.replaceText(stylesRef.init.callee, 'xcss'));
+  }
+
+  // converts CSS values to XCSS-compatible tokens
+  if (stylesRef.init && isNodeOfType(stylesRef.init, 'CallExpression')) {
+    const objectExpression = stylesRef.init.arguments[0];
+    if (isNodeOfType(objectExpression, 'ObjectExpression')) {
+      fixes.push(...styledObjectToXcssTokens(objectExpression, fixer));
+    }
+  }
+  return fixes;
+};
+const convertJsxCallSite = (jsxRef, newStylesVariableName, fixer) => {
+  const fixes = [];
+
+  // renames the JSX call site
+  if (isNodeOfType(jsxRef.parent, 'JSXElement')) {
+    fixes.push(...updateJSXElementName(jsxRef.parent, 'Box', fixer));
+  }
+
+  // adds xcss prop
+  fixes.push(fixer.insertTextAfter(jsxRef.name, ` xcss={${newStylesVariableName}}`));
+  return fixes;
+};

package/dist/es2019/rules/use-primitives/utils/convert-ast-object-expression-to-js-object.js

@@ -7,6 +7,20 @@ import { isNodeOfType } from 'eslint-codemod-utils';
  */
 export const convertASTObjectExpressionToJSObject = styles => {
   const styleObj = {};
+
+  // if we see any spread props we stop and return false to indicate this is unsupported
+  if (!styles.properties.every(prop => isNodeOfType(prop, 'Property'))) {
+    return false;
+  }
+
+  // TODO: We need to harden this logic.
+  // It currently generates a false positive for:
+  // styled.div({
+  //  marginTop: "0px",
+  //  marginBottom: token("space.100", "8px"),
+  // })
+  // as the value for `marginBottom` is not a string, so it is just skipped
+  // from the resulting map and this causes the rule to trigger when it shouldn't
   styles.properties.forEach(prop => {
     if (!isNodeOfType(prop, 'Property')) {
       return;

package/dist/es2019/rules/use-primitives/utils/find-valid-jsx-usage-to-transform.js

@@ -0,0 +1,32 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+
+/**
+ * Given a component name finds its JSX usages and performs some
+ * additional validations to ensure transformation can be done correctly
+ */
+export const findValidJsxUsageToTransform = (componentName, scope) => {
+  const variableDeclaration = scope.variables.find(v => v.name === componentName);
+  if (!variableDeclaration) {
+    return;
+  }
+
+  // length here should be exactly 2 to indicate only two references:
+  // one being the variable declaration itself
+  // second being the JSX call site
+  // we might consider handling multiple local JSX call sites in the future
+  // but "this is good enough for now"™️
+  if (variableDeclaration.references.length !== 2) {
+    return;
+  }
+  const jsxUsage = variableDeclaration.references[1].identifier;
+  if (!isNodeOfType(jsxUsage, 'JSXIdentifier')) {
+    return;
+  }
+  const jsxOpeningElement = jsxUsage.parent;
+  // we could relatively easily support some safe attributes like
+  // "id" or "testId" but support will be expanded as we go
+  if (!isNodeOfType(jsxOpeningElement, 'JSXOpeningElement') || jsxOpeningElement.attributes.length > 0) {
+    return;
+  }
+  return jsxOpeningElement;
+};

package/dist/es2019/rules/use-primitives/utils/find-valid-styled-component-call.js

@@ -0,0 +1,47 @@
+import { closestOfType, isNodeOfType } from 'eslint-codemod-utils';
+import { validPrimitiveElements } from './is-valid-tag-name';
+
+/**
+ * returns a variable reference if preconditions are favourable for
+ * the transformation to proceed, undefined otherwise.
+ */
+
+export const findValidStyledComponentCall = node => {
+  // halts unless we are dealing with a styled component
+  if (!isStyledCallExpression(node)) {
+    return;
+  }
+  // halts if the component is being exported directly
+  if (closestOfType(node, 'ExportNamedDeclaration')) {
+    return;
+  }
+  const styledComponentVariableRef = node.parent;
+  // halts if the styled component is not assigned to a variable immediately
+  if (!isNodeOfType(styledComponentVariableRef, 'VariableDeclarator')) {
+    return;
+  }
+  return styledComponentVariableRef;
+};
+
+/**
+ * Some verbose precondition checks but all it does is check
+ * a call expression is of form `styled.div` or `styled2.div`
+ *
+ * In the future it could be enhanced to double check `styled` and `styled2`
+ * are Compiled imports but as is should work for the majority of use cases
+ */
+const isStyledCallExpression = call => {
+  if (!isNodeOfType(call, 'CallExpression')) {
+    return false;
+  }
+  if (!isNodeOfType(call.callee, 'MemberExpression')) {
+    return false;
+  }
+  if (!isNodeOfType(call.callee.object, 'Identifier') || !isNodeOfType(call.callee.property, 'Identifier')) {
+    return false;
+  }
+  if (/^styled2?$/.test(call.callee.object.name) && validPrimitiveElements.has(call.callee.property.name)) {
+    return true;
+  }
+  return false;
+};

package/dist/es2019/rules/use-primitives/utils/index.js

@@ -1,11 +1,14 @@
 export { containsOnlySupportedAttrs } from './contains-only-supported-attrs';
 export { convertASTObjectExpressionToJSObject } from './convert-ast-object-expression-to-js-object';
+export { findValidJsxUsageToTransform } from './find-valid-jsx-usage-to-transform';
+export { findValidStyledComponentCall } from './find-valid-styled-component-call';
 export { getAttributeValueIdentifier } from './get-attribute-value-identifier';
 export { getFunctionArgumentAtPos } from './get-function-argument-at-pos';
 export { getJSXAttributeByName } from './get-jsx-attribute-by-name';
 export { getVariableDefinitionValue } from './get-variable-definition-value';
 export { getVariableUsagesCount } from './get-variable-usage-count';
 export { isFunctionNamed } from './is-function-named';
+export { isValidCssPropertiesToTransform } from './is-valid-css-properties-to-transform';
 export { isValidTagName } from './is-valid-tag-name';
 export { updateJSXAttributeByName } from './update-jsx-attribute-by-name';
 export { updateJSXElementName } from './update-jsx-element-name';

package/dist/es2019/rules/use-primitives/utils/is-valid-css-properties-to-transform.js

@@ -0,0 +1,32 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { supportedStylesMap } from '../transformers/css-to-xcss';
+import { convertASTObjectExpressionToJSObject } from './convert-ast-object-expression-to-js-object';
+export const isValidCssPropertiesToTransform = node => {
+  const cssObjectExpression = node.arguments[0];
+  // Bail on empty object calls
+  if (!cssObjectExpression || !isNodeOfType(cssObjectExpression, 'ObjectExpression')) {
+    return false;
+  }
+  const cssObject = convertASTObjectExpressionToJSObject(cssObjectExpression);
+  // Bail if there are less or more than 1 styles defined
+  if (!cssObject || Object.keys(cssObject).length !== 1) {
+    return false;
+  }
+
+  // NOTE: Our approach with this lint rule is to strictly whitelist css properties we can map.
+  // It means we have to provide mappings for everything (e.g. `display: block`).
+  // However, from a maker's experience, it's much better that the rule doesn't report (if we miss a mapping)
+  // than the rule reporting on things that can't be mapped.
+  const containsOnlyValidStyles = Object.keys(cssObject).every(styleProperty => {
+    const styleValue = cssObject[styleProperty];
+    return supportedStylesMap[styleProperty] &&
+    // Is the key something we can map
+    supportedStylesMap[styleProperty][styleValue] // Is the value something we can map
+    ;
+  });
+
+  if (!containsOnlyValidStyles) {
+    return false;
+  }
+  return true;
+};

package/dist/es2019/rules/use-primitives/utils/is-valid-tag-name.js

@@ -1,4 +1,4 @@
-const validPrimitiveElements = new Set(['div']);
+export const validPrimitiveElements = new Set(['div']);
 export const isValidTagName = node => {
   if (node.openingElement.name.type !== 'JSXIdentifier') {
     return false;

package/dist/es2019/rules/use-primitives/utils/update-jsx-element-name.js

@@ -8,5 +8,5 @@ export const updateJSXElementName = (node, newName, fixer) => {
   const newClosingElement = closingElement &&
   // Self closing tags, like `<div />` don't need to have the closing tag updated
   fixer.replaceText(closingElement.name, jsxIdentifier(newName).toString());
-  return [newOpeningElement, newClosingElement];
+  return [newOpeningElement, newClosingElement || undefined];
 };

package/dist/esm/rules/use-primitives/index.js

@@ -1,8 +1,12 @@
 import { getIdentifierInParentScope, isNodeOfType } from 'eslint-codemod-utils';
+import assign from 'lodash/assign';
 import { createLintRule } from '../utils/create-rule';
-import { jsxElementToBoxTransformer, supportedStylesMap } from './transformers';
-import { containsOnlySupportedAttrs, convertASTObjectExpressionToJSObject, getAttributeValueIdentifier, getFunctionArgumentAtPos, getJSXAttributeByName, getVariableDefinitionValue, getVariableUsagesCount, isFunctionNamed, isValidTagName } from './utils';
+import { jsxElementToBoxTransformer, styledComponentToPrimitive } from './transformers';
+import { containsOnlySupportedAttrs, findValidJsxUsageToTransform, findValidStyledComponentCall, getAttributeValueIdentifier, getJSXAttributeByName, getVariableDefinitionValue, getVariableUsagesCount, isFunctionNamed, isValidCssPropertiesToTransform, isValidTagName } from './utils';
 var boxDocsUrl = 'https://atlassian.design/components/primitives/box';
+var defaultConfig = {
+  preview: false
+};
 var rule = createLintRule({
   meta: {
     name: 'use-primitives',
@@ -15,11 +19,43 @@ var rule = createLintRule({
       severity: 'warn'
     },
     messages: {
-      preferPrimitivesBox: "This \"{{element}}\" may be able to be replaced with a \"Box\". See ".concat(boxDocsUrl, " for guidance.")
+      preferPrimitivesBox: "This element can be replaced with a \"Box\" primitive. See ".concat(boxDocsUrl, " for additional guidance.")
     }
   },
   create: function create(context) {
+    var mergedConfig = assign({}, defaultConfig, context.options[0]);
     return {
+      // transforms styled.<html>(...) usages
+      CallExpression: function CallExpression(node) {
+        if (!mergedConfig.preview) {
+          return;
+        }
+        if (!isNodeOfType(node, 'CallExpression')) {
+          return;
+        }
+        var styledComponentVariableRef = findValidStyledComponentCall(node);
+        if (!styledComponentVariableRef || !isNodeOfType(styledComponentVariableRef.id, 'Identifier') || !isValidCssPropertiesToTransform(node)) {
+          return;
+        }
+        var styledComponentJsxRef = findValidJsxUsageToTransform(styledComponentVariableRef.id.name, context.getScope());
+        if (!styledComponentJsxRef) {
+          return;
+        }
+
+        // if we have both references at this point then we can offer a fix \o/
+        context.report({
+          node: styledComponentVariableRef,
+          messageId: 'preferPrimitivesBox',
+          suggest: [{
+            desc: "Convert ".concat(styledComponentVariableRef.id.name, " to Box"),
+            fix: styledComponentToPrimitive({
+              stylesRef: styledComponentVariableRef,
+              jsxRef: styledComponentJsxRef
+            }, context)
+          }]
+        });
+      },
+      // transforms <div css={...}> usages
       JSXOpeningElement: function JSXOpeningElement(node) {
         if (!isNodeOfType(node, 'JSXOpeningElement')) {
           return;
@@ -91,42 +127,10 @@ var shouldSuggestBox = function shouldSuggestBox(node, context
   // Find where `cssVariableName` is defined. We're looking for `const myStyles = css({...})`
   var cssVariableDefinition = getIdentifierInParentScope(context.getScope(), cssVariableName);
   var cssVariableValue = getVariableDefinitionValue(cssVariableDefinition);
-
   // Check if `cssVariableValue` is a function called `css()`
-  if (!isFunctionNamed(cssVariableValue, 'css')) {
-    return false;
-  }
-
-  // get the `{}` in `css({})`
-  // Zero indexed
-  var cssObjectExpression = getFunctionArgumentAtPos(cssVariableValue, 0);
-
-  // Bail on empty `css()` calls
-  if (!cssObjectExpression) {
-    return false;
-  }
-  var cssObject = convertASTObjectExpressionToJSObject(cssObjectExpression);
-
-  // Bail if there are less or more than 1 styles defined
-  if (Object.keys(cssObject).length !== 1) {
-    return false;
-  }
-
-  // NOTE: Our approach with this lint rule is to strictly whitelist css properties we can map.
-  // It means we have to provide mappings for everything (e.g. `display: block`).
-  // However, from a maker's experience, it's much better that the rule doesn't report (if we miss a mapping)
-  // than the rule reporting on things that can't be mapped.
-  var containsOnlyValidStyles = Object.keys(cssObject).every(function (styleProperty) {
-    var styleValue = cssObject[styleProperty];
-    return supportedStylesMap[styleProperty] &&
-    // Is the key something we can map
-    supportedStylesMap[styleProperty][styleValue] // Is the value something we can map
-    ;
-  });
-
-  if (!containsOnlyValidStyles) {
+  if (!cssVariableValue || !isFunctionNamed(cssVariableValue, 'css')) {
     return false;
   }
-  return true;
+  return isValidCssPropertiesToTransform(cssVariableValue.node.init);
 };
 export default rule;

package/dist/esm/rules/use-primitives/transformers/css-to-xcss.js

@@ -29,7 +29,14 @@ export var cssToXcssTransformer = function cssToXcssTransformer(node, context, f
   var cssObjectExpression = getFunctionArgumentAtPos(cssVariableValue, 0);
   return [
   // Update `css` function name to `xcss`.
-  fixer.replaceText(cssVariableValue.node.init.callee, identifier('xcss').toString())].concat(_toConsumableArray(cssObjectExpression.properties.map(function (entry) {
+  fixer.replaceText(cssVariableValue.node.init.callee, identifier('xcss').toString())].concat(_toConsumableArray(styledObjectToXcssTokens(cssObjectExpression, fixer)));
+};
+
+// Update css object values to xcss values. e.g. `'8px'` -> `'space.100'`
+// Note: `properties` in this context is a group of AST nodes that make up a key/value pair in an object.
+// e.g. `padding: '8px'`. For clarity, it's renamed to `entry` inside the `.map()`.
+export var styledObjectToXcssTokens = function styledObjectToXcssTokens(styles, fixer) {
+  return styles.properties.map(function (entry) {
     if (!isNodeOfType(entry, 'Property')) {
       return;
     }
@@ -44,7 +51,7 @@ export var cssToXcssTransformer = function cssToXcssTransformer(node, context, f
       return;
     }
     return fixer.replaceText(entry.value, literal("'".concat(supportedStylesMap[entry.key.name][value], "'")).toString());
-  })));
+  });
 };
 export var spaceTokenMap = {
   '0px': 'space.0',

package/dist/esm/rules/use-primitives/transformers/index.js

@@ -1,2 +1,3 @@
 export { cssToXcssTransformer, supportedStylesMap, spaceTokenMap } from './css-to-xcss';
-export { jsxElementToBoxTransformer } from './jsx-element-to-box';
+export { jsxElementToBoxTransformer } from './jsx-element-to-box';
+export { styledComponentToPrimitive } from './styled-component-to-primitive';

package/dist/esm/rules/use-primitives/transformers/styled-component-to-primitive.js

@@ -0,0 +1,61 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { updateJSXElementName, upsertImportDeclaration } from '../utils';
+import { styledObjectToXcssTokens } from './css-to-xcss';
+/**
+ * All required validation steps have been taken care of before this
+ * transformer is called, so it just goes ahead providing all necessary fixes
+ */
+export var styledComponentToPrimitive = function styledComponentToPrimitive(_ref, context) {
+  var stylesRef = _ref.stylesRef,
+    jsxRef = _ref.jsxRef;
+  return function (fixer) {
+    // generates the new variable name: MyComponent -> myComponentStyles
+    var calculatedStylesVariableName = isNodeOfType(stylesRef.id, 'Identifier') && "".concat(stylesRef.id.name.replace(stylesRef.id.name[0], stylesRef.id.name[0].toLowerCase()), "Styles");
+    if (!calculatedStylesVariableName) {
+      return [];
+    }
+    var importFixes = upsertImportDeclaration({
+      packageName: '@atlaskit/primitives',
+      specifiers: ['Box', 'xcss']
+    }, context, fixer);
+    var stylesFixes = convertStyledComponentToXcss(stylesRef, calculatedStylesVariableName, fixer);
+    var jsxFixes = convertJsxCallSite(jsxRef, calculatedStylesVariableName, fixer);
+    return [importFixes].concat(stylesFixes, jsxFixes).filter(function (fix) {
+      return Boolean(fix);
+    }); // Some of the transformers can return arrays with undefined, so filter them out
+  };
+};
+
+var convertStyledComponentToXcss = function convertStyledComponentToXcss(stylesRef, newStylesVariableName, fixer) {
+  var fixes = [];
+
+  // renames the variable from MyComponent to myComponentStyles
+  fixes.push(fixer.replaceText(stylesRef.id, newStylesVariableName));
+
+  // renames the function call from styled.<tag> to xcss
+  if (stylesRef.init && isNodeOfType(stylesRef.init, 'CallExpression')) {
+    fixes.push(fixer.replaceText(stylesRef.init.callee, 'xcss'));
+  }
+
+  // converts CSS values to XCSS-compatible tokens
+  if (stylesRef.init && isNodeOfType(stylesRef.init, 'CallExpression')) {
+    var objectExpression = stylesRef.init.arguments[0];
+    if (isNodeOfType(objectExpression, 'ObjectExpression')) {
+      fixes.push.apply(fixes, _toConsumableArray(styledObjectToXcssTokens(objectExpression, fixer)));
+    }
+  }
+  return fixes;
+};
+var convertJsxCallSite = function convertJsxCallSite(jsxRef, newStylesVariableName, fixer) {
+  var fixes = [];
+
+  // renames the JSX call site
+  if (isNodeOfType(jsxRef.parent, 'JSXElement')) {
+    fixes.push.apply(fixes, _toConsumableArray(updateJSXElementName(jsxRef.parent, 'Box', fixer)));
+  }
+
+  // adds xcss prop
+  fixes.push(fixer.insertTextAfter(jsxRef.name, " xcss={".concat(newStylesVariableName, "}")));
+  return fixes;
+};

package/dist/esm/rules/use-primitives/utils/convert-ast-object-expression-to-js-object.js

@@ -7,6 +7,22 @@ import { isNodeOfType } from 'eslint-codemod-utils';
  */
 export var convertASTObjectExpressionToJSObject = function convertASTObjectExpressionToJSObject(styles) {
   var styleObj = {};
+
+  // if we see any spread props we stop and return false to indicate this is unsupported
+  if (!styles.properties.every(function (prop) {
+    return isNodeOfType(prop, 'Property');
+  })) {
+    return false;
+  }
+
+  // TODO: We need to harden this logic.
+  // It currently generates a false positive for:
+  // styled.div({
+  //  marginTop: "0px",
+  //  marginBottom: token("space.100", "8px"),
+  // })
+  // as the value for `marginBottom` is not a string, so it is just skipped
+  // from the resulting map and this causes the rule to trigger when it shouldn't
   styles.properties.forEach(function (prop) {
     if (!isNodeOfType(prop, 'Property')) {
       return;

package/dist/esm/rules/use-primitives/utils/find-valid-jsx-usage-to-transform.js

@@ -0,0 +1,34 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+
+/**
+ * Given a component name finds its JSX usages and performs some
+ * additional validations to ensure transformation can be done correctly
+ */
+export var findValidJsxUsageToTransform = function findValidJsxUsageToTransform(componentName, scope) {
+  var variableDeclaration = scope.variables.find(function (v) {
+    return v.name === componentName;
+  });
+  if (!variableDeclaration) {
+    return;
+  }
+
+  // length here should be exactly 2 to indicate only two references:
+  // one being the variable declaration itself
+  // second being the JSX call site
+  // we might consider handling multiple local JSX call sites in the future
+  // but "this is good enough for now"™️
+  if (variableDeclaration.references.length !== 2) {
+    return;
+  }
+  var jsxUsage = variableDeclaration.references[1].identifier;
+  if (!isNodeOfType(jsxUsage, 'JSXIdentifier')) {
+    return;
+  }
+  var jsxOpeningElement = jsxUsage.parent;
+  // we could relatively easily support some safe attributes like
+  // "id" or "testId" but support will be expanded as we go
+  if (!isNodeOfType(jsxOpeningElement, 'JSXOpeningElement') || jsxOpeningElement.attributes.length > 0) {
+    return;
+  }
+  return jsxOpeningElement;
+};

package/dist/esm/rules/use-primitives/utils/find-valid-styled-component-call.js

@@ -0,0 +1,47 @@
+import { closestOfType, isNodeOfType } from 'eslint-codemod-utils';
+import { validPrimitiveElements } from './is-valid-tag-name';
+
+/**
+ * returns a variable reference if preconditions are favourable for
+ * the transformation to proceed, undefined otherwise.
+ */
+
+export var findValidStyledComponentCall = function findValidStyledComponentCall(node) {
+  // halts unless we are dealing with a styled component
+  if (!isStyledCallExpression(node)) {
+    return;
+  }
+  // halts if the component is being exported directly
+  if (closestOfType(node, 'ExportNamedDeclaration')) {
+    return;
+  }
+  var styledComponentVariableRef = node.parent;
+  // halts if the styled component is not assigned to a variable immediately
+  if (!isNodeOfType(styledComponentVariableRef, 'VariableDeclarator')) {
+    return;
+  }
+  return styledComponentVariableRef;
+};
+
+/**
+ * Some verbose precondition checks but all it does is check
+ * a call expression is of form `styled.div` or `styled2.div`
+ *
+ * In the future it could be enhanced to double check `styled` and `styled2`
+ * are Compiled imports but as is should work for the majority of use cases
+ */
+var isStyledCallExpression = function isStyledCallExpression(call) {
+  if (!isNodeOfType(call, 'CallExpression')) {
+    return false;
+  }
+  if (!isNodeOfType(call.callee, 'MemberExpression')) {
+    return false;
+  }
+  if (!isNodeOfType(call.callee.object, 'Identifier') || !isNodeOfType(call.callee.property, 'Identifier')) {
+    return false;
+  }
+  if (/^styled2?$/.test(call.callee.object.name) && validPrimitiveElements.has(call.callee.property.name)) {
+    return true;
+  }
+  return false;
+};

package/dist/esm/rules/use-primitives/utils/index.js

@@ -1,11 +1,14 @@
 export { containsOnlySupportedAttrs } from './contains-only-supported-attrs';
 export { convertASTObjectExpressionToJSObject } from './convert-ast-object-expression-to-js-object';
+export { findValidJsxUsageToTransform } from './find-valid-jsx-usage-to-transform';
+export { findValidStyledComponentCall } from './find-valid-styled-component-call';
 export { getAttributeValueIdentifier } from './get-attribute-value-identifier';
 export { getFunctionArgumentAtPos } from './get-function-argument-at-pos';
 export { getJSXAttributeByName } from './get-jsx-attribute-by-name';
 export { getVariableDefinitionValue } from './get-variable-definition-value';
 export { getVariableUsagesCount } from './get-variable-usage-count';
 export { isFunctionNamed } from './is-function-named';
+export { isValidCssPropertiesToTransform } from './is-valid-css-properties-to-transform';
 export { isValidTagName } from './is-valid-tag-name';
 export { updateJSXAttributeByName } from './update-jsx-attribute-by-name';
 export { updateJSXElementName } from './update-jsx-element-name';

package/dist/esm/rules/use-primitives/utils/is-valid-css-properties-to-transform.js

@@ -0,0 +1,32 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { supportedStylesMap } from '../transformers/css-to-xcss';
+import { convertASTObjectExpressionToJSObject } from './convert-ast-object-expression-to-js-object';
+export var isValidCssPropertiesToTransform = function isValidCssPropertiesToTransform(node) {
+  var cssObjectExpression = node.arguments[0];
+  // Bail on empty object calls
+  if (!cssObjectExpression || !isNodeOfType(cssObjectExpression, 'ObjectExpression')) {
+    return false;
+  }
+  var cssObject = convertASTObjectExpressionToJSObject(cssObjectExpression);
+  // Bail if there are less or more than 1 styles defined
+  if (!cssObject || Object.keys(cssObject).length !== 1) {
+    return false;
+  }
+
+  // NOTE: Our approach with this lint rule is to strictly whitelist css properties we can map.
+  // It means we have to provide mappings for everything (e.g. `display: block`).
+  // However, from a maker's experience, it's much better that the rule doesn't report (if we miss a mapping)
+  // than the rule reporting on things that can't be mapped.
+  var containsOnlyValidStyles = Object.keys(cssObject).every(function (styleProperty) {
+    var styleValue = cssObject[styleProperty];
+    return supportedStylesMap[styleProperty] &&
+    // Is the key something we can map
+    supportedStylesMap[styleProperty][styleValue] // Is the value something we can map
+    ;
+  });
+
+  if (!containsOnlyValidStyles) {
+    return false;
+  }
+  return true;
+};

package/dist/esm/rules/use-primitives/utils/is-valid-tag-name.js

@@ -1,4 +1,4 @@
-var validPrimitiveElements = new Set(['div']);
+export var validPrimitiveElements = new Set(['div']);
 export var isValidTagName = function isValidTagName(node) {
   if (node.openingElement.name.type !== 'JSXIdentifier') {
     return false;

package/dist/esm/rules/use-primitives/utils/update-jsx-element-name.js

@@ -6,5 +6,5 @@ export var updateJSXElementName = function updateJSXElementName(node, newName, f
   var newClosingElement = closingElement &&
   // Self closing tags, like `<div />` don't need to have the closing tag updated
   fixer.replaceText(closingElement.name, jsxIdentifier(newName).toString());
-  return [newOpeningElement, newClosingElement];
+  return [newOpeningElement, newClosingElement || undefined];
 };

package/dist/types/rules/use-primitives/transformers/css-to-xcss.d.ts

@@ -1,6 +1,7 @@
 import type { Rule } from 'eslint';
-import { JSXElement } from 'eslint-codemod-utils';
+import { JSXElement, ObjectExpression } from 'eslint-codemod-utils';
 export declare const cssToXcssTransformer: (node: JSXElement, context: Rule.RuleContext, fixer: Rule.RuleFixer) => (Rule.Fix | undefined)[];
+export declare const styledObjectToXcssTokens: (styles: ObjectExpression & Partial<Rule.NodeParentExtension>, fixer: Rule.RuleFixer) => (Rule.Fix | undefined)[];
 export declare const spaceTokenMap: {
     [key: string]: string;
 };

package/dist/types/rules/use-primitives/transformers/index.d.ts

@@ -1,2 +1,3 @@
 export { cssToXcssTransformer, supportedStylesMap, spaceTokenMap, } from './css-to-xcss';
 export { jsxElementToBoxTransformer } from './jsx-element-to-box';
+export { styledComponentToPrimitive } from './styled-component-to-primitive';

package/dist/types/rules/use-primitives/transformers/styled-component-to-primitive.d.ts

@@ -0,0 +1,13 @@
+import type { Rule } from 'eslint';
+import { JSXOpeningElement, VariableDeclarator } from 'eslint-codemod-utils';
+type StylesRef = VariableDeclarator & Rule.NodeParentExtension;
+type JSXRef = JSXOpeningElement & Rule.NodeParentExtension;
+/**
+ * All required validation steps have been taken care of before this
+ * transformer is called, so it just goes ahead providing all necessary fixes
+ */
+export declare const styledComponentToPrimitive: ({ stylesRef, jsxRef, }: {
+    stylesRef: StylesRef;
+    jsxRef: JSXRef;
+}, context: Rule.RuleContext) => (fixer: Rule.RuleFixer) => Rule.Fix[];
+export {};

package/dist/types/rules/use-primitives/utils/convert-ast-object-expression-to-js-object.d.ts

@@ -6,4 +6,4 @@ export type CSSPropStyleObject = {
 /**
  * Note: Not recursive. Only handles top level key/value pairs
  */
-export declare const convertASTObjectExpressionToJSObject: (styles: ObjectExpression & Partial<Rule.NodeParentExtension>) => CSSPropStyleObject;
+export declare const convertASTObjectExpressionToJSObject: (styles: ObjectExpression & Partial<Rule.NodeParentExtension>) => CSSPropStyleObject | false;

package/dist/types/rules/use-primitives/utils/find-valid-jsx-usage-to-transform.d.ts

@@ -0,0 +1,7 @@
+import type { Rule, Scope } from 'eslint';
+import { JSXOpeningElement } from 'eslint-codemod-utils';
+/**
+ * Given a component name finds its JSX usages and performs some
+ * additional validations to ensure transformation can be done correctly
+ */
+export declare const findValidJsxUsageToTransform: (componentName: string, scope: Scope.Scope) => (JSXOpeningElement & Rule.NodeParentExtension) | undefined;

package/dist/types/rules/use-primitives/utils/find-valid-styled-component-call.d.ts

@@ -0,0 +1,7 @@
+import type { Rule } from 'eslint';
+import { type VariableDeclarator } from 'eslint-codemod-utils';
+/**
+ * returns a variable reference if preconditions are favourable for
+ * the transformation to proceed, undefined otherwise.
+ */
+export declare const findValidStyledComponentCall: (node: Rule.Node) => (VariableDeclarator & Rule.NodeParentExtension) | undefined;