[code-infra] Prepare babel macros package for publishing to npm (#41178)

Author: michaldudak

.codesandbox/ci.json

@@ -3,6 +3,8 @@
   "installCommand": "install:codesandbox",
   "node": "18",
   "packages": [
+    "packages/docs-utils",
+    "packages/mui-babel-macros",
     "packages/mui-base",
     "packages/mui-codemod",
     "packages/mui-core-downloads-tracker",
@@ -19,28 +21,28 @@
     "packages/mui-system",
     "packages/mui-types",
     "packages/mui-utils",
-    "packages/docs-utils",
     "packages-internal/scripts"
   ],
   "publishDirectory": {
     "@mui/base": "packages/mui-base/build",
     "@mui/codemod": "packages/mui-codemod/build",
     "@mui/core-downloads-tracker": "packages/mui-core-downloads-tracker/build",
     "@mui/icons-material": "packages/mui-icons-material/build",
+    "@mui/internal-babel-macros": "packages/mui-babel-macros",
+    "@mui/internal-scripts": "packages-internal/scripts",
     "@mui/joy": "packages/mui-joy/build",
     "@mui/lab": "packages/mui-lab/build",
     "@mui/material-next": "packages/mui-material-next/build",
     "@mui/material-nextjs": "packages/mui-material-nextjs/build",
     "@mui/material": "packages/mui-material/build",
     "@mui/private-theming": "packages/mui-private-theming/build",
-    "@mui/styled-engine-sc": "packages/mui-styled-engine-sc/build",
     "@mui/styled-engine": "packages/mui-styled-engine/build",
+    "@mui/styled-engine-sc": "packages/mui-styled-engine-sc/build",
     "@mui/styles": "packages/mui-styles/build",
     "@mui/system": "packages/mui-system/build",
     "@mui/types": "packages/mui-types/build",
     "@mui/utils": "packages/mui-utils/build",
-    "@mui-internal/docs-utils": "packages/docs-utils",
-    "@mui/internal-scripts": "packages-internal/scripts"
+    "@mui-internal/docs-utils": "packages/docs-utils"
   },
   "sandboxes": [
     "/examples/material-ui-cra-ts",

packages/mui-babel-macros/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0
+
+Initial release as an npm package.

packages/mui-babel-macros/MuiError.macro.js

@@ -12,7 +12,7 @@ function invertObject(object) {
 
 /**
  * Supported imports:
- * 1. bare specifier e.g. `'@mui-internal/babel-macros/MuiError.macro'`
+ * 1. bare specifier e.g. `'@mui/internal-babel-macros/MuiError.macro'`
  * 2. relative import from `packages/mui-utils/src` e.g. `'../macros/MuiError.macro'`
  * @param {import('babel-plugin-macros').MacroParams} param0
  */
@@ -128,9 +128,9 @@ function muiError({ references, babel, config, source }) {
     errorCode = parseInt(errorCode, 10);
 
     if (formatMuiErrorMessageIdentifier === null) {
-      const isBareImportSourceIdentifier = source.startsWith('@mui-internal/babel-macros');
+      const isBareImportSourceIdentifier = source.startsWith('@mui/internal-babel-macros');
       if (isBareImportSourceIdentifier) {
-        // Input: import MuiError from '@mui-internal/babel-macros/MuiError.macro'
+        // Input: import MuiError from '@mui/internal-babel-macros/MuiError.macro'
         // Outputs:
         // import { formatMuiErrorMessage } from '@mui/utils';
         formatMuiErrorMessageIdentifier = helperModuleImports.addDefault(
@@ -139,7 +139,7 @@ function muiError({ references, babel, config, source }) {
           { nameHint: '_formatMuiErrorMessage' },
         );
       } else {
-        throw new Error('Only package imports from @mui-internal/babel-macros are supported');
+        throw new Error('Only package imports from @mui/internal-babel-macros are supported');
       }
     }
 

packages/mui-babel-macros/README.md

@@ -0,0 +1,9 @@
+# @mui/internal-babel-macros
+
+This package contains the error macro used in MUI projects.
+This is an internal package not meant for general use.
+
+## Release
+
+There is no build step.
+To publish the package to npm, run: `pnpm release:publish`

packages/mui-babel-macros/__fixtures__/error-code-extraction/input.js

@@ -1,4 +1,4 @@
-import MuiError from '@mui-internal/babel-macros/MuiError.macro';
+import MuiError from '@mui/internal-babel-macros/MuiError.macro';
 
 throw new MuiError('exists');
 throw new MuiError('will be created');

packages/mui-babel-macros/__fixtures__/factory-call/input.js

@@ -1,4 +1,4 @@
-import MuiError from '@mui-internal/babel-macros/MuiError.macro';
+import MuiError from '@mui/internal-babel-macros/MuiError.macro';
 
 // `throw Error(message)` is valid JS but we limit error construction to a single syntax.
 throw MuiError('my message');

packages/mui-babel-macros/__fixtures__/literal/input.js

@@ -1,3 +1,3 @@
-import MuiError from '@mui-internal/babel-macros/MuiError.macro';
+import MuiError from '@mui/internal-babel-macros/MuiError.macro';
 
 throw new MuiError('MUI: Expected valid input target.\n' + 'Did you use `inputComponent`');

packages/mui-babel-macros/__fixtures__/no-error-code-annotation/input.js

@@ -1,3 +1,3 @@
-import MuiError from '@mui-internal/babel-macros/MuiError.macro';
+import MuiError from '@mui/internal-babel-macros/MuiError.macro';
 
 throw new MuiError('MUI: Expected valid input target.\n' + 'Did you use inputComponent');

packages/mui-babel-macros/__fixtures__/no-error-code-throw/input.js

@@ -1,3 +1,3 @@
-import MuiError from '@mui-internal/babel-macros/MuiError.macro';
+import MuiError from '@mui/internal-babel-macros/MuiError.macro';
 
 throw new MuiError('missing');

packages/mui-babel-macros/package.json

@@ -1,8 +1,9 @@
 {
-  "name": "@mui-internal/babel-macros",
+  "name": "@mui/internal-babel-macros",
   "version": "1.0.0",
-  "private": true,
   "author": "MUI Team",
+  "description": "MUI Babel macros. This is an internal package not meant for general use.",
+  "main": "./MuiError.macro.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/mui/material-ui.git",
@@ -12,12 +13,13 @@
   "bugs": {
     "url": "https://github.com/mui/material-ui/issues"
   },
-  "homepage": "private package",
   "funding": {
     "type": "opencollective",
     "url": "https://opencollective.com/mui-org"
   },
   "scripts": {
+    "release:publish": "pnpm publish --tag latest",
+    "release:publish:dry-run": "pnpm publish --tag latest --registry=\"http://localhost:4873/\"",
     "test": "cd ../../ && cross-env NODE_ENV=test mocha 'packages/mui-babel-macros/**/*.test.{js,ts,tsx}'"
   },
   "dependencies": {
@@ -26,7 +28,7 @@
     "babel-plugin-macros": "^3.1.0"
   },
   "devDependencies": {
-    "@mui-internal/babel-macros": "workspace:*",
+    "@mui/internal-babel-macros": "workspace:*",
     "@types/babel-plugin-macros": "^3.1.3",
     "@types/chai": "^4.3.11",
     "@types/mocha": "^10.0.6",
@@ -35,10 +37,13 @@
     "chai": "^4.4.1"
   },
   "peerDependencies": {
-    "@mui/utils": "workspace:^"
+    "@mui/utils": "^5.0.0"
   },
   "sideEffects": false,
   "engines": {
     "node": ">=12.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }