Skip to content

feat: add full ESM support #125

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+2,528 −3,737
Open

feat: add full ESM support #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion .babelrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,8 @@ module.exports = (api) => ({
['@babel/react', { runtime: 'automatic' }],
'@babel/preset-typescript',
],
plugins: [api.env() === 'test' && 'istanbul'].filter(Boolean),
plugins: [
'babel-plugin-add-import-extension',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the safer approach here would be to not add this, and switch tsconfig to moduleResolution: 'NodeNext' which will require extensions in the source. You get more validation from the TS compiler that it's correct.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am unsure whether that is compatible with also outputting a CJS build though, but it should be?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried this initially, but had difficulties in getting docusaurus to resolve the paths with the ".js" extension and not breaking hot reload. There might be better support for TS in docusaurus v3, but that's another large exercise 😅

api.env() === 'test' && 'istanbul',
].filter(Boolean),
});
5 changes: 3 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
"scripts": {
"bootstrap": "yarn --network-timeout 100000 && yarn --cwd www --network-timeout 100000",
"build": "rimraf lib && yarn build:esm && yarn build:cjs && yarn build:popper",
"build:esm": "babel src --out-dir lib --delete-dir-on-start --extensions .ts,.tsx --ignore '**/*.d.ts' && yarn build:esm:types",
"build:esm": "babel src --out-dir lib --delete-dir-on-start --extensions .ts,.tsx --ignore '**/*.d.ts' && yarn build:esm:types && echo '{\"type\": \"module\"}' > lib/package.json",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe just add the type: module to the root package.json?

"build:cjs": "babel src --out-dir cjs --env-name cjs --delete-dir-on-start --extensions .ts,.tsx --ignore '**/*.d.ts' && yarn build:cjs:types && echo '{\"type\": \"commonjs\"}' > cjs/package.json",
"build:esm:types": "tsc -p . --emitDeclarationOnly --declaration --outDir lib",
"build:cjs:types": "tsc -p . --emitDeclarationOnly --declaration --outDir cjs",
Expand Down Expand Up @@ -100,7 +100,7 @@
"@restart/hooks": "^0.6.2",
"@types/warning": "^3.0.3",
"dequal": "^2.0.3",
"dom-helpers": "^5.2.0",
"dom-helpers": "^6.0.1",
"uncontrollable": "^9.0.0",
"warning": "^4.0.3"
},
Expand Down Expand Up @@ -131,6 +131,7 @@
"@vitest/browser": "^3.1.3",
"@vitest/coverage-istanbul": "3.1.3",
"babel-eslint": "^10.1.0",
"babel-plugin-add-import-extension": "^1.6.0",
"babel-preset-env-modules": "^1.0.1",
"cross-env": "^7.0.3",
"eslint": "^9.20.0",
Expand Down
Loading