fix: correct default CJS exports by userquin · Pull Request #475 · unjs/unbuild

userquin · 2024-12-29T15:39:26Z

We should add exports to ESMExport interface in mlly, missing in dts, that's why I added the regex to extract the exports (upps, it is on NamedExport type):

{
  type: 'default',
  exports: ' type X, sum as default',
  specifier: undefined,
  code: 'export { type X, sum as default }',
  start: 87,
  end: 120,
  names: [ 'default' ],
  name: 'default',
  _type: 'named'
}

resolves #474

pi0 · 2025-01-12T23:13:48Z

Sorry for late review dear @userquin.

Do you think you can add some unit tests for fixCJSExportTypePlugin? 🙏🏼 Since we are forking away from tsup implementation, it would be nice to have them in place to both prevent regressions and clearly test desired behaviors.

userquin · 2025-01-13T13:02:19Z

Do you think you can add some unit tests for fixCJSExportTypePlugin? 🙏🏼 Since we are forking away from tsup implementation, it would be nice to have them in place to both prevent regressions and clearly test desired behaviors.

To test the cjs types we can:

add attw (will check the new fixtures) after the test: maybe using pnpm exec attw --pack
add some small parsing via mlly and/or use d.ts and d.cts file snapshots (rn on my local using file snapshots)

I'm going to create a new repo to test the same fixtures using tsup (will fail for mixed declarations) and pkgroll (using import + require package exports here to allow re-use them in pkgroll).

userquin · 2025-01-13T18:52:29Z

@pi0 @danielroe

When all remaining exports (from the default export) only contains types (export { type A, type B }) the export contining the default is replaced by export type { A, B }. Check test/cjs-types-fixture/mixed-declarations/index.ts in this PR and the dist folder.

When re-exporting types from another import, there is no an easy way to know if the export is a type, and so when re-exporting exports, the export contining the default will not be changed. Check test/cjs-types-fixture/reexport-types/index.ts in this PR and the dist folder.

screenshot with generated d.ts files

userquin · 2025-01-13T19:13:41Z

With last commit in the re-export fixture:

pi0 · 2025-01-13T19:23:02Z

Nice work @userquin. I'm wondering if you would be interested in maintaining it as an external/shared library now. (that converts .d.mts to .d.cts) -- it might be usable to unbuild and wider ecosystem.

userquin · 2025-01-13T19:27:52Z

Good idea, maybe we can add it here to the unjs ecosystem... I need to find some free time, too busy at work.

src/builders/rollup/plugins/cjs.ts

userquin · 2025-01-19T16:06:32Z

I've created this repository https://github.com/userquin/unbuild-cjs-exports (instructions on readme file: pnpm monorepo): the repo using a modified plugin version to include required transformations to fix export { default } from '<idenfifier>' (it is working fine at UnoCSS pinning unbuild v3.1.0 => check the wrong-cjs branch in previous repo).

I need to include some test here, no idea how to do that without using monorepo (any hint?).

I guess we need a default export from some installed dependency: exporting default from another package as default and exporting some named export from another package as default. Ofc we also need to mix them with some types.

wrong .d.cts content with unbuild 3.3.1 (without plugin)

test/cjs-types-fixture/mixed-declarations/package.json

test/cjs-types-fixture/reexport-types/package.json

userquin · 2025-01-19T18:20:25Z

I've on my local the changes, ping me if you want the modified plugin here.

userquin · 2025-01-20T14:35:04Z

I'm getting weird dts files when re-exporting as default from another packages, for example export { resolve as default } from 'pathe' will remove the specifier and so wrong (will require the import)=> export = resolve.

We can also re-export default as default, for example export { default } from 'magic-string': same problem

I guess we need to check rollup-dts-plugin...

userquin · 2025-01-23T17:29:11Z

@danielroe @pi0 added cjs.md in the rollup/plugins folder to cover previous cases.

userquin · 2025-01-23T17:39:31Z

~~With this PR we should remove the warning:~~

Entry module "<some-path>" is using named and default exports together. Consumers of your bundle will have to use chunk.default to access the default export, which may not be what you want. Use output.exports: "named" to disable this warning.

src/builders/rollup/plugins/cjs.ts

userquin · 2025-01-26T20:02:36Z

src/builders/rollup/plugins/cjs.ts

