From f9edeef57e5230df78efe7deaea2dec159db89a3 Mon Sep 17 00:00:00 2001 From: Joel Denning Date: Mon, 30 Sep 2024 15:36:35 -0600 Subject: [PATCH] Default to output native modules. Add outputSystemJS option. (#412) * Default to output native modules. Add outputSystemJS option. * Improve changeset --- .changeset/gentle-ducks-wonder.md | 32 +++++++++++++++++++ .../lib/webpack-config-single-spa.js | 5 ++- pnpm-lock.yaml | 13 ++++++++ 3 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 .changeset/gentle-ducks-wonder.md diff --git a/.changeset/gentle-ducks-wonder.md b/.changeset/gentle-ducks-wonder.md new file mode 100644 index 0000000..1a3d990 --- /dev/null +++ b/.changeset/gentle-ducks-wonder.md @@ -0,0 +1,32 @@ +--- +"webpack-config-single-spa": major +--- + +Output to native ES modules by default. Add new outputSystemJS option. + +## Upgrading + +To upgrade without switching to native ES modules, add the `outputSystemJS` option to your webpack.config.js: + +```js +const { merge } = require("webpack-merge"); +const singleSpaDefaults = require("webpack-config-single-spa"); + +module.exports = (webpackConfigEnv, argv) => { + const defaultConfig = singleSpaDefaults({ + orgName: "org", + projectName: "project", + webpackConfigEnv, + argv, + + // This is the new option that preserves backwards compatibility + outputSystemJS: true, + }); + + return merge(defaultConfig, { + // modify the webpack config however you'd like to by adding to this object + }); +}; +``` + +To switch to native ES modules, see the full migration guide on single-spa.js.org diff --git a/packages/webpack-config-single-spa/lib/webpack-config-single-spa.js b/packages/webpack-config-single-spa/lib/webpack-config-single-spa.js index 411d00a..2a07285 100644 --- a/packages/webpack-config-single-spa/lib/webpack-config-single-spa.js +++ b/packages/webpack-config-single-spa/lib/webpack-config-single-spa.js @@ -41,7 +41,7 @@ function webpackConfigSingleSpa(opts) { ), output: { filename: `${opts.orgName}-${opts.projectName}.js`, - libraryTarget: "system", + libraryTarget: opts.outputSystemJS ? "system" : "module", path: path.resolve(process.cwd(), "dist"), uniqueName: opts.projectName, devtoolNamespace: `${opts.projectName}`, @@ -142,5 +142,8 @@ function webpackConfigSingleSpa(opts) { resolve: { extensions: [".mjs", ".js", ".jsx", ".wasm", ".json"], }, + experiments: { + outputModule: !opts.outputSystemJS, + }, }; } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 13b2f9c..fbb6534 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -991,9 +991,11 @@ packages: '@humanwhocodes/config-array@0.5.0': resolution: {integrity: sha512-FagtKFz74XrTl7y6HCzQpwDfXP0yhxe9lHLD1UZxjvZIcbyRz8zTFF/yYNfSfzU414eDwZ1SrO0Qvtyf+wFMQg==} engines: {node: '>=10.10.0'} + deprecated: Use @eslint/config-array instead '@humanwhocodes/object-schema@1.2.1': resolution: {integrity: sha512-ZnQMnLV4e7hDlUvw8H+U8ASL02SS2Gn6+9Ac3wGGLIe7+je2AeAOxPY+izIPJDfFDb7eDjev0Us8MO1iFRN8hA==} + deprecated: Use @eslint/object-schema instead '@isaacs/cliui@8.0.2': resolution: {integrity: sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==} @@ -1666,10 +1668,12 @@ packages: are-we-there-yet@2.0.0: resolution: {integrity: sha512-Ci/qENmwHnsYo9xKIcUJN5LeDKdJ6R1Z1j9V/J5wyq8nh/mYPEpIKJbBZXtZjG04HiK7zV/p6Vs9952MrMeUIw==} engines: {node: '>=10'} + deprecated: This package is no longer supported. are-we-there-yet@3.0.1: resolution: {integrity: sha512-QZW4EDmGwlYur0Yyf/b2uGucHQMa8aFUP7eu9ddR73vvhFyt4V0Vl3QHPcTNJ8l6qYOBdxgXdnBXQrHilfRQBg==} engines: {node: ^12.13.0 || ^14.15.0 || >=16.0.0} + deprecated: This package is no longer supported. argparse@1.0.10: resolution: {integrity: sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==} @@ -2803,10 +2807,12 @@ packages: gauge@3.0.2: resolution: {integrity: sha512-+5J6MS/5XksCuXq++uFRsnUd7Ovu1XenbeuIuNRJxYWjgQbPuFhT14lAvsWfqfAmnwluf1OwMjz39HjfLPci0Q==} engines: {node: '>=10'} + deprecated: This package is no longer supported. gauge@4.0.4: resolution: {integrity: sha512-f9m+BEN5jkg6a0fZjleidjN51VE1X+mPFQ2DJ0uv1V39oCLCbsGe6yjbBnp7eK7z/+GAon99a3nHuqbuuthyPg==} engines: {node: ^12.13.0 || ^14.15.0 || >=16.0.0} + deprecated: This package is no longer supported. gensync@1.0.0-beta.2: resolution: {integrity: sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==} @@ -2853,10 +2859,12 @@ packages: glob@7.2.3: resolution: {integrity: sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==} + deprecated: Glob versions prior to v9 are no longer supported glob@8.1.0: resolution: {integrity: sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ==} engines: {node: '>=12'} + deprecated: Glob versions prior to v9 are no longer supported globals@11.12.0: resolution: {integrity: sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==} @@ -3099,6 +3107,7 @@ packages: inflight@1.0.6: resolution: {integrity: sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==} + deprecated: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful. inherits@2.0.3: resolution: {integrity: sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw==} @@ -4032,10 +4041,12 @@ packages: npmlog@5.0.1: resolution: {integrity: sha512-AqZtDUWOMKs1G/8lwylVjrdYgqA4d9nu8hc+0gzRxlDb1I10+FHBGMXs6aiQHFdCUUlqH99MUMuLfzWDNDtfxw==} + deprecated: This package is no longer supported. npmlog@6.0.2: resolution: {integrity: sha512-/vBvz5Jfr9dT/aFWd0FIRf+T/Q2WBsLENygUaFUqstqsycmZAP/t5BvFJTK0viFmSUxiUKTUplWy5vt+rvKIxg==} engines: {node: ^12.13.0 || ^14.15.0 || >=16.0.0} + deprecated: This package is no longer supported. nth-check@2.1.1: resolution: {integrity: sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==} @@ -4433,6 +4444,7 @@ packages: read-package-json@6.0.4: resolution: {integrity: sha512-AEtWXYfopBj2z5N5PbkAOeNHRPUg5q+Nen7QLxV8M2zJq1ym6/lCz3fYNTCXe19puu2d06jfHhrP7v/S2PtMMw==} engines: {node: ^14.17.0 || ^16.13.0 || >=18.0.0} + deprecated: This package is no longer supported. Please use @npmcli/package-json instead. read-pkg-up@7.0.1: resolution: {integrity: sha512-zK0TB7Xd6JpCLmlLmufqykGE+/TlOePD6qKClNW7hHDKFh/J7/7gCWGR7joEQEW1bKq3a3yUZSObOoWLFQ4ohg==} @@ -4576,6 +4588,7 @@ packages: rimraf@3.0.2: resolution: {integrity: sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==} + deprecated: Rimraf versions prior to v4 are no longer supported hasBin: true run-async@2.4.1: