@mui/codemod 5.14.1 → 5.14.5

package/README.md

@@ -62,6 +62,25 @@ npx @mui/codemod <transform> <path> --jscodeshift="--printOptions='{\"quote\":\"
 
 ### v5.0.0
 
+### `base-use-named-exports`
+
+Base UI default exports were changed to named ones. Previously we had a mix of default and named ones.
+This was changed to improve consistency and avoid problems some bundlers have with default exports.
+See https://github.com/mui/material-ui/issues/21862 for more context.
+
+This codemod updates the import and re-export statements.
+
+```diff
+-  import BaseButton from '@mui/base/Button';
++  import { Button as BaseButton } from '@mui/base/Button';
+-  export { default as BaseSlider } from '@mui/base/Slider';
++  export { Slider as BaseSlider } from '@mui/base/Slider';
+```
+
+```bash
+npx @mui/codemod v5.0.0/base-use-named-exports <path>
+```
+
 ### `base-remove-unstyled-suffix`
 
 The `Unstyled` suffix has been removed from all Base UI component names, including names of types and other related identifiers.
@@ -247,12 +266,20 @@ The associated breaking change was done in [#34997](https://github.com/mui/mater
 
 #### `date-pickers-moved-to-x`
 
-Rename the imports of date and time pickers from `@mui/lab` to `@mui/x-date-pickers` and `@mui/x-date-pickers-pro`.
+Rename the imports of Date and Time Pickers from `@mui/lab` to `@mui/x-date-pickers` and `@mui/x-date-pickers-pro`.
 
 ```bash
 npx @mui/codemod v5.0.0/date-pickers-moved-to-x <path>
 ```
 
+#### `tree-view-moved-to-x`
+
+Rename the imports of Tree View from `@mui/lab` to `@mui/x-tree-view`.
+
+```bash
+npx @mui/codemod v5.0.0/tree-view-moved-to-x <path>
+```
+
 #### 🚀 `preset-safe`
 
 A combination of all important transformers for migrating v4 to v5. ⚠️ This codemod should be run only once.

package/node/v5.0.0/base-use-named-exports.js

@@ -0,0 +1,99 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = transformer;
+// certain exports don't match the directory they are in:
+const nameMapping = {
+  className: 'Unstable_ClassNameGenerator',
+  composeClasses: 'unstable_composeClasses',
+  generateUtilityClass: 'unstable_generateUtilityClass',
+  generateUtilityClasses: 'unstable_generateUtilityClasses',
+  NumberInput: 'Unstable_NumberInput'
+};
+
+// renamed directories to match the export:
+const pathMapping = {
+  '@mui/base/className': '@mui/base/ClassNameGenerator'
+};
+function getExportedIdentifier(importPath) {
+  var _nameMapping$importPa;
+  return (_nameMapping$importPa = nameMapping[importPath]) != null ? _nameMapping$importPa : importPath;
+}
+function getTransformedPath(originalPath) {
+  var _pathMapping$original;
+  return (_pathMapping$original = pathMapping[originalPath]) != null ? _pathMapping$original : originalPath;
+}
+
+/**
+ * Finds the last segment of the path starting with @mui/base.
+ *
+ * @example '@mui/base/Menu' ➔ 'Menu'
+ * @example '@mui/base' ➔ null
+ */
+function getBaseImportIdentifier(path, filePath) {
+  var _path$node, _baseImportPathMatch$, _baseImportPathMatch$2;
+  const source = path == null || (_path$node = path.node) == null || (_path$node = _path$node.source) == null ? void 0 : _path$node.value;
+  if (!source) {
+    return null;
+  }
+  const baseImportPathMatch = source.match(/@mui\/base\/(.+)/);
+  if (baseImportPathMatch == null) {
+    return null;
+  }
+  if ((_baseImportPathMatch$ = baseImportPathMatch[1]) != null && _baseImportPathMatch$.includes('/')) {
+    console.warn(`WARNING: ${filePath}: "${source}" is more than one level deep. This is not supported.`);
+    return null;
+  }
+  return (_baseImportPathMatch$2 = baseImportPathMatch[1]) != null ? _baseImportPathMatch$2 : null;
+}
+
+/**
+ * @param {import('jscodeshift').FileInfo} file
+ * @param {import('jscodeshift').API} api
+ */
+function transformer(file, api, options) {
+  const j = api.jscodeshift;
+  const printOptions = options.printOptions;
+  const withTransformedImports = j(file.source).find(j.ImportDeclaration).forEach(path => {
+    const baseImportPath = getBaseImportIdentifier(path, file.path);
+    if (baseImportPath === null) {
+      return;
+    }
+    path.node.specifiers = path.node.specifiers.map(specifier => {
+      if (specifier.type !== 'ImportDefaultSpecifier') {
+        return specifier;
+      }
+
+      // import Y from @mui/base/X ➔ import { X as Y } from @mui/base/X
+      return j.importSpecifier(j.identifier(getExportedIdentifier(baseImportPath)), specifier.local);
+    });
+    path.node.source = j.stringLiteral(getTransformedPath(path.node.source.value));
+  }).toSource(printOptions);
+  return j(withTransformedImports).find(j.ExportNamedDeclaration).forEach(path => {
+    const baseImportPath = getBaseImportIdentifier(path);
+    if (baseImportPath === null) {
+      return;
+    }
+    path.node.specifiers = path.node.specifiers.map(specifier => {
+      if (specifier.local.name !== 'default') {
+        return specifier;
+      }
+      if (specifier.exported.name === 'default') {
+        // export { default } from @mui/base/X ➔ export { X as default } from @mui/base/X
+        return j.exportSpecifier.from({
+          exported: j.identifier('default'),
+          local: j.identifier(baseImportPath)
+        });
+      }
+
+      // export { default as Y } from @mui/base/X ➔ export { X as Y } from @mui/base/X
+      return j.exportSpecifier.from({
+        exported: j.identifier(specifier.exported.name),
+        local: j.identifier(getExportedIdentifier(baseImportPath))
+      });
+    });
+    path.node.source = j.stringLiteral(getTransformedPath(path.node.source.value));
+  }).toSource(printOptions);
+}

package/node/v5.0.0/base-use-named-exports.test/actual-with-warning.js

@@ -0,0 +1,23 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function () {
+    return _Slider.default;
+  }
+});
+Object.defineProperty(exports, "sliderClasses", {
+  enumerable: true,
+  get: function () {
+    return _Slider.sliderClasses;
+  }
+});
+var _Button = _interopRequireDefault(require("@mui/base/Button"));
+var _ClassNameConfigurator = _interopRequireDefault(require("@mui/base/utils/ClassNameConfigurator"));
+var _Slider = _interopRequireWildcard(require("@mui/base/Slider"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }

package/node/v5.0.0/base-use-named-exports.test/actual.js

@@ -0,0 +1,61 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "BaseOption", {
+  enumerable: true,
+  get: function () {
+    return _Option.default;
+  }
+});
+Object.defineProperty(exports, "BaseTabPanel", {
+  enumerable: true,
+  get: function () {
+    return _TabPanel.default;
+  }
+});
+Object.defineProperty(exports, "NumberInput", {
+  enumerable: true,
+  get: function () {
+    return _NumberInput.default;
+  }
+});
+Object.defineProperty(exports, "Unstable_ClassNameGenerator", {
+  enumerable: true,
+  get: function () {
+    return _className.Unstable_ClassNameGenerator;
+  }
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function () {
+    return _Slider.default;
+  }
+});
+Object.defineProperty(exports, "sliderClasses", {
+  enumerable: true,
+  get: function () {
+    return _Slider.sliderClasses;
+  }
+});
+Object.defineProperty(exports, "tabPanelClasses", {
+  enumerable: true,
+  get: function () {
+    return _TabPanel.tabPanelClasses;
+  }
+});
+var _Button = _interopRequireDefault(require("@mui/base/Button"));
+var _Badge = _interopRequireWildcard(require("@mui/base/Badge"));
+var _Switch = _interopRequireDefault(require("@mui/base/Switch"));
+var _Select = _interopRequireWildcard(require("@mui/base/Select"));
+var _base = require("@mui/base");
+var _composeClasses = _interopRequireDefault(require("@mui/base/composeClasses"));
+var _NumberInput = _interopRequireDefault(require("@mui/base/NumberInput"));
+var _className = require("@mui/base/className");
+var _Slider = _interopRequireWildcard(require("@mui/base/Slider"));
+var _Option = _interopRequireDefault(require("@mui/base/Option"));
+var _TabPanel = _interopRequireWildcard(require("@mui/base/TabPanel"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }

package/node/v5.0.0/base-use-named-exports.test/expected-with-warning.js

@@ -0,0 +1,21 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function () {
+    return _Slider.Slider;
+  }
+});
+Object.defineProperty(exports, "sliderClasses", {
+  enumerable: true,
+  get: function () {
+    return _Slider.sliderClasses;
+  }
+});
+var _Button = require("@mui/base/Button");
+var _ClassNameConfigurator = _interopRequireDefault(require("@mui/base/utils/ClassNameConfigurator"));
+var _Slider = require("@mui/base/Slider");

