[v3.0 Release branch]

[lukastaegert]

This PR contains:

• bugfix
• feature
• refactor
• documentation
• other

Are tests included?

• yes (bugfixes and features will not be merged without tests)
• no

Breaking Changes?

• yes (breaking changes will not be merged unless absolutely necessary)
• no

List any relevant issue numbers:

• resolves Chunk hashes should be based on the output #2839
• resolves Parametrize output.banner/output.footer #3398
• resolves JS hash fails to change when asset URL changes #3415
• resolves JS hash changes when src folder moved #3416
• resolves Ability to collect chunk info before or during renderchunk #3519
• resolves Add: .mjs to NONE_ASSET_EXTENSIONS #3671
• resolves Why does the preserveModules option generate node_modules folder #3684
• resolves Inconsistent (JS) Output Hashes with emitted CSS files #3697
• resolves A method of adding an import based on dependency graph #3790
• resolves Plan for import assertions and non-JS module types #3799
• resolves Why do output plugins run before input plugins? #3845
• resolves Disabling file concatenation #3882
• resolves sourcemap inline doesn't work when using API #3913
• resolves Add CLI flag to explicitly disable config file transpilation #4055
• resolves Reduce disk impact of Rollup NPM package #4076
• resolves [v3.0] Better esm config file support #4123
• resolves Drop support for Node.js < 12 #4164
• resolves I need a longer hash with customizable length. #4317
• resolves How to keep [hash] unchanged when in different path #4426
• resolves assert { type: 'json' } results in "Error: Unexpected token" #4530
• resolves It is recommended that you can specify the banner to be set for the specified chunk #4555
• resolves v3+: Can we use "node:<buildinName>" as import specifier in v3+? #4595
• resolves Allow preservation of dynamic import with variable in CJS #4610
• resolves Error TRANSPILED_ESM_CONFIG provides insufficient information #4616
• resolves Rollup throws TRANSPILED_ESM_CONFIG error when importing ESM module #4617
• resolves Rollup cant parse plugin that dependend on ES package #4619
• resolves Plugins array is not re-evaluated when config file is edited in watch mode #4628
• resolves Chunk file name hashes depend on absolute path of project #4634
• resolves chunk hash is different on different computers #4640

Description

This is the collection of everything that is included so far in the 3.0 release branch. Snapshots of this branch will be released as pre-release versions under the beta tag, i.e. to try it out, install Rollup via

npm install rollup@beta

Breaking Changes

General Changes

• Rollup now requires at least Node 14.18.0 to run ([v3.0] Deprecate Node 12 #4548 and [v3.0] Use node: prefix for builtin imports #4596)
• The browser build has been split into a separate package @rollup/browser ([v3.0] Browser build #4593)
• The node build uses the node: prefix for imports of builtin modules ([v3.0] Use node: prefix for builtin imports #4596)
• Some previously deprecated features have been removed ([v3.0] Remove actively deprecated features, show warnings for other deprecated features #4552):
  • Some plugin context functions have been removed:
    • this.emitAsset(): use this.emitFile()
    • this.emitChunk(): use this.emitFile()
    • this.getAssetFileName(): use this.getFileName()
    • this.getChunkFileName(): use this.getFileName()
    • this.isExternal(): use this.resolve()
    • this.resolveId(): use this.resolve()
  • The resolveAssetUrl plugin hook has been removed: use resolveFileUrl
  • Rollup no longer passes assetReferenceId or chunkReferenceId parameters to resolveFileUrl
  • The treeshake.pureExternalModules option has been removed: use treeshake.moduleSideEffects: 'no-external'
  • You may no longer use true or false for output.interop. As a replacement for true, you can use "compat"
  • Emitted assets no longer have an isAsset flag in the bundle
  • Rollup will no longer fix assets added directly to the bundle by adding the type: "asset" field
• Some features that were previously marked for deprecation now show warnings when used ([v3.0] Remove actively deprecated features, show warnings for other deprecated features #4552):
  • Some options have been deprecated:
    • inlineDynamicImports as part of the input options: use output. inlineDynamicImports
    • manualChunks as part of the input options: use output. manualChunks
    • maxParallelFileReads: use `maxParallelFileOps
    • output.preferConst: use output.generatedCode.constBindings
    • output.dynamicImportFunction: use the renderDynamicImport plugin hook
    • output.namespaceToStringTag: use output.generatedCode.symbols
    • preserveModules as part of the input options: use output. preserveModules
  • You should no longer access this.moduleIds in plugins: use this.getModuleIds()
  • You should no longer access this.getModuleInfo(...).hasModuleSideEffects in plugins: use this.getModuleInfo(...).moduleSideEffects
• Configuration files are only bundled if either the --configPlugin or the --bundleConfigAsCjs options are used. The configuration is bundled to an ES module unless the --bundleConfigAsCjs option is used. In all other cases, configuration is now loaded using Node's native mechanisms ([v3.0] Better esm config file support #4574 and [v3.0] Always try to load config files via Node if possible #4621)
• The properties attached to some errors have been changed so that there are fewer different possible properties with consistent types ([v3.0] Refine errors and warnings #4579)
• Some errors have been replaced by others (ILLEGAL_NAMESPACE_REASSIGNMENT -> ILLEGAL_REASSIGNMENT, NON_EXISTENT_EXPORT -> MISSING_EXPORT) ([v3.0] Refine errors and warnings #4579)
• Files in rollup/dist/* can only be required using their file extension ([v3.0] Use named export for loadConfigFile #4581)
• The loadConfigFile helper now has a named export of the same name instead of a default export ([v3.0] Use named export for loadConfigFile #4581)
• When using the API and sourcemaps, sourcemap comments are contained in the emitted files and sourcemaps are emitted as regular assets ([v3.0] Better sourcemap emission #4605)
• Watch mode no longer uses Node's EventEmitter but a custom implementation that awaits Promises returned from event handlers ([v3.0] Custom awaiting watch emitter #4609)
• Assets may only be deduplicated with previously emitted assets if their source is a string ([v3.0] Improve asset emission performance #4644)
• By default, Rollup will keep external dynamic imports as import(…) in commonjs output unless output.dynamicImportInCjs is set to false ([v3.0] Keep dynamic imports in CommonJS output #4647)

Changes to Rollup Options

• As functions passed to output.banner/footer/intro/outro are now called per-chunk, they should be careful to avoid performance-heavy operations ([v3.0] New hashing algorithm that "fixes (nearly) everything" #4543)
• entryFileNames/chunkFileNames functions now longer have access to the rendered module information via modules, only to a list of included moduleIds ([v3.0] New hashing algorithm that "fixes (nearly) everything" #4543)
• The path of a module is no longer prepended to the corresponding chunk when preserving modules ([v3.0] Rework file name patterns when preserving modules #4565)
• When preserving modules, the [name] placeholder (as well as the chunkInfo.name property when using a function) now includes the relative path of the chunk as well as optionally the file extension if the extension is not one of .js, .jsx, .mjs, .cjs, .ts, .tsx, .mts, or .cts ([v3.0] Rework file name patterns when preserving modules #4565)
• The [ext], [extName] and [assetExtName] placeholders are no longer supported when preserving modules ([v3.0] Rework file name patterns when preserving modules #4565)
• The perf option no longer collects timings for the asynchronous part of plugin hooks as the readings were wildly inaccurate and very misleading, and timings are adapted to the new hashing algorithm ([v3.0] Restructure perf timings #4566)
• Change the default value of makeAbsoluteExternalsRelative to "ifRelativeSource" so that absolute external imports will no longer become relative imports in the output, while relative external imports will still be renormalized ([v3.0] Change default for makeAbsoluteExternalsRelative #4567)
• Change the default for output.generatedCode.reservedNamesAsProps to no longer quote properties like default by default ([v3.0] Change default for output.generatedCode.reservedNamesAsProps #4568)
• Change the default for preserveEntrySignatures to "exports-only" so that by default, empty facades for entry chunks are no longer created ([v3.0] Change default for preserveEntrySignatures to exports-only #4576)
• Change the default for output.interop to "default" to better align with NodeJS interop ([v3.0] Improve interop defaults #4611)
• Change the default for output.esModule to "if-default-prop", which only adds __esModule when the default export would be a property ([v3.0] Improve interop defaults #4611)
• Change the default for output.systemNullSetters to true, which requires at least SystemJS 6.3.3 ([v3.0] Change default for systemNullSetters #4649)

Plugin API Changes

• Plugins that add/change/remove imports or exports in renderChunk should make sure to update ChunkInfo.imports/importedBindings/exports accordingly ([v3.0] New hashing algorithm that "fixes (nearly) everything" #4543)
• The order of plugin hooks when generating output has changed ([v3.0] New hashing algorithm that "fixes (nearly) everything" #4543)
• Chunk information passed to renderChunk now contains names with hash placeholders instead of final names, which will be replaced when used in the returned code or ChunkInfo.imports/importedBindings/exports ([v3.0] New hashing algorithm that "fixes (nearly) everything" #4543 and [v3.0] Use ASCII characters for hash placeholders #4631)
• Hooks defined in output plugins will now run after hooks defined in input plugins (used to be the other way around) ([v3.0] Run output plugins last #3846)

Features

• Functions passed to output.banner/footer/intro/outro are now called per-chunk with some chunk information ([v3.0] New hashing algorithm that "fixes (nearly) everything" #4543)
• Plugins can access the entire chunk graph via an additional parameter in renderChunk ([v3.0] New hashing algorithm that "fixes (nearly) everything" #4543)
• Chunk hashes only depend on the actual content of the chunk and are otherwise stable against things like renamed/moved source files or changed module resolution order ([v3.0] New hashing algorithm that "fixes (nearly) everything" #4543)
• The length of generated file hashes can be customized both globally and per-chunk ([v3.0] New hashing algorithm that "fixes (nearly) everything" #4543)
• When preserving modules, the regular entryFileNames logic is used and the path is included in the [name] property. This finally gives full control over file names when preserving modules ([v3.0] Rework file name patterns when preserving modules #4565)
• output.entryFileNames now also supports the [hash] placeholder when preserving modules ([v3.0] Rework file name patterns when preserving modules #4565)
• The perf option will now collect (synchronous) timings for all plugin hooks, not just a small selection ([v3.0] Restructure perf timings #4566)
• All errors thrown by Rollup have name: RollupError now to make clearer that those are custom error types ([v3.0] Refine errors and warnings #4579)
• Error properties that reference modules (such as id and ids) will now always contain the full ids. Only the error message will use shortened ids ([v3.0] Refine errors and warnings #4579)
• Errors that are thrown in response to other errors (e.g. parse errors thrown by acorn) will now use the standardized cause property to reference the original error ([v3.0] Refine errors and warnings #4579)
• If sourcemaps are enabled, files will contain the appropriate sourcemap comment in generateBundle and sourcemap files are available as regular assets ([v3.0] Better sourcemap emission #4605)
• Returning a Promise from an event handler attached to a RollupWatcher instance will make Rollup wait for the Promise to resolve ([v3.0] Custom awaiting watch emitter #4609)
• There is a new value "compat" for output.interop that is similar to "auto" but uses duck-typing to determine if there is a default export ([v3.0] Improve interop defaults #4611)
• There is a new value "if-default-prop" for esModule that only adds an __esModule marker to the bundle if there is a default export that is rendered as a property ([v3.0] Improve interop defaults #4611)
• Rollup can statically resolve checks for foo[Symbol.toStringTag] to "Module" if foo is a namespace ([v3.0] Improve interop defaults #4611)
• There is a new CLI option --bundleConfigAsCjs which will force the configuration to be bundled to CommonJS ([v3.0] Always try to load config files via Node if possible #4621)
• Import assertions for external imports that are present in the input files will be retained in ESM output ([v3.0] Basic support for import assertions #4646)
• Rollup will warn when a module is imported with conflicting import assertions ([v3.0] Basic support for import assertions #4646)
• Plugins can add, remove or change import assertions when resolving ids ([v3.0] Basic support for import assertions #4646)
• The output.externalImportAssertions option allows to turn off emission of import assertions ([v3.0] Basic support for import assertions #4646)
• Use output.dynamicImportInCjs to control if dynamic imports are emitted as import(…) or wrapped require(…) when generating commonjs output ([v3.0] Keep dynamic imports in CommonJS output #4647)

Bug Fixes

• Chunk hashes take changes in renderChunk, e.g. minification, into account ([v3.0] New hashing algorithm that "fixes (nearly) everything" #4543)
• Hashes of referenced assets are properly reflected in the chunk hash ([v3.0] New hashing algorithm that "fixes (nearly) everything" #4543)
• No longer warn about implicitly using default export mode to not tempt users to switch to named export mode and break Node compatibility ([v3.0] Remove implicit default export mode warning #4624)
• Avoid performance issues when emitting thousands of assets ([v3.0] Improve asset emission performance #4644)

Pull Requests

• #3846: Run output plugins last (@aleclarson)
• #4543: New hashing algorithm that "fixes (nearly) everything" (@lukastaegert)
• #4548: Deprecate Node 12 (@lukastaegert)
• #4552: Remove actively deprecated features, show warnings for other deprecated features (@lukastaegert)
• #4565: Rework file name patterns when preserving modules (@lukastaegert)
• #4566: Restructure perf timings (@lukastaegert)
• #4567: Change default for makeAbsoluteExternalsRelative (@lukastaegert)
• #4568: Change default for output.generatedCode.reservedNamesAsProps (@lukastaegert)
• #4574: Better esm config file support (@lohfu and @lukastaegert)
• #4575: Show deprecation warning for maxParallelFileReads (@lukastaegert)
• #4576: Change default for preserveEntrySignatures to exports-only (@lukastaegert)
• #4579: Refine errors and warnings (@lukastaegert)
• #4581: Use named export for loadConfigFile (@lukastaegert)
• #4592: Port doc changes from Document more ways to read package.json in ESM #4572 and Improve ESM code example in documentation #4583 to 3.0 (@berniegp)
• #4593: Browser build (@lukastaegert)
• #4596: Use "node:" prefix for imports of node builtins (@lukastaegert)
• #4605: Better sourcemap emission (@lukastaegert)
• #4609: Custom awaiting watch emitter (@lukastaegert)
• #4611: Improve interop defaults (@lukastaegert)
• #4621: Always try to load config files via Node if possible (@lukastaegert)
• #4624: Remove implicit default export mode warning (@lukastaegert)
• #4631: Use ASCII characters for hash placeholders (@lukastaegert)
• #4644: Improve asset emission performance (@lukastaegert)
• #4646: Basic support for import assertions (@lukastaegert)
• #4647: Keep dynamic imports in CommonJS output (@lukastaegert)
• #4649: Change default for systemNullSetters (@lukastaegert)
• #4651: use compiler target ES2020 (@dnalborczyk)

[github-actions]

Thank you for your contribution! ❤️

You can try out this pull request locally by installing Rollup via

npm install rollup/rollup#release-3.0.0

or load it into the REPL:
https://rollupjs.org/repl/?pr=4549

[codecov]

Codecov Report

Merging #4549 (f4faf31) into master (69ff418) will increase coverage by 0.18%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #4549      +/-   ##
==========================================
+ Coverage   98.87%   99.06%   +0.18%     
==========================================
  Files         211      214       +3     
  Lines        7384     7554     +170     
  Branches     2107     2096      -11     
==========================================
+ Hits         7301     7483     +182     
+ Misses         27       23       -4     
+ Partials       56       48       -8     

Impacted Files	Coverage Δ
browser/src/path.ts	78.57% <ø> (ø)
cli/cli.ts	50.00% <ø> (ø)
cli/run/commandPlugins.ts	93.18% <ø> (ø)
cli/run/loadConfigFromCommand.ts	100.00% <ø> (ø)
cli/run/stdin.ts	100.00% <ø> (ø)
cli/run/waitForInput.ts	100.00% <ø> (ø)
cli/run/watchHooks.ts	78.57% <ø> (ø)
src/ast/keys.ts	100.00% <ø> (ø)
src/ast/nodes/ExportAllDeclaration.ts	100.00% <ø> (ø)
src/ast/nodes/ExportNamedDeclaration.ts	100.00% <ø> (ø)
... and 89 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[lukastaegert]

Feedback about specific changes should go to the pull requests listed above.

[lukastaegert]

Just released a new beta. This changes some defaults and finally makes changing file names in preserveModules a lot saner.

[lukastaegert]

With the latest pre-release 3.0.0-5, Rollup 3 is now feature complete. In the next week(s), we will start taking a look at the plugin eco system. cc @patak-dev @antfu