@mui/codemod 5.15.9 → 5.15.11

package/README.md

@@ -1,12 +1,13 @@
 # @mui/codemod
 
-> Codemod scripts for MUI
+> Codemod scripts for Material UI, Base UI, MUI System, Joy UI.
 
 [![npm version](https://img.shields.io/npm/v/@mui/codemod.svg?style=flat-square)](https://www.npmjs.com/package/@mui/codemod)
 [![npm downloads](https://img.shields.io/npm/dm/@mui/codemod.svg?style=flat-square)](https://www.npmjs.com/package/@mui/codemod)
 
 This repository contains a collection of codemod scripts based for use with
-[jscodeshift](https://github.com/facebook/jscodeshift) that help update MUI APIs.
+[jscodeshift](https://github.com/facebook/jscodeshift) that help update the APIs.
+Some of the codemods also run [postcss](https://github.com/postcss/postcss) plugins to update CSS files.
 
 ## Setup & run
 
@@ -91,6 +92,92 @@ A combination of all deprecations.
 npx @mui/codemod@latest deprecations/accordion-props <path>
 ```
 
+#### `accordion-summary-classes`
+
+JS transforms:
+
+```diff
+ import { accordionSummaryClasses } from '@mui/material/AccordionSummary';
+
+ MuiAccordionSummary: {
+   styleOverrides: {
+     root: {
+-      [`& .${accordionSummaryClasses.contentGutters}`]: {
++      [`&.${accordionSummaryClasses.gutters} .${accordionSummaryClasses.content}`]: {
+         color: 'red',
+        },
+     },
+   },
+ },
+```
+
+```diff
+ MuiAccordionSummary: {
+   styleOverrides: {
+     root: {
+-      '& .MuiAccordionSummary-contentGutters': {
++      '&.MuiAccordionSummary-gutters .MuiAccordionSummary-content': {
+         color: 'red',
+        },
+     },
+   },
+ },
+```
+
+CSS transforms:
+
+```diff
+-.MuiAccordionSummary-root .MuiAccordionSummary-contentGutters
++.MuiAccordionSummary-root.MuiAccordionSummary-gutters .MuiAccordionSummary-content
+ />
+```
+
+```bash
+npx @mui/codemod@latest deprecations/accordion-summary-classes <path>
+```
+
+#### `alert-props`
+
+```diff
+ <Alert
+-  components={{ CloseButton: CustomButton }}
++  slots={{ closeButton: CustomButton }}
+-  componentsProps={{ closeButton: { testid: 'test-id' } }}
++  slotProps={{ closeButton: { testid: 'test-id' } }}
+ />
+```
+
+```diff
+ MuiAlert: {
+   defaultProps: {
+-    components: { CloseButton: CustomButton }
++    slots: { closeButton: CustomButton },
+-    componentsProps: { closeButton: { testid: 'test-id' }}
++    slotProps: { closeButton: { testid: 'test-id' } },
+  },
+ },
+```
+
+```bash
+npx @mui/codemod@latest deprecations/alert-props <path>
+```
+
+#### `avatar-props`
+
+```diff
+ <Avatar
+-  imgProps={{
+-    onError: () => {},
+-    onLoad: () => {},
++  slotProps={{
++    img: {
++      onError: () => {},
++      onLoad: () => {},
++    }
+   }}
+ />;
+```
+
 #### `divider-props`
 
 ```diff
@@ -104,6 +191,71 @@ npx @mui/codemod@latest deprecations/accordion-props <path>
 npx @mui/codemod@latest deprecations/divider-props <path>
 ```
 
+#### `pagination-item-classes`
+
+JS transforms:
+
+```diff
+ import { paginationItemClasses } from '@mui/material/PaginationItem';
+
+ MuiPaginationItem: {
+   styleOverrides: {
+     root: {
+-      [`&.${paginationItemClasses.textPrimary}`]: {
++      [`&.${paginationItemClasses.text}.${paginationItemClasses.colorPrimary}`]: {
+         color: 'red',
+        },
+-      [`&.${paginationItemClasses.textSecondary}`]: {
++      [`&.${paginationItemClasses.text}.${paginationItemClasses.colorSecondary}`]: {
+         color: 'red',
+        },
+-      [`&.${paginationItemClasses.outlinedPrimary}`]: {
++      [`&.${paginationItemClasses.outlined}.${paginationItemClasses.colorPrimary}`]: {
+         color: 'red',
+        },
+-      [`&.${paginationItemClasses.outlinedSecondary}`]: {
++      [`&.${paginationItemClasses.outlined}.${paginationItemClasses.colorSecondary}`]: {
+         color: 'red',
+        },
+-      '&.MuiPaginationItem-textPrimary': {
++      '&.MuiPaginationItem-text.MuiPaginationItem-colorPrimary': {
+         color: 'red',
+        },
+-      '&.MuiPaginationItem-textSecondary': {
++      '&.MuiPaginationItem-text.MuiPaginationItem-colorSecondary': {
+         color: 'red',
+        },
+-      '&.MuiPaginationItem-outlinedPrimary': {
++      '&.MuiPaginationItem-outlined.MuiPaginationItem-colorPrimary': {
+         color: 'red',
+        },
+-      '&.MuiPaginationItem-outlinedSecondary': {
++      '&.MuiPaginationItem-outlined.MuiPaginationItem-colorSecondary': {
+         color: 'red',
+        },
+     },
+   },
+ },
+```
+
+CSS transforms:
+
+```diff
+-.MuiPaginationItem-textPrimary
++.MuiPaginationItem-text.MuiPaginationItem-primary
+-.MuiPaginationItem-textSecondary
++.MuiPaginationItem-text.MuiPaginationItem-secondary
+-.MuiPaginationItem-outlinedPrimary
++.MuiPaginationItem-outlined.MuiPaginationItem-primary
+-.MuiPaginationItem-outlinedSecondary
++.MuiPaginationItem-outlined.MuiPaginationItem-secondary
+ />
+```
+
+```bash
+npx @mui/codemod@latest deprecations/pagination-item-classes <path>
+```
+
 ### v5.0.0
 
 #### `base-use-named-exports`
@@ -1218,7 +1370,7 @@ You can find more details about this breaking change in the migration guide.
 
 #### `theme-augment`
 
-Adds `DefaultTheme` module augmentation to typescript projects.
+Adds `DefaultTheme` module augmentation to TypeScript projects.
 
 ```bash
 npx @mui/codemod@latest v5.0.0/theme-augment <path>

package/codemod.js

@@ -5,11 +5,15 @@ const { promises: fs } = require('fs');
 const path = require('path');
 const yargs = require('yargs');
 const jscodeshiftPackage = require('jscodeshift/package.json');
+const postcssCliPackage = require('postcss-cli/package.json');
 
 const jscodeshiftDirectory = path.dirname(require.resolve('jscodeshift'));
 const jscodeshiftExecutable = path.join(jscodeshiftDirectory, jscodeshiftPackage.bin.jscodeshift);
 
-async function runTransform(transform, files, flags, codemodFlags) {
+const postcssCliDirectory = path.dirname(require.resolve('postcss-cli'));
+const postcssExecutable = path.join(postcssCliDirectory, postcssCliPackage.bin.postcss);
+
+async function runJscodeshiftTransform(transform, files, flags, codemodFlags) {
   const paths = [
     path.resolve(__dirname, './src', `${transform}/index.js`),
     path.resolve(__dirname, './src', `${transform}.js`),
@@ -57,6 +61,8 @@ async function runTransform(transform, files, flags, codemodFlags) {
     flags.parser || 'tsx',
     '--ignore-pattern',
     '**/node_modules/**',
+    '--ignore-pattern',
+    '**/*.css',
   ];
 
   if (flags.dry) {
@@ -80,15 +86,82 @@ async function runTransform(transform, files, flags, codemodFlags) {
   }
 }
 
+const parseCssFilePaths = async (files) => {
+  const cssFiles = await Promise.all(
+    files.map(async (filePath) => {
+      const stat = await fs.stat(filePath);
+      if (stat.isDirectory()) {
+        return `${filePath}/**/*.css`;
+      }
+      if (filePath.endsWith('.css')) {
+        return filePath;
+      }
+
+      return null;
+    }),
+  );
+
+  return cssFiles.filter(Boolean);
+};
+
+async function runPostcssTransform(transform, files) {
+  // local postcss plugins are loaded through config files https://github.com/postcss/postcss-load-config/issues/17#issuecomment-253125559
+  const paths = [
+    path.resolve(__dirname, './src', `${transform}/postcss.config.js`),
+    path.resolve(__dirname, './node', `${transform}/postcss.config.js`),
+  ];
+
+  let configPath;
+  let error;
+  // eslint-disable-next-line no-restricted-syntax
+  for (const item of paths) {
+    try {
+      // eslint-disable-next-line no-await-in-loop
+      await fs.stat(item);
+      error = undefined;
+      configPath = item;
+      break;
+    } catch (srcPathError) {
+      error = srcPathError;
+      continue;
+    }
+  }
+
+  if (error) {
+    // don't throw if the file is not found, postcss transform is optional
+    if (error?.code !== 'ENOENT') {
+      throw error;
+    }
+  } else {
+    const cssPaths = await parseCssFilePaths(files);
+
+    if (cssPaths.length > 0) {
+      const args = [
+        postcssExecutable,
+        ...cssPaths,
+        '--config',
+        configPath,
+        '--replace',
+        '--verbose',
+      ];
+
+      // eslint-disable-next-line no-console -- debug information
+      console.log(`Executing command: postcss ${args.join(' ')}`);
+      const postcssProcess = childProcess.spawnSync('node', args, { stdio: 'inherit' });
+
+      if (postcssProcess.error) {
+        throw postcssProcess.error;
+      }
+    }
+  }
+}
+
 function run(argv) {
   const { codemod, paths, ...flags } = argv;
+  const files = paths.map((filePath) => path.resolve(filePath));
 
-  return runTransform(
-    codemod,
-    paths.map((filePath) => path.resolve(filePath)),
-    flags,
-    argv._,
-  );
+  runJscodeshiftTransform(codemod, files, flags, argv._);
+  runPostcssTransform(codemod, files);
 }
 
 yargs

package/node/deprecations/accordion-summary-classes/accordion-summary-classes.js

@@ -0,0 +1,55 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = transformer;
+var _postcssPlugin = require("./postcss-plugin");
+/**
+ * @param {import('jscodeshift').FileInfo} file
+ * @param {import('jscodeshift').API} api
+ */
+function transformer(file, api, options) {
+  const j = api.jscodeshift;
+  const root = j(file.source);
+  const printOptions = options.printOptions;
+
+  // contentGutters is a special case as it's applied to the content child
+  // but gutters is applied to the parent element, so the gutter class needs to go on the parent
+
+  root.find(j.ImportDeclaration).filter(path => path.node.source.value.match(/^@mui\/material\/AccordionSummary$/)).forEach(path => {
+    path.node.specifiers.forEach(specifier => {
+      if (specifier.type === 'ImportSpecifier' && specifier.imported.name === 'accordionSummaryClasses') {
+        root.find(j.MemberExpression, {
+          object: {
+            name: specifier.local.name
+          },
+          property: {
+            name: 'contentGutters'
+          }
+        }).forEach(memberExpression => {
+          const parent = memberExpression.parentPath.parentPath.value;
+          if (parent.type === j.TemplateLiteral.name) {
+            const memberExpressionIndex = parent.expressions.findIndex(expression => expression === memberExpression.value);
+            const precedingTemplateElement = parent.quasis[memberExpressionIndex];
+            if (precedingTemplateElement.value.raw.endsWith(' .')) {
+              parent.expressions.splice(memberExpressionIndex, 1, j.memberExpression(memberExpression.value.object, j.identifier('gutters')), j.memberExpression(memberExpression.value.object, j.identifier('content')));
+              parent.quasis.splice(memberExpressionIndex, 1, j.templateElement({
+                raw: precedingTemplateElement.value.raw.replace(' ', ''),
+                cooked: precedingTemplateElement.value.cooked.replace(' ', '')
+              }, false), j.templateElement({
+                raw: ' .',
+                cooked: ' .'
+              }, false));
+            }
+          }
+        });
+      }
+    });
+  });
+  const selectorRegex = new RegExp(`^& ${_postcssPlugin.deprecatedClass}`);
+  root.find(j.Literal, literal => typeof literal.value === 'string' && literal.value.match(selectorRegex)).forEach(path => {
+    path.replace(j.literal(path.value.value.replace(selectorRegex, `&${_postcssPlugin.replacementSelector}`)));
+  });
+  return root.toSource(printOptions);
+}

package/node/deprecations/accordion-summary-classes/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function () {
+    return _accordionSummaryClasses.default;
+  }
+});
+var _accordionSummaryClasses = _interopRequireDefault(require("./accordion-summary-classes"));

package/node/deprecations/accordion-summary-classes/postcss-plugin.js

@@ -0,0 +1,28 @@
+"use strict";
+
+const deprecatedClass = '.MuiAccordionSummary-contentGutters';
+const replacementSelector = '.MuiAccordionSummary-gutters .MuiAccordionSummary-content';
+const plugin = () => {
+  return {
+    postcssPlugin: `Replace ${deprecatedClass} with ${replacementSelector}`,
+    Rule(rule) {
+      const {
+        selector
+      } = rule;
+
+      // contentGutters is a special case as it's applied to the content child
+      // but gutters is applied to the parent element, so the gutter class needs to go on the parent
+
+      const selectorRegex = new RegExp(` ${deprecatedClass}`);
+      if (selector.match(selectorRegex)) {
+        rule.selector = selector.replace(selectorRegex, replacementSelector);
+      }
+    }
+  };
+};
+plugin.postcss = true;
+module.exports = {
+  plugin,
+  deprecatedClass,
+  replacementSelector
+};

package/node/deprecations/accordion-summary-classes/postcss.config.js

@@ -0,0 +1,8 @@
+"use strict";
+
+const {
+  plugin
+} = require('./postcss-plugin');
+module.exports = {
+  plugins: [plugin]
+};

package/node/deprecations/accordion-summary-classes/test-cases/actual.js

@@ -0,0 +1,54 @@
+"use strict";
+
+var _AccordionSummary = require("@mui/material/AccordionSummary");
+var _jsxRuntime = require("react/jsx-runtime");
+fn({
+  MuiAccordionSummary: {
+    styleOverrides: {
+      root: {
+        '& .MuiAccordionSummary-contentGutters': {
+          color: 'red'
+        }
+      }
+    }
+  }
+});
+fn({
+  MuiAccordionSummary: {
+    styleOverrides: {
+      root: {
+        [`& .${_AccordionSummary.accordionSummaryClasses.contentGutters}`]: {
+          color: 'red'
+        }
+      }
+    }
+  }
+});
+styled(Component)(() => {
+  return {
+    '& .MuiAccordionSummary-contentGutters': {
+      color: 'red'
+    }
+  };
+});
+styled(Component)(() => {
+  return {
+    [`& .${_AccordionSummary.accordionSummaryClasses.contentGutters}`]: {
+      color: 'red'
+    }
+  };
+});
+/*#__PURE__*/(0, _jsxRuntime.jsx)(AccordionSummary, {
+  sx: {
+    '& .MuiAccordionSummary-contentGutters': {
+      color: 'red'
+    }
+  }
+});
+/*#__PURE__*/(0, _jsxRuntime.jsx)(AccordionSummary, {
+  sx: {
+    [`& .${_AccordionSummary.accordionSummaryClasses.contentGutters}`]: {
+      color: 'red'
+    }
+  }
+});

package/node/deprecations/accordion-summary-classes/test-cases/expected.js

@@ -0,0 +1,54 @@
+"use strict";
+
+var _AccordionSummary = require("@mui/material/AccordionSummary");
+var _jsxRuntime = require("react/jsx-runtime");
+fn({
+  MuiAccordionSummary: {
+    styleOverrides: {
+      root: {
+        '&.MuiAccordionSummary-gutters .MuiAccordionSummary-content': {
+          color: 'red'
+        }
+      }
+    }
+  }
+});
+fn({
+  MuiAccordionSummary: {
+    styleOverrides: {
+      root: {
+        [`&.${_AccordionSummary.accordionSummaryClasses.gutters} .${_AccordionSummary.accordionSummaryClasses.content}`]: {
+          color: 'red'
+        }
+      }
+    }
+  }
+});
+styled(Component)(() => {
+  return {
+    '&.MuiAccordionSummary-gutters .MuiAccordionSummary-content': {
+      color: 'red'
+    }
+  };
+});
+styled(Component)(() => {
+  return {
+    [`&.${_AccordionSummary.accordionSummaryClasses.gutters} .${_AccordionSummary.accordionSummaryClasses.content}`]: {
+      color: 'red'
+    }
+  };
+});
+/*#__PURE__*/(0, _jsxRuntime.jsx)(AccordionSummary, {
+  sx: {
+    '&.MuiAccordionSummary-gutters .MuiAccordionSummary-content': {
+      color: 'red'
+    }
+  }
+});
+/*#__PURE__*/(0, _jsxRuntime.jsx)(AccordionSummary, {
+  sx: {
+    [`&.${_AccordionSummary.accordionSummaryClasses.gutters} .${_AccordionSummary.accordionSummaryClasses.content}`]: {
+      color: 'red'
+    }
+  }
+});

package/node/deprecations/alert-props/alert-props.js

@@ -0,0 +1,22 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = transformer;
+var _replaceComponentsWithSlots = _interopRequireDefault(require("../utils/replaceComponentsWithSlots"));
+/**
+ * @param {import('jscodeshift').FileInfo} file
+ * @param {import('jscodeshift').API} api
+ */
+function transformer(file, api, options) {
+  const j = api.jscodeshift;
+  const root = j(file.source);
+  const printOptions = options.printOptions;
+  (0, _replaceComponentsWithSlots.default)(j, {
+    root,
+    componentName: 'Alert'
+  });
+  return root.toSource(printOptions);
+}

package/node/deprecations/alert-props/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function () {
+    return _alertProps.default;
+  }
+});
+var _alertProps = _interopRequireDefault(require("./alert-props"));

package/node/deprecations/alert-props/test-cases/actual.js

@@ -0,0 +1,43 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _Alert = _interopRequireDefault(require("@mui/material/Alert"));
+var _jsxRuntime = require("react/jsx-runtime");
+/*#__PURE__*/(0, _jsxRuntime.jsx)(_Alert.default, {
+  components: {
+    CloseButton: ComponentsButton
+  },
+  componentsProps: {
+    closeButton: componentsButtonProps
+  }
+});
+/*#__PURE__*/(0, _jsxRuntime.jsx)(_Alert.default, {
+  slots: {
+    closeIcon: SlotsIcon
+  },
+  components: {
+    CloseButton: ComponentsButton
+  },
+  slotProps: {
+    closeIcon: slotsIconProps
+  },
+  componentsProps: {
+    closeButton: componentsButtonProps
+  }
+});
+/*#__PURE__*/(0, _jsxRuntime.jsx)(_Alert.default, {
+  slots: {
+    closeIcon: SlotsIcon,
+    closeButton: SlotsButton
+  },
+  components: {
+    CloseButton: ComponentsButton
+  },
+  slotProps: {
+    closeIcon: slotsIconProps,
+    closeButton: slotsButtonProps
+  },
+  componentsProps: {
+    closeButton: componentsButtonProps
+  }
+});

package/node/deprecations/alert-props/test-cases/expected.js

@@ -0,0 +1,33 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _Alert = _interopRequireDefault(require("@mui/material/Alert"));
+var _jsxRuntime = require("react/jsx-runtime");
+/*#__PURE__*/(0, _jsxRuntime.jsx)(_Alert.default, {
+  slots: {
+    closeButton: ComponentsButton
+  },
+  slotProps: {
+    closeButton: componentsButtonProps
+  }
+});
+/*#__PURE__*/(0, _jsxRuntime.jsx)(_Alert.default, {
+  slots: {
+    closeIcon: SlotsIcon,
+    closeButton: ComponentsButton
+  },
+  slotProps: {
+    closeIcon: slotsIconProps,
+    closeButton: componentsButtonProps
+  }
+});
+/*#__PURE__*/(0, _jsxRuntime.jsx)(_Alert.default, {
+  slots: {
+    closeIcon: SlotsIcon,
+    closeButton: SlotsButton
+  },
+  slotProps: {
+    closeIcon: slotsIconProps,
+    closeButton: slotsButtonProps
+  }
+});

package/node/deprecations/alert-props/test-cases/theme.actual.js

@@ -0,0 +1,52 @@
+"use strict";
+
+fn({
+  MuiAlert: {
+    defaultProps: {
+      components: {
+        CloseButton: ComponentsButton
+      },
+      componentsProps: {
+        closeButton: componentsButtonProps
+      }
+    }
+  }
+});
+fn({
+  MuiAlert: {
+    defaultProps: {
+      components: {
+        CloseButton: ComponentsButton
+      },
+      slots: {
+        closeIcon: SlotsIcon
+      },
+      componentsProps: {
+        closeButton: componentsButtonProps
+      },
+      slotProps: {
+        closeIcon: slotsIconProps
+      }
+    }
+  }
+});
+fn({
+  MuiAlert: {
+    defaultProps: {
+      components: {
+        CloseButton: ComponentsButton
+      },
+      slots: {
+        closeIcon: SlotsIcon,
+        closeButton: SlotsButton
+      },
+      componentsProps: {
+        closeButton: componentsButtonProps
+      },
+      slotProps: {
+        closeIcon: slotsIconProps,
+        closeButton: slotsButtonProps
+      }
+    }
+  }
+});