-
-
Notifications
You must be signed in to change notification settings - Fork 32.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[code-infra] Babel plugin to fully resolve imported paths #43294
Changes from 1 commit
e26e204
a2e9fe3
0cf1f75
e3a9915
d8a432e
08785b3
399ffcc
a1cf4e8
8ceb06b
25bdc7d
d3574fd
e26fa02
70b8261
16bc6cd
3f5915c
73bb2ce
ff2c258
baa5247
6406fdb
fed743d
ef2d0fc
baa646d
7e2636d
0f21e37
7280c93
eb63fd3
d2c6ef5
28db8b7
86fae26
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# @mui/internal-babel-plugin-resolve-imports | ||
|
||
A babel plugin that resolves import specifiers that are created under the Node.js resolution algorithm to specifiers that adhere to ESM resolution algorithm. | ||
|
||
See https://nodejs.org/docs/v20.16.0/api/esm.html#mandatory-file-extensions | ||
|
||
> A file extension must be provided when using the import keyword to resolve relative or absolute specifiers. Directory indexes (e.g. './startup/index.js') must also be fully specified. | ||
> | ||
> This behavior matches how import behaves in browser environments, assuming a typically configured server. | ||
|
||
This changes imports in the build output from | ||
|
||
```tsx | ||
// packages/mui-material/build/index.js | ||
export * from './Accordion'; | ||
|
||
// packages/mui-material/build/Breadcrumbs/BreadcrumbCollapsed.js | ||
import MoreHorizIcon from '../internal/svg-icons/MoreHoriz'; | ||
``` | ||
|
||
to | ||
|
||
```tsx | ||
// packages/mui-material/build/index.js | ||
export * from './Accordion/index.js'; | ||
|
||
// packages/mui-material/build/Breadcrumbs/BreadcrumbCollapsed.js | ||
import MoreHorizIcon from '../internal/svg-icons/MoreHoriz.js'; | ||
``` | ||
|
||
## options | ||
|
||
- `outExtension`: The extension to use when writing the output. Careful: if not specified, this plugin does not replace extensions at all, your bundles will likely be broken. We left this optional to allow for using this plugin together with the aliasing to source that we do everywhere. That way we can keep it in the pipeline even when not strictly necessary. | ||
Check warning on line 33 in packages-internal/babel-plugin-resolve-imports/README.md
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
{ | ||
"name": "@mui/internal-babel-plugin-resolve-imports", | ||
"version": "1.0.16", | ||
"author": "MUI Team", | ||
"description": "babel plugin that resolves import specifiers to their actual output file.", | ||
"main": "./index.js", | ||
"exports": { | ||
".": "./index.js" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/mui/material-ui.git", | ||
"directory": "packages-internal/babel-plugin-resolve-imports" | ||
}, | ||
"license": "MIT", | ||
"scripts": {}, | ||
"dependencies": { | ||
"resolve": "^1.22.8" | ||
}, | ||
"devDependencies": { | ||
"@types/resolve": "^1.20.6", | ||
"@types/babel__core": "^7.20.5" | ||
}, | ||
"peerDependencies": { | ||
"@babel/core": "7" | ||
}, | ||
"publishConfig": { | ||
"access": "public" | ||
} | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's unusual initial version ;)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
😄 I copied the
package.json
of@mui/internal-scripts
and didn't give it any further thought.