Skip to content
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

fix!: change to commonjs-static library type of commonjs format #819

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion packages/core/src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -624,7 +624,8 @@ const composeFormatConfig = ({
iife: false,
chunkFormat: 'commonjs',
library: {
type: 'commonjs',
// type: 'commonjs',
type: 'commonjs-static',
},
chunkLoading: 'require',
workerChunkLoading: 'async-node',
Expand Down
2 changes: 1 addition & 1 deletion packages/core/tests/__snapshots__/config.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ exports[`Should compose create Rsbuild config correctly > Merge Rsbuild config i
"chunkLoading": "require",
"iife": false,
"library": {
"type": "commonjs",
"type": "commonjs-static",
},
"wasmLoading": "async-node",
"workerChunkLoading": "async-node",
Expand Down
10 changes: 2 additions & 8 deletions tests/integration/alias/__snapshots__/index.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,9 @@ console.info(a);

exports[`source.alias 2`] = `
""use strict";
var __webpack_exports__ = {};
const a = 'hello world';
console.info(a);
var __webpack_export_target__ = exports;
for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
Object.defineProperty(exports, '__esModule', {
value: true
});
"
Expand All @@ -27,12 +24,9 @@ console.info(__WEBPACK_EXTERNAL_MODULE__a_js_256e6de1__.a);

exports[`source.alias 4`] = `
""use strict";
var __webpack_exports__ = {};
const external_a_cjs_namespaceObject = require("./a.cjs");
console.info(external_a_cjs_namespaceObject.a);
var __webpack_export_target__ = exports;
for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
Object.defineProperty(exports, '__esModule', {
value: true
});
"
Expand Down
21 changes: 8 additions & 13 deletions tests/integration/asset/__snapshots__/index.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,9 @@ const SvgLogo = (props)=>/*#__PURE__*/ (0, jsx_runtime_namespaceObject.jsx)("svg
})
});
const logo_rslib_entry_ = require("../static/svg/logo.svg");
var __webpack_export_target__ = exports;
for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
exports.ReactComponent = __webpack_exports__.ReactComponent;
exports["default"] = __webpack_exports__["default"];
Object.defineProperty(exports, '__esModule', {
value: true
});
"
Expand Down Expand Up @@ -218,9 +218,8 @@ const SvgLogo = (props)=>/*#__PURE__*/ (0, jsx_runtime_namespaceObject.jsx)("svg
})
});
const logo_rslib_entry_ = SvgLogo;
var __webpack_export_target__ = exports;
for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
exports["default"] = __webpack_exports__["default"];
Object.defineProperty(exports, '__esModule', {
value: true
});
"
Expand Down Expand Up @@ -250,9 +249,8 @@ function __webpack_require__(moduleId) {
return module.exports;
}
var __webpack_exports__ = __webpack_require__("./src/assets/logo2.svg?__rslib_entry__");
var __webpack_export_target__ = exports;
for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
exports["default"] = __webpack_exports__["default"];
Object.defineProperty(exports, '__esModule', {
value: true
});
"
Expand Down Expand Up @@ -316,7 +314,6 @@ console.log('defaultImport', 'Url', logo);

exports[`use svgr 2`] = `
""use strict";
var __webpack_exports__ = {};
const jsx_runtime_namespaceObject = require("react/jsx-runtime");
require("react");
const SvgLogo = (props)=>/*#__PURE__*/ (0, jsx_runtime_namespaceObject.jsx)("svg", {
Expand Down Expand Up @@ -368,9 +365,7 @@ const logo_SvgLogo = (props)=>/*#__PURE__*/ (0, jsx_runtime_namespaceObject.jsx)
const logo = require("./static/svg/logo.svg");
console.log('namedImport', 'ReactComponent', logo_SvgLogo);
console.log('defaultImport', 'Url', logo);
var __webpack_export_target__ = exports;
for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
Object.defineProperty(exports, '__esModule', {
value: true
});
"
Expand Down
15 changes: 6 additions & 9 deletions tests/integration/asset/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,8 @@ test('set the size threshold to inline static assets', async () => {
return module.exports;
}
var __webpack_exports__ = __webpack_require__("./src/assets/logo.svg?__rslib_entry__");
var __webpack_export_target__ = exports;
for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
exports["default"] = __webpack_exports__["default"];
Object.defineProperty(exports, '__esModule', {
value: true
});
"
Expand Down Expand Up @@ -130,9 +129,8 @@ test('set the assets filename with hash', async () => {
return module.exports;
}
var __webpack_exports__ = __webpack_require__("./src/assets/image.png?__rslib_entry__");
var __webpack_export_target__ = exports;
for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
exports["default"] = __webpack_exports__["default"];
Object.defineProperty(exports, '__esModule', {
value: true
});
"
Expand Down Expand Up @@ -188,9 +186,8 @@ test('set the assets output path', async () => {
return module.exports;
}
var __webpack_exports__ = __webpack_require__("./src/assets/image.png?__rslib_entry__");
var __webpack_export_target__ = exports;
for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
exports["default"] = __webpack_exports__["default"];
Object.defineProperty(exports, '__esModule', {
value: true
});
"
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/auto-extension/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ describe('should respect output.filename.js to override builtin logic', () => {
const { entryFiles } = await buildAndGetResults({ fixturePath });
expect(extname(entryFiles.esm!)).toEqual('.mjs');
expect(entryFiles.cjs).toMatchInlineSnapshot(
`"<ROOT>/tests/integration/auto-extension/type-commonjs/config-override/dist/cjs/index.58a9daaa.js"`,
`"<ROOT>/tests/integration/auto-extension/type-commonjs/config-override/dist/cjs/index.b2c849e6.js"`,
);
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,9 @@ const SvgLogo = (props)=>/*#__PURE__*/ (0, jsx_runtime_namespaceObject.jsx)("svg
})
});
const logo_rslib_entry_ = require("../static/svg/logo.svg");
var __webpack_export_target__ = exports;
for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
exports.ReactComponent = __webpack_exports__.ReactComponent;
exports["default"] = __webpack_exports__["default"];
Object.defineProperty(exports, '__esModule', {
value: true
});
"
Expand Down
10 changes: 4 additions & 6 deletions tests/integration/bundle-false/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -217,9 +217,8 @@ test('asset in bundleless', async () => {
return module.exports;
}
var __webpack_exports__ = __webpack_require__("./src/assets/image.png?__rslib_entry__");
var __webpack_export_target__ = exports;
for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
exports["default"] = __webpack_exports__["default"];
Object.defineProperty(exports, '__esModule', {
value: true
});
"
Expand All @@ -242,9 +241,8 @@ test('asset in bundleless', async () => {
return module.exports;
}
var __webpack_exports__ = __webpack_require__("./src/assets/logo.svg?__rslib_entry__");
var __webpack_export_target__ = exports;
for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
exports["default"] = __webpack_exports__["default"];
Object.defineProperty(exports, '__esModule', {
value: true
});
"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,10 @@

exports[`resolve.extensionAlias should work 1`] = `
""use strict";
var __webpack_exports__ = {};
const bar = 'bar';
const foo = 'foo';
console.log(foo + bar);
var __webpack_export_target__ = exports;
for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
Object.defineProperty(exports, '__esModule', {
value: true
});
"
Expand Down
22 changes: 22 additions & 0 deletions tests/integration/format/cjs-static-export/rslib.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { defineConfig } from '@rslib/core';
import { generateBundleCjsConfig } from 'test-helper';

export default defineConfig({
lib: [
generateBundleCjsConfig({
output: {
distPath: {
root: './dist/cjs',
},
filename: {
js: '[name].cjs',
},
},
}),
],
source: {
entry: {
index: './src/index.js',
},
},
});
1 change: 1 addition & 0 deletions tests/integration/format/cjs-static-export/src/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export { foo, bar } from './value.js';
2 changes: 2 additions & 0 deletions tests/integration/format/cjs-static-export/src/value.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export const foo = 'foo';
export const bar = 'bar';
29 changes: 27 additions & 2 deletions tests/integration/format/index.test.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
import path from 'node:path';
import { buildAndGetResults } from 'test-helper';
import { expect, test } from 'vitest';
import { a } from 'vitest/dist/chunks/suite.qtkXWc6R.js';

test('esm', async () => {
const fixturePath = __dirname;
test('import.meta.url should be preserved', async () => {
const fixturePath = path.resolve(__dirname, 'import-meta-url');
const { files, entries, entryFiles } = await buildAndGetResults({
fixturePath,
});
Expand All @@ -29,3 +31,26 @@ test('esm', async () => {
}
`);
});

test('CJS exports should be statically analyzable (cjs-module-lexer for Node.js)', async () => {
const fixturePath = path.resolve(__dirname, 'cjs-static-export');
const { entryFiles } = await buildAndGetResults({
fixturePath,
});

const { bar, foo } = await import(entryFiles.cjs);
expect(bar).toBe('bar');
expect(foo).toBe('foo');

const cjs = await import(entryFiles.cjs);
expect(cjs).toMatchInlineSnapshot(`
{
"bar": "bar",
"default": {
"bar": "bar",
"foo": "foo",
},
"foo": "foo",
}
`);
});