fix: use modern-module to output tree-shakable artifact

Author: fi3ework

CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# Rslib Contributing Guide
+
+## Setup the Environment
+
+TODO
+
+## Caveats
+
+The project is still under development, so it possible dependents on unstable Rsbuild / Rspack versions.
+
+Current unstable versions are:
+
+| Package      | Version                             | Link                                                    |
+| ------------ | ----------------------------------- | ------------------------------------------------------- |
+| @rspack/core | 0.7.5-canary-b89dbb3-20240620182932 | [PR](https://github.com/web-infra-dev/rspack/pull/6877) |

e2e/cases/define/index.test.ts

@@ -3,7 +3,7 @@ import { type RslibConfig, build } from '@rslib/core';
 import { expect, test } from 'vitest';
 import { globContentJSON } from '#helper';
 
-test.fails('define', async () => {
+test('define', async () => {
   delete process.env.NODE_ENV;
 
   const rslibConfig: RslibConfig = {
@@ -29,6 +29,9 @@ test.fails('define', async () => {
       entry: {
         main: join(__dirname, './js/src/index.js'),
       },
+      define: {
+        VERSION: JSON.stringify('1.0.0'),
+      },
     },
   };
 

e2e/cases/define/js/src/index.js

@@ -1 +1,5 @@
+import { a } from './value';
+
+export { a };
+
 console.info(VERSION);

e2e/cases/define/js/src/value.js

@@ -0,0 +1,4 @@
+// TODO: Rspack only can handle exports from concatenated modules now.
+// Adding this file to let the compile pass as the moment.
+// Remove this file when Rspack could export from single module.`
+export const a = 1;

examples/basic/src/constants.ts

@@ -0,0 +1,2 @@
+export const hello: string = 'Hello';
+export const world: string = 'World';

examples/basic/src/index.ts

@@ -1,3 +1,3 @@
-const message: string = 'Hello, Rslib';
-
-console.log(message);
+import { hello, world } from './constants';
+const message: string = `${hello}, ${world}!`;
+export { hello, world, message as default };

package.json

@@ -12,7 +12,8 @@
     "sort-package-json": "npx sort-package-json \"packages/*/package.json\"",
     "test:artifact": "vitest run  --project artifact",
     "test:e2e": "cd e2e && pnpm run test",
-    "test:unit": "vitest run  --project unit"
+    "test:unit": "vitest run  --project unit",
+    "watch": "pnpm build --watch"
   },
   "simple-git-hooks": {
     "pre-commit": "npx nano-staged"
@@ -42,5 +43,10 @@
   "engines": {
     "node": ">=18.0.0",
     "pnpm": ">=9.0.0"
+  },
+  "pnpm": {
+    "overrides": {
+      "@rspack/core": "0.7.5-canary-b89dbb3-20240620182932"
+    }
   }
 }

packages/core/src/config.ts

@@ -75,23 +75,10 @@ export async function createInternalRsbuildConfig(): Promise<RsbuildConfig> {
   return defineRsbuildConfig({
     tools: {
       htmlPlugin: false,
-      rspack: {
-        output: {
-          module: true,
-          library: {
-            type: 'module',
-          },
-        },
-        optimization: {
-          concatenateModules: true,
-        },
-        experiments: {
-          outputModule: true,
-        },
-      },
     },
     output: {
       filenameHash: false,
+      // TODO: easy to development at the moment
       minify: false,
       distPath: {
         js: './',
@@ -104,36 +91,54 @@ export function convertLibConfigToRsbuildConfig(
   libConfig: LibConfig,
   rsbuildConfig: RsbuildConfig,
 ): RsbuildConfig {
-  // TODO: Configuration mapping needs to be implemented according to features added in the future
-  if (libConfig.format === 'cjs') {
-    mergeRsbuildConfig(rsbuildConfig, {
-      tools: {
-        rspack: {
-          output: {
-            library: {
-              type: 'commonjs',
+  switch (libConfig.format) {
+    case 'esm':
+      return mergeRsbuildConfig(rsbuildConfig, {
+        tools: {
+          rspack: {
+            output: {
+              module: true,
+              iife: false,
+              library: {
+                type: 'modern-module',
+              },
+            },
+            optimization: {
+              concatenateModules: true,
+            },
+            experiments: {
+              outputModule: true,
             },
           },
         },
-      },
-    });
-  }
-
-  if (libConfig.format === 'esm') {
-    mergeRsbuildConfig(rsbuildConfig, {
-      tools: {
-        rspack: {
-          output: {
-            library: {
-              type: 'module',
+      });
+    case 'cjs':
+      return mergeRsbuildConfig(rsbuildConfig, {
+        tools: {
+          rspack: {
+            output: {
+              library: {
+                type: 'commonjs',
+              },
             },
           },
         },
-      },
-    });
+      });
+    case 'umd':
+      return mergeRsbuildConfig(rsbuildConfig, {
+        tools: {
+          rspack: {
+            output: {
+              library: {
+                type: 'umd',
+              },
+            },
+          },
+        },
+      });
+    default:
+      return rsbuildConfig;
   }
-
-  return rsbuildConfig;
 }
 
 export async function composeCreateRsbuildConfig(
@@ -151,6 +156,8 @@ export async function composeCreateRsbuildConfig(
   const composedRsbuildConfig = libConfigsArray.map((libConfig: LibConfig) => {
     const { format, ...overrideRsbuildConfig } = libConfig;
 
+    // Merge order matters, keep `internalRsbuildConfig` at the last position
+    // to ensure that the internal config is not overridden by the user's config.
     const mergedRsbuildConfig = mergeRsbuildConfig(
       sharedRsbuildConfig,
       overrideRsbuildConfig,

packages/core/tests/__snapshots__/config.test.ts.snap

@@ -27,8 +27,9 @@ exports[`Should compose create Rsbuild config correctly > Merge Rsbuild config 1
           "concatenateModules": true,
         },
         "output": {
+          "iife": false,
           "library": {
-            "type": "module",
+            "type": "modern-module",
           },
           "module": true,
         },
@@ -57,17 +58,10 @@ exports[`Should compose create Rsbuild config correctly > Merge Rsbuild config 1
     "tools": {
       "htmlPlugin": false,
       "rspack": {
-        "experiments": {
-          "outputModule": true,
-        },
-        "optimization": {
-          "concatenateModules": true,
-        },
         "output": {
           "library": {
-            "type": "module",
+            "type": "commonjs",
           },
-          "module": true,
         },
       },
     },
@@ -90,17 +84,10 @@ exports[`Should compose create Rsbuild config correctly > Merge Rsbuild config 1
     "tools": {
       "htmlPlugin": false,
       "rspack": {
-        "experiments": {
-          "outputModule": true,
-        },
-        "optimization": {
-          "concatenateModules": true,
-        },
         "output": {
           "library": {
-            "type": "module",
+            "type": "umd",
           },
-          "module": true,
         },
       },
     },