package/node/v5.0.0/base-use-named-exports.test/expected.js

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "BaseOption", {
+  enumerable: true,
+  get: function () {
+    return _Option.Option;
+  }
+});
+Object.defineProperty(exports, "BaseTabPanel", {
+  enumerable: true,
+  get: function () {
+    return _TabPanel.TabPanel;
+  }
+});
+Object.defineProperty(exports, "NumberInput", {
+  enumerable: true,
+  get: function () {
+    return _NumberInput.Unstable_NumberInput;
+  }
+});
+Object.defineProperty(exports, "Unstable_ClassNameGenerator", {
+  enumerable: true,
+  get: function () {
+    return _ClassNameGenerator.Unstable_ClassNameGenerator;
+  }
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function () {
+    return _Slider.Slider;
+  }
+});
+Object.defineProperty(exports, "sliderClasses", {
+  enumerable: true,
+  get: function () {
+    return _Slider.sliderClasses;
+  }
+});
+Object.defineProperty(exports, "tabPanelClasses", {
+  enumerable: true,
+  get: function () {
+    return _TabPanel.tabPanelClasses;
+  }
+});
+var _Button = require("@mui/base/Button");
+var _Badge = require("@mui/base/Badge");
+var _Switch = require("@mui/base/Switch");
+var _Select = require("@mui/base/Select");
+var _base = require("@mui/base");
+var _composeClasses = require("@mui/base/composeClasses");
+var _NumberInput = require("@mui/base/NumberInput");
+var _ClassNameGenerator = require("@mui/base/ClassNameGenerator");
+var _Slider = require("@mui/base/Slider");
+var _Option = require("@mui/base/Option");
+var _TabPanel = require("@mui/base/TabPanel");