+      );
+    } else {
+      magicString.prepend(
+        `import _default from '${defaultExport.specifier}';\n`,


should we parse imports to avoid collisions or just use some suffix or another layout? if someone using import { x as _default } from ...

for example: _default$unbuild or __default__

pi0 · 2025-02-07T10:51:14Z

@userquin Could we please extract this to external package? Maintaining it from unbuild might be tricky in long term with all tests.

userquin · 2025-02-07T10:56:58Z

@userquin Could we please extract this to external package? Maintaining it from unbuild might be tricky in long term with all tests.

ok, I will try to create the repository tomorrow or maybe late this afternoon (CEST)

userquin · 2025-02-07T10:57:29Z

@pi0 any suggestion for the name?

userquin · 2025-02-22T22:17:55Z

@pi0 @danielroe something like this https://github.com/userquin/fix-dts-default-cjs-exports ? I want to allow use it from api or via cli (this todo https://github.com/userquin/fix-dts-default-cjs-exports/blob/main/src/index.ts#L14 )

Check test fixtures, using unbuild to build them with some hack to remove current cjs dts plugin...

userquin · 2025-02-23T18:48:17Z

I'm going to release initial v0.1.0 version, I need to add a few more tests for coverage, can be added later.

I'll try to send also a new PR to use the package here 🤞

pi0 · 2025-02-26T11:28:23Z

Closing in favor of #513

userquin added 2 commits December 29, 2024 16:36

fix: correct default CJS exports dts

f7a74a0

chore: cleanup

7cfe6aa

userquin changed the title ~~fix: correct default CJS exports dts~~ fix: correct default CJS exports Dec 29, 2024

pi0 requested a review from danielroe January 7, 2025 23:03

userquin added 2 commits January 13, 2025 19:20

chore: replace remaining type exports with export type {}

d0d65e7

chore: include test

41d3e0d

chore: include mixed declaration in re-export fixture

cefc220

danielroe approved these changes Jan 17, 2025

View reviewed changes

userquin commented Jan 19, 2025

View reviewed changes

src/builders/rollup/plugins/cjs.ts Outdated Show resolved Hide resolved

userquin commented Jan 19, 2025

View reviewed changes

src/builders/rollup/plugins/cjs.ts Outdated Show resolved Hide resolved

userquin commented Jan 19, 2025

View reviewed changes

src/builders/rollup/plugins/cjs.ts Outdated Show resolved Hide resolved

userquin mentioned this pull request Jan 19, 2025

fix: cjs package exports unocss/unocss#4397

Closed

userquin commented Jan 19, 2025

View reviewed changes

test/cjs-types-fixture/mixed-declarations/package.json Outdated Show resolved Hide resolved

userquin commented Jan 19, 2025

View reviewed changes

test/cjs-types-fixture/reexport-types/package.json Outdated Show resolved Hide resolved

chore: update default package export in cjs fixtures

fe2cbeb

userquin and others added 2 commits January 23, 2025 18:21

chore: include exporting as default logic

ced3c25

chore: apply automated updates

83e51eb

userquin requested a review from danielroe January 23, 2025 17:29

chore: add export default class test

559d630

userquin added 2 commits January 24, 2025 00:03

chore: cleanup cjs.md

b2e853f

chore: remove named export for plugin

a011a78

userquin mentioned this pull request Jan 25, 2025

fix: default package exports tailwindlabs/tailwindcss#15869

Closed

userquin commented Jan 26, 2025

View reviewed changes

src/builders/rollup/plugins/cjs.ts Outdated Show resolved Hide resolved

userquin commented Jan 26, 2025

View reviewed changes

src/builders/rollup/plugins/cjs.ts Outdated Show resolved Hide resolved

userquin commented Jan 26, 2025

View reviewed changes

userquin added 2 commits January 27, 2025 13:00

chore: refactor regular expressions

570cc59

chore: rename function

f20ebec

userquin mentioned this pull request Feb 24, 2025

feat: use fix-dts-default-cjs-exports to transform cjs types #513

Merged

pi0 closed this Feb 26, 2025

This was referenced Feb 26, 2025

feat: use fix-dts-default-cjs-exports to transform CJS types egoist/tsup#1310

Merged

feat: use fix-dts-default-cjs-exports to transform CJS types privatenumber/pkgroll#117

Open

Conversation

userquin commented Dec 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pi0 commented Jan 12, 2025

Uh oh!

userquin commented Jan 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

userquin commented Jan 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

userquin commented Jan 13, 2025

Uh oh!

pi0 commented Jan 13, 2025

Uh oh!

userquin commented Jan 13, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

userquin commented Jan 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

userquin commented Jan 19, 2025

Uh oh!

userquin commented Jan 20, 2025

Uh oh!

userquin commented Jan 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

userquin commented Jan 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

userquin Jan 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pi0 commented Feb 7, 2025

Uh oh!

userquin commented Feb 7, 2025

Uh oh!

userquin commented Feb 7, 2025

Uh oh!

userquin commented Feb 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

userquin commented Feb 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pi0 commented Feb 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

userquin commented Dec 29, 2024 •

edited

Loading

userquin commented Jan 13, 2025 •

edited

Loading

userquin commented Jan 13, 2025 •

edited

Loading

userquin commented Jan 19, 2025 •

edited

Loading

userquin commented Jan 23, 2025 •

edited

Loading

userquin commented Jan 23, 2025 •

edited

Loading

userquin Jan 26, 2025 •

edited

Loading

userquin commented Feb 22, 2025 •

edited

Loading

userquin commented Feb 23, 2025 •

edited

Loading