Skip to content

docs: clarify babel plugin requirements in README #13

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.

Sign up for GitHub

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

Merged
stropitek merged 2 commits into from
Jan 21, 2026
Merged

docs: clarify babel plugin requirements in README #13

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b9673fe
docs: clarify babel plugin requirements in README
stropitek Jan 21, 2026
99584ae
chore: prettier
stropitek Jan 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,13 @@ $ npm install @zakodium/babel-plugin-transform-modules-amd

### Via `babel.config.js`

This is the recommended configuration to support all import, export and CJS require statements.

```js
export default {
plugins: [
// This extra plugin is needed if you want to support destructuring when requiring modules
"@babel/plugin-transform-destructuring",
"@babel/plugin-transform-export-namespace-from",
"@zakodium/babel-plugin-transform-modules-amd",
],
};
Expand All @@ -42,13 +44,13 @@ export default {
All [import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import) and [export](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export) statements are supported, but some require to setup your babel config with additional plugins to work.

```js
// ⚠️ Descructuring is not supported out of the box
// Make sure to add "@babel/plugin-transform-destructuring" plugin to your babel config
const { foo } = require("foo");
// ⚠️ Descructuring in CJS require statements is not supported out of the box.
// Use the "@babel/plugin-transform-destructuring" plugin in your babel config to support this syntax.
const { foo } = require("bar");

// ⚠️ Exporting to a namespace is not supported out of the box
// Make sure add the "@babel/plugin-transform-export-namespace-from" plugin to your babel config
export * as foo from "./foo";
// ⚠️ Star exports to a namespace is not supported out of the box.
// Use the "@babel/plugin-transform-export-namespace-from" plugin in your babel config to support this syntax.
export * as foo from "bar";
```

# License
Expand Down