Handle theme method spreads in the sx prop

Author: brijeshb42

packages/pigment-react/src/utils/sxObjectExtractor.ts

@@ -23,7 +23,9 @@ function validateObjectKey(
     return;
   }
   if (!parentCall) {
-    throw keyPath.buildCodeFrameError('Expressions in css object keys are not supported.');
+    throw keyPath.buildCodeFrameError(
+      `${process.env.PACKAGE_NAME}: Expressions in css object keys are not supported.`,
+    );
   }
   if (
     !identifiers.every((item) => {
@@ -41,7 +43,7 @@ function validateObjectKey(
     })
   ) {
     throw keyPath.buildCodeFrameError(
-      'Variables in css object keys should only use the passed theme(s) object or variables that are defined in the root scope.',
+      `${process.env.PACKAGE_NAME}: Variables in css object keys should only use the passed theme(s) object or variables that are defined in the root scope.`,
     );
   }
 }
@@ -59,14 +61,14 @@ function traverseObjectExpression(
       const value = property.get('value');
       if (!value.isExpression()) {
         throw value.buildCodeFrameError(
-          'This value is not supported. It can only be static values or local variables.',
+          `${process.env.PACKAGE_NAME}: This value is not supported. It can only be static values or local variables.`,
         );
       }
       if (value.isObjectExpression()) {
         traverseObjectExpression(value, parentCall);
       } else if (value.isArrowFunctionExpression()) {
         throw value.buildCodeFrameError(
-          'Arrow functions are not supported as values of sx object.',
+          `${process.env.PACKAGE_NAME}: Arrow functions are not supported as values of sx object.`,
         );
       } else if (!value.isLiteral() && !isStaticObjectOrArrayExpression(value)) {
         const identifiers = findIdentifiers([value], 'reference');
@@ -86,7 +88,7 @@ function traverseObjectExpression(
             localIdentifiers.push(id);
           } else {
             throw id.buildCodeFrameError(
-              'Consider moving this variable to the root scope if it has all static values.',
+              `${process.env.PACKAGE_NAME}: Consider moving this variable to the root scope if it has all static values.`,
             );
           }
         });
@@ -103,20 +105,23 @@ function traverseObjectExpression(
       if (
         !identifiers.every((id) => {
           const binding = property.scope.getBinding(id.node.name);
-          if (!binding || binding.scope !== rootScope) {
-            return false;
-          }
-          return true;
+          // the indentifier definition should either be in the root scope or in the same scope
+          // as the object property, ie, ({theme}) => ({...theme.applyStyles()})
+          return binding && (binding.scope === rootScope || binding.scope === property.scope);
         })
       ) {
         throw property.buildCodeFrameError(
-          'You can only use variables that are defined in the root scope of the file.',
+          `${process.env.PACKAGE_NAME}: You can only use variables in the spread that are defined in the root scope of the file.`,
         );
       }
     } else if (property.isObjectMethod()) {
-      throw property.buildCodeFrameError('sx prop object does not support ObjectMethods.');
+      throw property.buildCodeFrameError(
+        `${process.env.PACKAGE_NAME}: sx prop object does not support ObjectMethods.`,
+      );
     } else {
-      throw property.buildCodeFrameError('Unknown property in object.');
+      throw property.buildCodeFrameError(
+        `${process.env.PACKAGE_NAME}: Unknown property in object.`,
+      );
     }
   });
 }
