docs(en): merge rollup/master into rollup-docs-cn/master @ a1a89e77

.eslintrc.js

@@ -21,6 +21,7 @@ module.exports = {
 		'coverage',
 		'_tmp',
 		'cache',
+		'wasm',
 		'/test/*/samples/**/*.*',
 		'!/test/*/samples/**/_config.js',
 		'!/test/*/samples/**/rollup.config.js',

.github/workflows/clean-cache.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Cleanup
         run: |
           gh extension install actions/gh-actions-cache

.github/workflows/repl-artefacts.yml

@@ -15,15 +15,34 @@ jobs:
   upload:
     permissions:
       pull-requests: write # for peter-evans/find-comment and peter-evans/create-or-update-comment
-    # TODO SWC re-enable for rollup-swc once it is working
-    if: ${{ (github.event.pull_request.head.repo.full_name == 'rollup/rollup' || contains( toJson(github.event.pull_request.labels), 'x⁸ ⚙️ build repl artefacts' )) && github.head_ref != 'rollup-swc' }}
+    if: ${{ github.event.pull_request.head.repo.full_name == 'rollup/rollup' || contains( toJson(github.event.pull_request.labels), 'x⁸ ⚙️ build repl artefacts' ) }}
     runs-on: ubuntu-latest
     name: Upload
     steps:
       - name: Checkout Commit
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: refs/pull/${{ github.event.number }}/merge
+      - name: Install Toolchain
+        uses: dtolnay/rust-toolchain@stable
+        #TODO: remove after or before merging release-4.0
+        if: ${{ github.head_ref == 'release-4.0' || github.base_ref == 'release-4.0' }}
+        with:
+          toolchain: nightly
+          targets: x86_64-unknown-linux-gnu
+      - name: Cache cargo
+        uses: actions/cache@v3
+        #TODO: remove after or before merging release-4.0
+        if: ${{ github.head_ref == 'release-4.0' || github.base_ref == 'release-4.0' }}
+        with:
+          path: |
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            .cargo-cache
+            rust/target/
+          key: cargo-cache-${{ hashFiles('rust/Cargo.lock') }}
+          restore-keys: cargo-cache
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
@@ -38,6 +57,12 @@ jobs:
         if: steps.cache-node-modules.outputs.cache-hit != 'true'
         run: npm ci --ignore-scripts
       - name: Build artefacts
+        #TODO: remove after or before merging release-4.0
+        if: ${{ github.head_ref == 'release-4.0' || github.base_ref == 'release-4.0' }}
+        run: npm exec -- concurrently -c green,blue,yellow 'npm:build:napi -- --release' 'npm run build:wasm' 'npm:build:cjs' && npm run build:copy-native && npm run build:bootstrap
+      #TODO: remove after or before merging release-4.0
+      - name: Build artefacts
+        if: ${{ github.head_ref != 'release-4.0' && github.base_ref != 'release-4.0' }}
         run: npm run build:cjs && npm run build:bootstrap
       - name: Upload "${{ github.event.number }}/rollup.browser.js" to bucket
         uses: zdurham/s3-upload-github-action@master
@@ -61,6 +86,19 @@ jobs:
           S3_KEY: ${{ github.event.number }}/rollup.browser.js.map
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+      - name: Upload "${{ github.event.number }}/bindings_wasm_bg.wasm" to bucket
+        uses: zdurham/s3-upload-github-action@master
+        #TODO: remove after or before merging release-4.0
+        if: ${{ github.head_ref == 'release-4.0' || github.base_ref == 'release-4.0' }}
+        with:
+          args: --cache-control max-age=300,public
+        env:
+          FILE: browser/dist/bindings_wasm_bg.wasm
+          AWS_REGION: ${{ secrets.AWS_REGION }}
+          S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
+          S3_KEY: ${{ github.event.number }}/bindings_wasm_bg.wasm
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
       - name: Find Comment
         uses: peter-evans/find-comment@v2
         id: findComment
@@ -84,6 +122,8 @@ jobs:
             npm install ${{ github.event.pull_request.head.repo.full_name }}#${{ github.event.pull_request.head.ref }}
             ```
 
+            Notice: Ensure you have installed Rust nightly. If you haven't installed it yet, please first see https://www.rust-lang.org/tools/install to learn how to download Rustup and install Rust, then see https://rust-lang.github.io/rustup/concepts/channels.html to learn how to install Rust nightly.
+
             or load it into the REPL:
             https://rollupjs.org/repl/?pr=${{ github.event.number }}
       - name: Find Vercel preview URL
@@ -107,5 +147,7 @@ jobs:
             npm install ${{ github.event.pull_request.head.repo.full_name }}#${{ github.event.pull_request.head.ref }}
             ```
 
+            Notice: Ensure you have installed Rust nightly. If you haven't installed it yet, please first see https://www.rust-lang.org/tools/install to learn how to download Rustup and install Rust, then see https://rust-lang.github.io/rustup/concepts/channels.html to learn how to install Rust nightly.
+
             or load it into the REPL:
             ${{ steps.waitForVercel.outputs.url }}/repl/?pr=${{ github.event.number }}

.github/workflows/tests.yml

@@ -18,7 +18,7 @@ jobs:
     name: Node 18 + Coverage (Linux)
     steps:
       - name: Checkout Commit
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
       - name: Setup Node
@@ -50,7 +50,7 @@ jobs:
     name: Node 16 + Extra Tests (Linux)
     steps:
       - name: Checkout Commit
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
@@ -82,7 +82,7 @@ jobs:
     name: Node ${{ matrix.node }} (Linux)
     steps:
       - name: Checkout Commit
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
@@ -110,7 +110,7 @@ jobs:
     name: Node ${{ matrix.node }} (macOS)
     steps:
       - name: Checkout Commit
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
@@ -141,7 +141,7 @@ jobs:
     name: Node ${{ matrix.node }} (Windows)
     steps:
       - name: Checkout Commit
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Node
         uses: actions/setup-node@v3
         with:

CHANGELOG.md

@@ -1,5 +1,58 @@
 # rollup changelog
 
+## 3.29.2
+
+_2023-09-15_
+
+### Bug Fixes
+
+- Export `TreeshakingPreset` type (#5131)
+
+### Pull Requests
+
+- [#5131](https://github.com/rollup/rollup/pull/5131): fix: exports `TreeshakingPreset` (@moltar)
+- [#5134](https://github.com/rollup/rollup/pull/5134): docs: steps to enable symlinks on windows (@thebanjomatic)
+- [#5137](https://github.com/rollup/rollup/pull/5137): chore(deps): lock file maintenance minor/patch updates (@renovate[bot])
+
+## 3.29.1
+
+_2023-09-10_
+
+### Bug Fixes
+
+- Fix time measurement of plugin hooks in watch mode (#5114)
+- Ensure accessing document.currentScript in import.meta.url returns correct results (#5118)
+
+### Pull Requests
+
+- [#5114](https://github.com/rollup/rollup/pull/5114): fix(perf): avoid superfluous timer wrappings in watch mode (@ZhengLiu2825)
+- [#5118](https://github.com/rollup/rollup/pull/5118): fix: access document.currentScript at the top level (@TrickyPi)
+- [#5125](https://github.com/rollup/rollup/pull/5125): chore(deps): update actions/checkout action to v4 (@renovate[bot])
+- [#5126](https://github.com/rollup/rollup/pull/5126): chore(deps): lock file maintenance minor/patch updates (@renovate[bot])
+- [#5129](https://github.com/rollup/rollup/pull/5129): re-enbale repl-artefacts workflow for rollup-swc branch (@TrickyPi)
+
+## 3.29.0
+
+_2023-09-06_
+
+### Features
+
+- Add output.sourcemapFileNames option (#5105)
+- Add generic type parameter for `api` to Plugin type (#5112)
+
+### Bug Fixes
+
+- Ensure mutations of CustomEvent details are tracked (#5123)
+
+### Pull Requests
+
+- [#5105](https://github.com/rollup/rollup/pull/5105): Added option to name sourcemap files, i.e. a output.sourcemapFileName… (@atti187)
+- [#5108](https://github.com/rollup/rollup/pull/5108): chore(deps): lock file maintenance minor/patch updates (@renovate[bot])
+- [#5109](https://github.com/rollup/rollup/pull/5109): Docs: load full path of rollup.browser.js for Rollup V4 (@TrickyPi)
+- [#5112](https://github.com/rollup/rollup/pull/5112): feat(types): add generic type for plugin api (@sxzz)
+- [#5115](https://github.com/rollup/rollup/pull/5115): chore(deps): lock file maintenance minor/patch updates (@renovate[bot])
+- [#5123](https://github.com/rollup/rollup/pull/5123): Deoptimize custom event detail (@lukastaegert)
+
 ## 3.28.1
 
 _2023-08-22_

CONTRIBUTING.md

@@ -16,6 +16,24 @@ We welcome any type of contribution, not only code. You can help with
 
 Working on your first Pull Request? You can learn how from this _free_ course, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
 
+### Git configuration to enable symlinks
+
+The unit tests in this projects make use of symlinks in the git project. On Windows, this may not work as expected without extra configuration. To configure git to create symlinks on windows, you need to enable the Windows "Developer Mode" setting, and also set the `core.symlinks` git feature using either of the following commands:
+
+```bash
+# Global setting
+git config --global core.symlinks true
+
+# Local setting
+git config core.symlinks true
+```
+
+After applying this setting, you may need to reset your local branch to ensure the files get rewritten as symlinks. Note that this step is destructive and you will want to push any changes you have made prior to resetting your branch.
+
+```bash
+git reset --hard
+```
+
 ### How to run one test on your local machine
 
 With `npm run test` you can run all tests together.

browser/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rollup/browser",
-  "version": "3.28.1",
+  "version": "3.29.2",
   "description": "Next-generation ES module bundler browser build",
   "main": "dist/rollup.browser.js",
   "module": "dist/es/rollup.browser.js",

cli/help.md

@@ -69,6 +69,7 @@ Basic options:
 --sourcemapBaseUrl <url>    Emit absolute sourcemap URLs with given base
 --sourcemapExcludeSources   Do not include source code in source maps
 --sourcemapFile <file>      Specify bundle position for source maps
+--sourcemapFileNames <pattern> Name pattern for emitted sourcemaps
 --stdin=ext                 Specify file extension used for stdin input
 --no-stdin                  Do not read "-" from stdin
 --no-strict                 Don't emit `"use strict";` in the generated modules

docs/command-line-interface/index.md

@@ -106,6 +106,7 @@ export default {
 		sourcemapBaseUrl,
 		sourcemapExcludeSources,
 		sourcemapFile,
+		sourcemapFileNames,
 		sourcemapIgnoreList,
 		sourcemapPathTransform,
 		validate,
@@ -356,6 +357,7 @@ export default {
 许多选项都有等效的命令行标志。在这些情况下，如果你正在使用配置文件，则此处传递的任何参数都将覆盖配置文件。以下是所有支持的选项列表：
 
 ```
+<<<<<<< HEAD
 -c, --config <filename>     使用此配置文件
 														（如果使用参数但未指定值，则默认为 rollup.config.js）
 -d, --dir <dirname>         用于块的目录（如果不存在，则打印到 stdout）
@@ -445,6 +447,98 @@ export default {
 --watch.onError <cmd>       在 "ERROR" 事件上运行的 Shell 命令
 --watch.onStart <cmd>       在 "START" 事件上运行的 Shell 命令
 --watch.skipWrite           在监视时不要将文件写入磁盘
+=======
+-c, --config <filename>     Use this config file (if argument is used but value
+                              is unspecified, defaults to rollup.config.js)
+-d, --dir <dirname>         Directory for chunks (if absent, prints to stdout)
+-e, --external <ids>        Comma-separate list of module IDs to exclude
+-f, --format <format>       Type of output (amd, cjs, es, iife, umd, system)
+-g, --globals <pairs>       Comma-separate list of `moduleID:Global` pairs
+-h, --help                  Show this help message
+-i, --input <filename>      Input (alternative to <entry file>)
+-m, --sourcemap             Generate sourcemap (`-m inline` for inline map)
+-n, --name <name>           Name for UMD export
+-o, --file <output>         Single output file (if absent, prints to stdout)
+-p, --plugin <plugin>       Use the plugin specified (may be repeated)
+-v, --version               Show version number
+-w, --watch                 Watch files in bundle and rebuild on changes
+--amd.autoId                Generate the AMD ID based off the chunk name
+--amd.basePath <prefix>     Path to prepend to auto generated AMD ID
+--amd.define <name>         Function to use in place of `define`
+--amd.forceJsExtensionForImports Use `.js` extension in AMD imports
+--amd.id <id>               ID for AMD module (default is anonymous)
+--assetFileNames <pattern>  Name pattern for emitted assets
+--banner <text>             Code to insert at top of bundle (outside wrapper)
+--chunkFileNames <pattern>  Name pattern for emitted secondary chunks
+--compact                   Minify wrapper code
+--context <variable>        Specify top-level `this` value
+--no-dynamicImportInCjs     Write external dynamic CommonJS imports as require
+--entryFileNames <pattern>  Name pattern for emitted entry chunks
+--environment <values>      Settings passed to config file (see example)
+--no-esModule               Do not add __esModule property
+--exports <mode>            Specify export mode (auto, default, named, none)
+--extend                    Extend global variable defined by --name
+--no-externalImportAssertions Omit import assertions in "es" output
+--no-externalLiveBindings   Do not generate code to support live bindings
+--failAfterWarnings         Exit with an error if the build produced warnings
+--filterLogs <filter>       Filter log messages
+--footer <text>             Code to insert at end of bundle (outside wrapper)
+--no-freeze                 Do not freeze namespace objects
+--generatedCode <preset>    Which code features to use (es5/es2015)
+--generatedCode.arrowFunctions Use arrow functions in generated code
+--generatedCode.constBindings Use "const" in generated code
+--generatedCode.objectShorthand Use shorthand properties in generated code
+--no-generatedCode.reservedNamesAsProps Always quote reserved names as props
+--generatedCode.symbols     Use symbols in generated code
+--no-hoistTransitiveImports Do not hoist transitive imports into entry chunks
+--no-indent                 Don't indent result
+--inlineDynamicImports      Create single bundle when using dynamic imports
+--no-interop                Do not include interop block
+--intro <text>              Code to insert at top of bundle (inside wrapper)
+--logLevel <level>          Which kind of logs to display
+--no-makeAbsoluteExternalsRelative Prevent normalization of external imports
+--maxParallelFileOps <value> How many files to read in parallel
+--minifyInternalExports     Force or disable minification of internal exports
+--noConflict                Generate a noConflict method for UMD globals
+--outro <text>              Code to insert at end of bundle (inside wrapper)
+--perf                      Display performance timings
+--no-preserveEntrySignatures Avoid facade chunks for entry points
+--preserveModules           Preserve module structure
+--preserveModulesRoot       Put preserved modules under this path at root level
+--preserveSymlinks          Do not follow symlinks when resolving files
+--no-sanitizeFileName       Do not replace invalid characters in file names
+--shimMissingExports        Create shim variables for missing exports
+--silent                    Don't print warnings
+--sourcemapBaseUrl <url>    Emit absolute sourcemap URLs with given base
+--sourcemapExcludeSources   Do not include source code in source maps
+--sourcemapFile <file>      Specify bundle position for source maps
+--sourcemapFileNames <pattern> Name pattern for emitted sourcemaps
+--stdin=ext                 Specify file extension used for stdin input
+--no-stdin                  Do not read "-" from stdin
+--no-strict                 Don't emit `"use strict";` in the generated modules
+--strictDeprecations        Throw errors for deprecated features
+--no-systemNullSetters      Do not replace empty SystemJS setters with `null`
+--no-treeshake              Disable tree-shaking optimisations
+--no-treeshake.annotations  Ignore pure call annotations
+--treeshake.correctVarValueBeforeDeclaration Deoptimize variables until declared
+--treeshake.manualPureFunctions <names> Manually declare functions as pure
+--no-treeshake.moduleSideEffects Assume modules have no side effects
+--no-treeshake.propertyReadSideEffects Ignore property access side effects
+--no-treeshake.tryCatchDeoptimization Do not turn off try-catch-tree-shaking
+--no-treeshake.unknownGlobalSideEffects Assume unknown globals do not throw
+--validate                  Validate output
+--waitForBundleInput        Wait for bundle input files
+--watch.buildDelay <number> Throttle watch rebuilds
+--no-watch.clearScreen      Do not clear the screen when rebuilding
+--watch.exclude <files>     Exclude files from being watched
+--watch.include <files>     Limit watching to specified files
+--watch.onBundleEnd <cmd>   Shell command to run on `"BUNDLE_END"` event
+--watch.onBundleStart <cmd> Shell command to run on `"BUNDLE_START"` event
+--watch.onEnd <cmd>         Shell command to run on `"END"` event
+--watch.onError <cmd>       Shell command to run on `"ERROR"` event
+--watch.onStart <cmd>       Shell command to run on `"START"` event
+--watch.skipWrite           Do not write files to disk when watching
+>>>>>>> a1a89e77fbe06a23229486194970f0813593e9df
 ```
 
 以下标志仅通过命令行界面可用。所有其他标志都对应并覆盖其配置文件等效项，请参阅[选项大列表](../configuration-options/index.md)获取详细信息。

docs/configuration-options/index.md

@@ -1470,7 +1470,27 @@ export default {
 
 如果 `output` 设置了值，那么 `sourcemapFile` 不是必须的，这种情况下，它的值会通过输出文件名中添加“.map”推断出来。
 
+<<<<<<< HEAD
 ### output.sourcemapIgnoreList {#output-sourcemapignorelist}
+=======
+### output.sourcemapFileNames
+
+|       |                                                |
+| ----: | :--------------------------------------------- |
+| Type: | `string \| ((chunkInfo: ChunkInfo) => string)` |
+|  CLI: | `--sourcemapFileNames <pattern>`               |
+
+The pattern to use for sourcemaps, or a function that is called per sourcemap to return such a pattern. Patterns support the following placeholders:
+
+- `[format]`: The rendering format defined in the output options, e.g. `es` or `cjs`.
+- `[hash]`: A hash based only on the content of the final generated sourcemap. You can also set a specific hash length via e.g. `[hash:10]`.
+- `[chunkhash]`: The same hash as the one used for the corresponding generated chunk (if any).
+- `[name]`: The file name (without extension) of the entry point, unless the object form of input was used to define a different name.
+
+Forward slashes `/` can be used to place files in sub-directories. When using a function, `chunkInfo` is a reduced version of the one in [`generateBundle`](../plugin-development/index.md#generatebundle) without properties that depend on file names and no information about the rendered modules as rendering only happens after file names have been generated. You can however access a list of included `moduleIds`. See also [`output.assetFileNames`](#output-assetfilenames), [`output.chunkFileNames`](#output-chunkfilenames).
+
+### output.sourcemapIgnoreList
+>>>>>>> a1a89e77fbe06a23229486194970f0813593e9df
 
 |  |  |
 | --: | :-- |