package/node/v5.0.0/tree-view-moved-to-x.js

@@ -0,0 +1,86 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = transformer;
+const _exports = {
+  TreeView: {
+    default: 'TreeView',
+    named: ['treeViewClasses', 'TreeViewClasses', 'TreeViewClassKey', 'getTreeViewUtilityClass', 'TreeViewPropsBase', 'TreeViewProps', 'SingleSelectTreeViewProps', 'MultiSelectTreeViewProps']
+  },
+  TreeItem: {
+    default: 'TreeItem',
+    named: ['useTreeItem', 'treeItemClasses', 'TreeItemClasses', 'TreeItemClassKey', 'getTreeItemUtilityClass', 'TreeItemProps', 'TreeItemContentProps']
+  }
+};
+const buildLookup = () => {
+  return Object.fromEntries(Object.entries(_exports).flatMap(([entryPoint, entryPointData]) => [entryPointData.default, ...entryPointData.named].map(exportName => [exportName, {
+    entryPoint
+  }])));
+};
+
+/**
+ * @param {import('jscodeshift').FileInfo} file
+ * @param {import('jscodeshift').API} api
+ */
+function transformer(fileInfo, api, options) {
+  const j = api.jscodeshift;
+  const printOptions = options.printOptions || {
+    quote: 'single'
+  };
+  const lookup = buildLookup();
+  const root = j(fileInfo.source);
+  root.find(j.ImportDeclaration).forEach(path => {
+    const importSource = path.node.source.value;
+    const subPackageImportMatch = importSource.match(/@mui\/lab\/(.*)/);
+    if (subPackageImportMatch !== null) {
+      const subModule = subPackageImportMatch[1];
+      if (subModule.startsWith('internal')) {
+        console.warn('Imports from `@mui/lab/internal` are not supported');
+        return;
+      }
+      if (_exports[subModule]) {
+        /**
+         * @type {import('jscodeshift').ASTPath}
+         */
+        const sourcePath = path.get('source');
+        const targetPackage = '@mui/x-tree-view';
+        const targetImportPath = `${targetPackage}/${subModule}`;
+        sourcePath.replace(j.stringLiteral(targetImportPath));
+        const importDeclaration = path.value;
+        importDeclaration.specifiers = importDeclaration.specifiers.map(specifier => {
+          if (specifier.type === 'ImportDefaultSpecifier') {
+            const localName = specifier.local.name;
+            return j.importSpecifier(j.identifier(subModule), j.identifier(localName));
+          }
+          return specifier;
+        });
+      }
+    } else if (importSource === '@mui/lab') {
+      // Sieve import specifiers into /core and /lab
+      const xImportSpecifiers = [];
+      const labImportSpecifiers = [];
+      path.node.specifiers.forEach(specifier => {
+        if (specifier.type === 'ImportSpecifier') {
+          const lookupValue = lookup[specifier.imported.name];
+          if (lookupValue) {
+            xImportSpecifiers.push(specifier);
+          } else {
+            labImportSpecifiers.push(specifier);
+          }
+        } else {
+          // `import Lab from '@material-ui/lab'`
+          // `import * as Lab from '@material-ui/lab'`
+          // These imports would require scope analysis.
+          console.warn(`Can't handle ${specifier.type}`);
+        }
+      });
+      if (xImportSpecifiers.length > 0) {
+        const targetPackage = '@mui/x-tree-view';
+        path.replace(j.importDeclaration(xImportSpecifiers, j.stringLiteral(targetPackage)), j.importDeclaration(labImportSpecifiers, j.stringLiteral('@mui/lab')));
+      }
+    }
+  }).toSource(printOptions);
+  return root.toSource(printOptions);
+}

package/node/v5.0.0/tree-view-moved-to-x.test/actual-root.js

@@ -0,0 +1,3 @@
+"use strict";
+
+var _lab = require("@mui/lab");

package/node/v5.0.0/tree-view-moved-to-x.test/actual-sub-module.js

@@ -0,0 +1,8 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _TreeView = _interopRequireWildcard(require("@mui/lab/TreeView"));
+var _TreeItem = _interopRequireWildcard(require("@mui/lab/TreeItem"));
+var _Timeline = _interopRequireDefault(require("@mui/lab/Timeline"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }

package/node/v5.0.0/tree-view-moved-to-x.test/expected-root.js

@@ -0,0 +1,4 @@
+"use strict";
+
+var _xTreeView = require("@mui/x-tree-view");
+var _lab = require("@mui/lab");

package/node/v5.0.0/tree-view-moved-to-x.test/expected-sub-module.js

@@ -0,0 +1,6 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _TreeView = require("@mui/x-tree-view/TreeView");
+var _TreeItem = require("@mui/x-tree-view/TreeItem");
+var _Timeline = _interopRequireDefault(require("@mui/lab/Timeline"));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/codemod",
-  "version": "5.14.1",
+  "version": "5.14.5",
   "bin": "./codemod.js",
   "private": false,
   "author": "MUI Team",