@@ -128,7 +133,7 @@ export function sxObjectExtractor(nodePath: NodePath<ObjectExpression | ArrowFun
     const body = nodePath.get('body');
     if (!body.isObjectExpression()) {
       throw body.buildCodeFrameError(
-        "sx prop only supports arrow functions that directly return an object, e.g. () => ({color: 'red'}). You can accept theme object in the params if required.",
+        `${process.env.PACKAGE_NAME}: sx prop only supports arrow functions directly returning an object, e.g. () => ({color: 'red'}). You can accept theme object in the params if required.`,
       );
     }
     traverseObjectExpression(body, nodePath);

packages/pigment-react/tests/fixtures/styled.input.js

@@ -10,13 +10,13 @@ const rotateKeyframe = keyframes({
 });
 
 const Component = styled.div(({ theme }) => ({
-  color: theme.palette.primary.main,
+  color: (theme.vars ?? theme).palette.primary.main,
   animation: `${rotateKeyframe} 2s ease-out 0s infinite`,
 }));
 
 const cls1 = css`
-  color: ${({ theme }) => theme.palette.primary.main};
-  font-size: ${({ theme }) => theme.size.font.h1};
+  color: ${({ theme }) => (theme.vars ?? theme).palette.primary.main};
+  font-size: ${({ theme }) => (theme.vars ?? theme).size.font.h1};
 `;
 
 export const SliderRail = styled('span', {
@@ -28,11 +28,11 @@ export const SliderRail = styled('span', {
   border-radius: inherit;
   background-color: currentColor;
   opacity: 0.38;
-  font-size: ${({ theme }) => theme.size.font.h1};
+  font-size: ${({ theme }) => (theme.vars ?? theme).size.font.h1};
 `;
 
 const SliderRail2 = styled.span`
   display: block;
   opacity: 0.38;
-  font-size: ${({ theme }) => theme.size.font.h1};
+  font-size: ${({ theme }) => (theme.vars ?? theme).size.font.h1};
 `;

packages/pigment-react/tests/fixtures/styled.output.css

@@ -1,6 +1,6 @@
 @keyframes r1ub6j9g{from{transform:rotate(360deg);}to{transform:rotate(0deg);}}
-.c1y26wbb{color:red;animation:r1ub6j9g 2s ease-out 0s infinite;}
-.ct00dwm{color:red;font-size:3rem;}
-.soujkwr{display:block;position:absolute;border-radius:inherit;background-color:currentColor;opacity:0.38;font-size:3rem;}
+.c1y26wbb{color:var(--mui-palette-primary-main);animation:r1ub6j9g 2s ease-out 0s infinite;}
+.ct00dwm{color:var(--mui-palette-primary-main);font-size:var(--mui-size-font-h1);}
+.soujkwr{display:block;position:absolute;border-radius:inherit;background-color:currentColor;opacity:0.38;font-size:var(--mui-size-font-h1);}
 .soujkwr-1{font-size:3rem;}
-.s14dtw5g{display:block;opacity:0.38;font-size:3rem;}
+.s14dtw5g{display:block;opacity:0.38;font-size:var(--mui-size-font-h1);}

packages/pigment-react/tests/fixtures/sxProps2.input.js

@@ -0,0 +1,14 @@
+import { SliderRail } from './styled.input';
+
+function App2(props) {
+  return (
+    <SliderRail
+      sx={({ theme }) => ({
+        mb: 1,
+        ...theme.applyStyles('dark', {
+          color: 'white',
+        }),
+      })}
+    />
+  );
+}

packages/pigment-react/tests/fixtures/sxProps2.output.css

@@ -0,0 +1 @@
+.soujkwr.sqyvpfz{margin-bottom:8px;}@media (prefers-color-scheme: dark){.soujkwr.sqyvpfz{color:white;}}

packages/pigment-react/tests/fixtures/sxProps2.output.js

@@ -0,0 +1,4 @@
+import { SliderRail } from './styled.input';
+function App2(props) {
+  return <SliderRail sx={"sqyvpfz"} />;
+}

packages/pigment-react/tests/pigment.test.ts

@@ -4,34 +4,40 @@ import { expect } from 'chai';
 import { asyncResolveFallback } from '@wyw-in-js/shared';
 import { transformAsync } from '@babel/core';
 import { TransformCacheCollection, transform, createFileReporter } from '@wyw-in-js/transform';
-import { preprocessor } from '@pigment-css/react/utils';
+import { preprocessor, extendTheme } from '@pigment-css/react/utils';
 import sxTransformPlugin from '../exports/sx-plugin';
 
 const files = fs
   .readdirSync(path.join(__dirname, 'fixtures'))
   .filter((file) => file.endsWith('.input.js'));
 
-const theme = {
-  palette: {
-    primary: {
-      main: 'red',
-    },
-  },
-  size: {
-    font: {
-      h1: '3rem',
+const theme = extendTheme({
+  colorSchemes: {
+    light: {
+      palette: {
+        primary: {
+          main: 'red',
+        },
+      },
+      size: {
+        font: {
+          h1: '3rem',
+        },
+      },
     },
   },
   components: {
     MuiSlider: {
+      defaultProps: {},
       styleOverrides: {
         rail: {
           fontSize: '3rem',
         },
       },
     },
   },
-};
+  cssVarPrefix: 'mui',
+});
 
 async function transformWithSx(code: string, filename: string) {
   const babelResult = await transformAsync(code, {