Changelog

Sponsorship

Yarn now accepts sponsorships! Please give a look at our OpenCollective and GitHub Sponsors pages for more details.

Note: features in master can be tried out by running yarn set version from sources in your project (existing contrib plugins are updated automatically, while new contrib plugins can be added by running yarn plugin import from sources <name>).

Master

Major Changes

With Node.js 16's End of Life approaching fast, we dropped support for Node.js versions lower than 18.12.
Some important defaults have changed:
- yarn set version will now skip generating the yarnPath configuration on new projects if it detects you're using Corepack.
- yarn init will no longer use zero-install by default.
All official Yarn plugins are now included by default in the bundle we provide. You no longer need to run yarn plugin import for official plugins (you still need to do it for third-party plugins, of course).
- This doesn't change anything to the plugin API we provide, which will keep being maintained (Yarn still has a modular architecture and uses the exact same APIs as contrib plugins; all that changes is how we distribute our own features).
Yarn's UI during installs has been greatly improved:
- Packages added and removed from the lockfile are now explicitly called out.
- Changes to the project cache are now reported as a single line.
- Unactionable warnings (node-gyp and transitive peer dependency errors) have been removed.
- Skipped builds are now reported during the first installs only (and subsequent yarn rebuild calls).
- The Yarn version is now displayed (to help us investigate issues when reported as screenshots).
- Deprecations have been moved to yarn npm audit.
Some settings were renamed or removed:
- caFilePath is now httpsCaFilePath
- preferAggregateCacheInfo has been removed (it's now always on)
- pnpDataPath has been removed to adhere to our new PnP specification. For consistency, all PnP files will now be hardcoded to a single value so that third-party tools can implement the PnP specification without relying on the Yarn configuration.
The yarn npm audit command has been reimplemented:
- A registry providing the /-/npm/v1/security/advisories/bulk endpoint is now expected. Make sure your registry supports it, and let them know you need it otherwise (in the meantime you can use npmAuditRegistry to send your audit queries to the npm registry).
- Deprecations are now returned by default. To silence them, use --no-deprecations.
Some legacy layers have been sunset:
- Plugins cannot access the Clipanion 2 APIs anymore (upgrade to Clipanion 3)
- Plugins cannot access the internal copy of Yup anymore (use Typanion instead)
- Yarn will no longer remove the old Yarn 2.x .pnp.js file when migrating.
- The --assume-fresh-project flag of yarn init has been removed.

API Changes

The following changes only affect people writing Yarn plugins:

The ZipFS and ZipOpenFS classes have been moved from @yarnpkg/fslib to @yarnpkg/libzip. They no longer need or accept the libzip parameter.
- Reading the zip archives is now done on the Node.js side for performance; as a result, the open, ZIP_CREATE, and ZIP_TRUNCATE bindings are no longer needed for ZipFS and have also been removed.
The dependencies field sent returned by Resolver#resolve must now be the result of a Configuration#normalizeDependencyMap call. This change is prompted by a refactoring of how default protocols (ie npm:) are injected into descriptors. The previous implementation caused various descriptors to never be normalized, which made it difficult to know what were the descriptors each function should expect.
- Similarly, the descriptors returned by Resolve#getResolutionDependencies are now expected to be the result of Configuration#normalizeDependency calls.
- Note that this only applies to the dependencies field; the peerDependencies field is unchanged, as it must only contains semver ranges without any protocol (with an exception for workspace:, but that's not relevant here).
The Resolve#getResolutionDependencies function must now return an object of arbitrary string keys and descriptor values (instead of a map with DescriptorHash keys). Those descriptors will be resolved and assigned to the same keys as the initial object. This change allows resolvers to wrap resolution dependencies from other resolvers, which wasn't possible before since it'd have caused the key to change.
The generateLoader function in @yarnpkg/pnp no longer generates the $$SETUP_STATE function, it now needs to be present in the loader passed to the function.
The getCustomDataKey function in Installer from @yarnpkg/core has been moved to Linker.
renderForm's options argument is now required to enforce that custom streams are always specified.
npmConfigUtils.getAuditRegistry no longer takes a Manifest as its first argument.
The FetchOptions.skipIntegrityCheck option has been removed. Use FetchOptions.cacheOptions.skipIntegrityCheck instead.
MapConfigurationValue has been removed. Use miscUtils.ToMapValue instead.
Manifest.isManifestFieldCompatible and Manifest.prototype.isCompatibleWith{OS,CPU} have been removed. Use Manifest.prototype.getConditions and structUtils.isPackageCompatible instead.
versionUtils.{fetchBase,fetchRoot,fetchChangedFiles} have been moved from @yarnpkg/plugin-version to @yarnpkg/plugin-git. Use gitUtils.{fetchBase,fetchRoot,fetchChangedFiles} instead.
For consistency reasons:
- Link{Resolver,Fetcher} have been renamed to Portal{Resolver,Fetcher}
- RawLink{Resolver,Fetcher} have been renamed to Link{Resolver,Fetcher}
FakeFS classes are now required to implement lutimes{Sync,Promise}.
workspace.dependencies has been removed. Use workspace.anchoredPackage.dependencies instead.
The Installer class must now return BuildRequest structures instead of BuildDirective[]. This lets you mark that the build must be skipped, and the reason why.
startCacheReport has been removed, and is now part of the output generated by fetchEverything.
forgettableNames & forgettableBufferSize have been removed (the only messages using them have been removed, making the forgettable logs implementation obsolete).

Installs

Yarn now caches npm version metadata, leading to faster resolution steps and decreased network data usage.
The pnpm linker avoids creating symlinks that lead to loops on the file system, by moving them higher up in the directory structure.
The pnpm linker no longer reports duplicate "incompatible virtual" warnings.

Features

yarn run now injects the environment variables defined in .env.yarn when spawning a process. The list of files thus injected can be controlled using the injectEnvironmentFiles variable.
yarn workspaces foreach now automatically enables the -v,--verbose flag in interactive terminal environments.

Bugfixes

yarn dlx will no longer report false-positive UNUSED_PACKAGE_EXTENSION warnings
yarn workspace will now set $INIT_CWD to the CLI working directory rather than the workspace root.

Shell

The builtin shell now supports whitespace-only commands.

Compatibility

The patched filesystem now supports FileHandle.readLines.
PnP now reports missing files when in watch mode.

3.4.1

Fixes an accidental backport error in yarn init.

3.4.0

Node.js parity

PnP now supports the Node --conditions flag.
PnP now supports the Node --watch flag on Node 18 (it previously only supported it on Node 19).

Bugfixes

The PnP API module (pnpapi) can now be imported from ESM modules.
ZipFS.prototype.getBufferAndClose will not error on empty archives resulting from an unlink after write.
Fixes various issues around postinstall script inter-dependencies.
Removes the message prefixes (YN0000) from yarn workspaces foreach.

Compatibility

Updates the PnP compatibility layer for TypeScript v5.0.0-beta.

3.3.0

Installs

The node-modules linker avoids creation of circular symlinks
The node-modules linker no longer creates duplicate copies inside of aliased packages
The node-modules linker locates binaries correctly when the same version of the package is duplicated inside root workspace and another workspace
Improved performance for hardlinks-global node-modules linker mode by 1.5x

Compatibility

Updates the PnP compatibility layer for TypeScript v4.9.2-rc.

3.2.4

Compatibility

The patched filesystem now supports fchown.
PnP now handles private import mappings.
Updates the PnP compatibility layer for TypeScript v4.8.4 and v4.9.1-beta.
PnP now reports loaded modules when in watch mode.

3.2.3

Bugfixes

When Corepack is enabled Yarn will now use the current CLI to prepare external Yarn classic projects, matching the behaviour of when Corepack is disabled.

Compatibility

Updates the PnP compatibility layer for TypeScript 4.8.1-rc
The ESM loader now supports unflagged JSON modules.

3.2.2

Compatibility

The patched filesystem now supports ftruncate.
The patched filesystem now supports fchmod.
The patched filesystem now supports throwIfNoEntry.
The PnP filesystem now handles most of the FileHandle methods
Updates the PnP compatibility layer for TypeScript 4.8 Beta
The npm_package_json environment variable is now set by Yarn.

3.2.1

Installs

The pnpm linker no longer tries to remove node_modules directory, when node-modules linker is active
The node-modules linker does not fail anymore if portal dependency points to an external project with multiple interdependent workspaces
The node-modules linker has received various improvements:
- applies hoisting algorithm on aliased dependencies
- reinstalls modules that have their directories removed from node_modules by the user
- improves portal hoisting
- supports supportedArchitectures

Bugfixes

The PnP ESM loader is now able to handle symlinked extensionless entrypoints.

3.2.0

Various improvements have been made in the core to improve performance. Additionally:

Commands

The yarn workspaces foreach run command is now able to run binaries.
The yarn npm info command now supports displaying information about a tagged version of a package (e.g. yarn npm info vue@next).
A new yarn explain command has been added. It can be used to explain an error code, or list all available error codes.
- For example, try to run yarn explain YN0002.
The yarn npm publish command now accepts a new --otp option, to set the One-Time Password from the CLI.
- A better error message will also be shown when a query fails due to an invalid OTP.
yarn upgrade-interactive now has improved paging:
- Yarn will display as many suggestions as can fit in the viewport (rather than a fixed-size list).
- The suggestions that fit in the viewport will be fetched in the foreground and will load one-by-one.
- The suggestions that don't will be fetched in the background and will be loaded in batches to increase responsiveness and reduce input lag.
- Most notably, you won't have to wait for all of the suggestions to be fetched (which took a very long time before on large monorepos) before you can start navigating through the list.

Installs

The node-modules linker now tolerates if node_modules is a symbolic link, and doesn't recreate it.
On top of the cpu and arch fields, Yarn now support a new libc field which can be used in tandem with optionalDependencies to avoid downloading packages that have been linked against incompatible standard libraries (we currently support two values: glibc and musl).
The pnpm linker has received various improvements:
- It will now remove the node_modules/.store and node_modules folders if they are empty.
- It now supports running binaries of soft links.
- It will now create self-references for packages that don't depend on other versions of themselves.
- It will now remove scope folders (e.g. node_modules/@yarnpkg) if they are empty or after removing a scoped dependency.
All .pnp.cjs files with inlined data will now store the data in a JSON string literal instead of an object literal to improve startup performance.

Compatibility

The shell now treats backslashes same as Bash (so it mostly ignore them).
- Could potentially be a breaking change, but the old behavior caused portability issues with a few packages, so we had to make this change (especially since the portable shell is intended to help portability).
The shell now supports ${FOO:+}.
The PnP filesystem now handles read and readSync using options.
The PnP filesystem now handles UNC paths using forward slashes.
The PnP filesystem now sets the proper path property on streams created by createReadStream() and obtained from zip archives.
The PnP runtime now throws an ERR_REQUIRE_ESM error when attempting to require an ES Module, matching the default Node.js behaviour.
Updates the PnP compatibility layer for TypeScript 4.6 Beta (it's possible we'll need to publish another patch update once the 4.6 enters stable).

Bugfixes

@yarnpkg/pnpify now escapes paths correctly.
The ESM loader is now enabled regardless of the entrypoint module type, this fixes support for dynamic imports in commonjs modules when the entrypoint is also commonjs.
The ESM loader is now able to resolve relative imports with search parameters.
The node field inside the npm_config_user_agent Yarn sets will now include a leading v.
Yarn is now able to recover from a corrupted install state.
Yarn is now able to migrate classic lockfiles containing unconventional tarball URLs.
The nm linker hoists portals after hoisting their dependencies first.
Fixed a crash caused by a bad interaction between aliased packages and peer dependencies.
The ESBuild plugin will no longer allow access to Node.js builtins if the platform isn't set to Node.
SemVer ranges with build metadata can now be resolved.
The YARN_IGNORE_NODE environment variable will now be parsed using the same mechanism as env variable configuration settings (i.e. both 1/0 and true/false will be accepted)

ZipFS Extension

You can now unmount zip folders by right-clicking on their workspaces.

Miscellaneous Features

Reporting for Git errors has been improved.
The resolution step now has a progress indicator.
The experimental ESM loader warning emitted by Node.js is now suppressed.
Private registries can now be authenticated using private keys and certificates.
A new wrapNetworkRequest hook now lets you wrap network requests (for example to log them).

3.1.1

Updates the PnP compatibility layer for TypeScript 4.5

3.1.0

Commands

The yarn workspaces list and yarn workspaces foreach commands now both support a new --since option that lets you filter the workspace list by changes (only workspaces that changed since the specified commit will be iterated on). This feature is still a little experimental, especially when used with -R,--recursive.
The yarn workspaces foreach command now handles the fact that a script containing : only becomes global if it exists in exactly one workspace.
The yarn workspaces foreach command now supports --jobs 1 and --jobs unlimited.
The yarn init -2 command will now add the packageManager field to your project manifest.

Settings

The pattern matcher from logFilters will now match any part of the log entry.

Installs

A new nodeLinker: pnpm mode will let you install packages using the pnpm install strategy, where packages are stored flat and referenced by each others through symlinks. This mode is still a little experimental, so please send our way bugs you might find.
Yarn won't install anymore packages that don't match the current OS. Should you need to (for example if you check-in your cache), use the supportedArchitectures field to manually enforce the presence of specific architectures.
The nmMode: hardlinks-global setting will now be automatically downgraded to nmMode: hardlinks-local when global caches and install folders are kept on different devices, thus letting the install continue normally. A warning will still be produced explaining this behaviour.
The node_modules linker maximizes chances to end-up with only one top-level node_modules in the case of using workspaces
The nmSelfReferences setting has been added to the nm linker to control whether workspaces are allowed to require themselves - results in creation of self-referencing symlinks. yarn workspaces focus will not create self-referencing symlinks for excluded workspaces anymore.
Yarn can now install workspaces from remote git repositories that use npm if npm@>=7.x is installed on the system.
The hoisting algorithm should be faster, improving the install time for recurrent node_modules installs.

Miscellaneous Features

Workspaces can now be referred to using workspace:^ and workspace:~. When published, those markers will turn into the actual version (just like what used to happen with workspace:*), except that they'll be prefixed with the relevant semver prefix (respectively ^ and ~).
A new npmAuditRegistry setting will let you define which registry to use when running audits. If unset, we'll fallback to the currently configured publish registry (we'll likely change this behavior in Yarn 4 to rather use the fetch registry).

Bugfixes

Direct portal dependencies for node_modules installs will now be given priority during hoisting, preventing cases when indirect regular dependencies would block the way for direct portal dependencies.
The pnpify binary can now be used from inside directories containing spaces.
The CLI bundles built from sources will now output the commit hash instead of the tree hash, as part of their --version string.
Nested workspaces are properly hoisted by node-modules linker.
Self-referencing symlinks won't be created for anonymous workspaces when using the node-modules linker, since they cannot be used from the code anyway.
The cache is now fully atomic when moving files across devices, and is more efficient in general.
The PnP patch will now properly pick up changes to the fs module, allowing users to patch it.
When using PnP, require.resolve('pnpapi') will be handled correctly even when using exports.
The install state will no longer be invalidated after running commands that modify the lockfile; this should bring a significant performance improvement when running commands such as yarn run immediately after adding or removing dependencies inside large monorepos.
Optional peer dependencies now imply an optional peer dependency on the corresponding @types version. This matches the behaviour for peer dependencies.

Compatibility

Yarn will now generate an experimental ESM loader when it detects you may need it. This can be disabled (or enabled) using pnpEnableEsmLoader.
The PnP compatibility patch for resolve will no longer resolve missing modules to a file with the same name that would happen to be located next to the issuer.
Fixes the SDK to account for a breaking change in VSCode >=1.61.

3.0.2

Updated TypeScript patch to cover TypeScript 4.4.
Fixed VirtualFS.mapToBase to preserve . characters (was converting them to empty strings).

3.0.1

Fixes an edge case with the PnP loader when calling readdir with null as second parameter (instead of undefined).

3.0.0

Breaking Changes

Node 10 isn't supported anymore.
Plugins can't access yup anymore (we migrated to Typanion as part of Clipanion v3).
- To upgrade workspace-tools, remove it from your .yarnrc.yml, upgrade, then import it back.
The enableImmutableInstalls will now default to true on CI (we still recommend to explicitly use --immutable on the CLI).
- You can re-allow mutations by adding YARN_ENABLE_IMMUTABLE_INSTALLS=false in your environment variables.
The initVersion and initLicense configuration options have been removed. initFields should be used instead.
Yarn will now generate .pnp.cjs files (instead of .pnp.js) when using PnP, regardless of what the type field inside the manifest is set to.
The virtual folder (used to disambiguate peer dependencies) got renamed from $$virtual into __virtual__.
The -a alias flag of yarn workspaces foreach got removed; use -A,--all instead, which is strictly the same.
The old PnPify SDK folder (.vscode/pnpify) won't be cleaned up anymore.
The --skip-builds flag from yarn install got renamed into --mode=skip-build.
The bstatePath configuration option has been removed. The build state (.yarn/build-state.yml) has been moved into the install state (.yarn/install-state.gz)
The cache files need to be regenerated. We had to change their timestamps in order to account for a flaw in the zip spec that was causing problems with some third-party tools.
@yarnpkg/pnpify has been refactored into 3 packages:
- @yarnpkg/sdks now contains the Editor SDKs
- @yarnpkg/pnpify now contains the PnPify CLI compatibility tool that creates in-memory node_modules
- @yarnpkg/nm now contains the node_modules tree builder and hoister
@yarnpkg/plugin-node-modules has been renamed to @yarnpkg/plugin-nm
The --clipanion=definitions commands supported by our CLIs will now expose the definitions on the entry point (rather than on .command)

API

structUtils.requirableIdent got removed; use structUtils.stringifyIdent instead, which is strictly the same.
configuration.format got removed; use formatUtils.pretty instead, which is strictly the same, but type-safe.
httpUtils.Options['json'] got removed; use httpUtils.Options['jsonResponse'] instead, which is strictly the same.
PackageExtension['description'] got removed, use formatUtils.json(packageExtension, formatUtils.Type.PACKAGE_EXTENSION) instead, which is strictly the same.
Project.generateBuildStateFile has been removed, the build state is now in Project.storedBuildState.
Project.tryWorkspaceByDescriptor and Project.getWorkspaceByDescriptor now match on virtual descriptors.

Installs

Workspaces now get self-references even when under the node-modules linker (just like how it already worked with the pnp linker). This means that a workspace called foo can now safely assume that calls to require('foo/package.json') will always work, removing the need for absolute aliases in the majority of cases.
The node-modules linker now does its best to support the portal: protocol. This support comes with two important limitations:
- Projects that make use of such dependencies will have to be run with the --preserve-symlinks Node option if they wish to access their dependencies.
- Because Yarn installs will never modify files outside of the project due to security reasons, sub-dependencies of packages with portal: must be hoisted outside of the portal. Failing that (for example if the portal package depends on something incompatible with the version hoisted via another package), the linker will produce an error and abandon the install.
The node-modules linker can now utilize hardlinks. The new setting nmMode: classic | hardlinks-local | hardlinks-global specifies which node_modules strategy should be used:
- classic - standard node_modules layout, without hardlinks
- hardlinks-local - standard node_modules layout with hardlinks inside the project only
- hardlinks-global - standard node_modules layout with hardlinks pointing to global content storage across all the projects using this option

Bugfixes

Yarn now has a proper governance model.
The node-modules linker will now ensure that the generated install layouts are terminal, by doing several rounds when needed.
The node-modules linker will no longer print warnings about postinstall scripts when a workspace depends on another workspace listing install scripts.
Peer dependencies depending on their own parent are now properly hoisted by the node-modules linker.
Boolean values will be properly interpreted when specified inside the configuration file via the ${ENV_VAR} syntax.
Should any of preinstall, install, postinstall fail, the remaining scripts will be skipped.
The git: protocol will now default to fetching HEAD (rather than the hardcoded master).
The SIGTERM signal will now be propagated to child processes.
The PnP linker now schedules packages to be rebuilt if their unplugged folder is removed
yarn config unset will now correctly unset non-nested properties
The TypeScript SDK now
And a bunch of smaller fixes.

Settings

Various initFields edge cases have been fixed.
The preferAggregateCacheInfo flag will now also aggregate cleanup reports.
A new enableMessageNames flag can be set to false to exclude the YNxxxx from the output.

Commands

yarn init can now be run even from within existing projects (will create missing files).
yarn init and yarn set version will set the packageManager field.
yarn set version now downloads binaries from the official Yarn website (rather than GitHub).
yarn set version from sources will now upgrade the builtin plugins as well unless --skip-plugins is set.
yarn version apply now supports a new --prerelease flag which replaces how prereleases were previously handled.
yarn run should be significantly faster to boot on large projects.
yarn workspaces foreach --verbose will now print when processes start and end, even if they don't have an output.
yarn workspaces foreach now supports a --from <glob> flag, which when combined with -R will target workspaces reachable from the 'from' glob.
yarn patch-commit can now be used as many times as you want on the same patch folder.
yarn patch-commit now supports a new -s,--save flag which will save the patch instead of just printing it.
yarn up now supports a new -R,--recursive flag which will upgrade the specified package, regardless where it is.
yarn config unset is a new command that will remove a setting from the local configuration (or home if -H is set).
yarn exec got support for running shell scripts using Yarn's portable shell.
yarn plugin import can now install specific versions of the official plugins.
yarn plugin import will now download plugins compatible with the current CLI by default.
yarn unlink has been added which removes resolutions previously set by yarn link.

Builtin Shell

The shell now supports background jobs, with color-coded output.
It now also supports redirections from file descriptors.

Compatibility

Running yarn install inside a Yarn v1 project will now automatically enable the node-modules linker. This should solve most of the problems people have had in their migrations. We still recommend to keep the default PnP for new projects, but the choice is yours.
The patched filesystem now supports file URLs, bigint, and fstat.
An official ESBuild resolver is now provided under the name @yarnpkg/esbuild-plugin-pnp. We use it to bundle Yarn itself!
PnP projects can now use the Node exports field - regardless of the Node version.
The PnP hook now supports the node: protocol (new in Node 16)
The Prettier SDK does not use PnPify anymore since it was its only remaining use, and was fairly invasive; as a result, the Prettier plugins must be specified in Prettier's plugins configuration property.
Zip terminal links can now be clicked from within VSCode
Builtin patches that fail to apply will no longer cause an error (they'll emit a warning and the original sources will be used instead).
- Remember that patches are a problem for our team too, and that we only do this because we don't have any other option available to us right now - if you wish to help, consider upvoting the relevant pull request in the TypeScript repository or, if you work at Microsoft, perhaps mention to your TypeScript team next door that fixing this would benefit you.

Miscellaneous

Reporting for HTTP errors has been improved, which should help you investigate registry issues.

2.4.3

yarn set version 2.4.3

Updated TypeScript patch to cover TypeScript 4.4.

2.4.2

yarn set version 2.4.2

Updated TypeScript patch to cover TypeScript 4.3.

2.4.1

yarn set version 2.4.1

Compatibility

The release of TypeScript 4.2 couldn't be installed due to patch conflicts. This is now fixed. This version only includes a fix specific to 4.2, but future Yarn releases starting from 3.0 will be more tolerant of this kind of situation and won't cause such errors.

2.4.0

yarn set version 2.4.0

Installs

The resolution pipeline got reimplemented. We previously used a multi-pass approach where we performed SAT optimization between each pass, but after investigating it turned out the SAT optims had little impact and added performance bottlenecks. We now run the resolution using a much simpler and more efficient algorithm.
Linkers can now define custom data to cache between Yarn invocations. The builtin linkers new use those new capabilities to cache package information that can't change between runs. In practice, this translates into much faster recurrent installs (when running an install that adds few new packages, if any).
Warnings are now reported when packageExtensions rules are either unused or redundant with the original package definition.
Potentially breaking, but it was intended this way from the start: the packageExtensions field cannot be used to replace dependencies anymore (only to add missing ones). Prefer using the resolutions field to replace existing ones.
Progress bars are rendered less often, which should help performances on some terminals.
Aliased packages no longer include themselves in node_modules installs

CLI

The upgrade-interactive command will now only show upgrade suggestions for packages that have available upgrades (rather than all of them).
The upgrade-interactive command has received UI improvements that should make it easier to look at.
The yarn workspaces focus command will now only run the postinstall scripts for the focused workspaces.
A new yarn npm audit command lets you query audit information from the npm registry.
The yarn workspaces foreach command has a new flag, -R,--recursive, which will run a command on the current workspace and all others it depends on.
A new --skip-builds option on yarn install will let you skip the build scripts without impacting the generated Yarn artifacts (contrary to enableScripts, which would also stop unplugging the packages that would otherwise be unplugged due to containing build scripts).

Binaries

It's now possible to run dependency binaries when using the node-modules linker even if one of your other dependencies is reported as incompatible with your system.
By default Windows automatically requests for administrator rights before spawning any binary whose filename contains "install", "setup", "update", or "patch" (it thinks they are installers). We now explicitly opt-out of this behavior in the binary jumpers we use on Windows.
By default, arguments passed to MinGW-compiled programs are automatically expanded by a basic glob pattern engine. We now explicitly opt-out of this behavior in the binary jumpers we use on Windows.
The Windows binary jumpers will now report the right exit code.

Settings

Using empty fallbacks in Yarnrc environment variables (${VAR:-}) will now work.
You can now use the new logFilters setting to turn warnings into either errors or info, or to hide them entirely. Note that we plan to significantly improve the peer dependency warnings in the next release, so perhaps don't silence them just now even if you have a bunch of them.

Shell

Some shell errors (No matches found, Bad file descriptor, Unbound variable, Unbound argument) will now be recoverable errors that make the shell continue on to the next command in the chain instead of hard crashes. Fixes cases such as rm -rf ./inexistentFolder/* || true.

VSCode ZipFS Extension

The extension will now activate even if the workspace doesn't contain zip files (usually because you excluded them).

Compatibility

Some patches went missing for TypeScript <4. This is now fixed.
Calling fs.exists(undefined) won't crash anymore.
TypeScript import suggestions should now be correct even when the imported module is deep within a workspace.
TypeScript in watch mode (both using -w and within VSCode) will now detect new dependencies as you add them.
Some particular multi-dependency-trees setups will be better supported on Plug'n'Play installs.
Using ctrl+click on imports in VSCode won't take you to virtual packages anymore (require an SDK update).

2.3.1

yarn set version 2.3.1

CLI

Take into account peer dependency defaults when inheriting workspace peer dependencies in the node_modules linker

2.3.0

yarn set version 2.3.0

CLI

The yarn tag set of commands has been ported over from Yarn Classic as yarn npm tag.
Running yarn info will now print many information about your dependencies. Various options are available to tweak the output, including --json. Plugin authors can provide their own information sections via the fetchPackageInfo hook.
Running yarn stage with the -r,--reset flag will now unstage all changes that seem related to Yarn.
All commands now document each of their options (run yarn add -h to see an example).
Publish registry errors will now be reported as is rather than being collapsed into a generic error message.
A native binary jumper will now be used on Windows to avoid the Terminate batch job (Y/N)? prompts when invoking dependency binaries.

Installs

PnP API

The following changes only apply to the pnp linker (which is the default install strategy):

The pnpapi module now exposes a new function called getAllLocators allow you to access the list of all locators in the map without having to traverse the dependency tree. This method is considered a Yarn extension, so you should check for its existence if you plan to use it in your code.
When using a portal to a package that had peer dependencies, Yarn would loose the information required to resolve those peer dependencies. It will now properly resolve them the same way as all other packages in the dependency tree.

The following changes only apply to the node-modules linker:

The bin symlinks will now be properly removed from the node_modules/.bin folder as their corresponding dependencies are removed.
A new setting called nmHoistingLimits has appeared. It replaces what was previously known as nohoist in Yarn 1.
We are now more forgiving for packages that make incorrect assumptions about the hoisting layout by first trying to maximize package exposure at the top-level. Only after the top-level has been populated will we deduplicate the remaining packages.
Fixed some pathological cases around peer dependencies. In particular, workspaces' peer dependencies will now be resolved against their closest workspace ancestor (according to the directory hierarchy) rather than be ignored. Note that peer dependencies are inherently problematic with workspaces when using the node-modules linker, and that the strictly correct behavior can only be obtained by using the default Plug'n'Play linker.
Running install after an interrupted install is supported now and will result in a consistent install state

Shell

Added support for $$ and $PPID
Fixes some pathological globbing problems.

Bugfixes

The yarn constraints --fix command will now properly persist the changes on disk.
The yarn unplug command will now work when used on packages with peer dependencies.
The yarn stage command will now allow to stage files when called without the -c,--commit flag.
Fixes a performance regression when using FSEvents.

Miscellaneous

Removes extraneous subprocesses when using the yarnPath setting.

Third-party integrations

Updated the VSCode SDK to take into account changes in the TypeScript server protocol.
Added a few builtin extensions to improve compatibility with packages that weren't correctly listing their dependencies.
Updated the TypeScript patch to cover TypeScript 4.1.

2.2.0

yarn set version 2.2.0

Ecosystem

Packages can now use the publishConfig.executableFiles field in their manifests to indicate which files should keep the executable flag once packed in the archive. This is important as for portability reasons Yarn strips the executable flag from all files during packing (otherwise yarn pack would yield different outputs when run on Posix vs Windows). Files listed in the bin field are assumed executable by default, so you don't need to explicitly list them in executableFiles.

Bugfixes

Requests won't timeout anymore as long as the server is still sending data.
yarn pack will properly include main/module/bin files, even when not explicitly referenced through the files field.
Local git repositories can now be fetched via the git+file: protocol.
The progress bars will be properly styled when using the new Windows terminal on certain days.
Yarn will now avoid using deprecated versions of the dependencies, unless only deprecated versions are available for the requested ranges.
Build keys are now properly computed, which fixes issues where build scripts weren't always triggered when they should have been.
Negated glob patterns in the workspace field will now be processed correctly.
Yarn will now allow relative paths inside the workspace: protocol to start with ./
Yarn will now show the actual error when it fails to resolve a request during yarn add and yarn up
The portable shell will now support calling cd and exit without arguments
Yarn will now show the exit code when a lifecycle script fails
Yarn's portable shell will now also pipe the stderr when using the |& pipeline
Yarn's portable shell will now respect the left associativity of list operators

CLI

Yarn will now report an error when run through an incompatible Node version.
yarn add and yarn up will now respect the preferInteractive configuration option.
yarn config set now supports the -H,--home flag, which causes it to update the home configuration instead of the project configuration.

Configuration

The settings found in the home configuration file won't cause exceptions when consumed by older Yarn versions. Unsupported options will simply be silently ignored. This should improve the user experience when working with multiple projects configured with different Yarn versions.
A new immutablePaths setting allow you to specify paths that must not change when running Yarn with the --immutable flag set. You can use it to detect unforeseen changes to your install artifacts, be it .pnp.js or node_modules files.

Miscellaneous

Scripts can now use the $RANDOM variable as well as simple calculations using +, -, *, / and () inside $(())
Scripts can now use grouping curly braces ({echo foo}) to execute a command in the context of the current shell (without creating a subshell like in the case of (echo foo)).
Scripts can now end with a semicolon.
PnP linker will not remove lingering node_modules inside folders matching pnpIgnorePatterns

Third-party integrations

The PnP hook will now display clearer error message when requiring Node builtins from contexts that can't access them out of the box (for example when accessing the fs module from within a Webpack browser bundle).

2.1.1

yarn set version 2.1.1

Fixed hyperlink rendering on iTerm

2.1.0

yarn set version 2.1.0

Ecosystem

Packages can now declare they they need to be unpacked in order to be functional using the new "preferUnplugged": true field in the manifest. This will hurt the experience of your users (your project will be the only one that will require hard installs), so please refrain using this field unless there's no other choice.

New commands

Running yarn search will open a rich interface to search for packages to install (requires the interactive-tools plugin).
Running yarn npm logout will remove your credentials from your home directory.
Running yarn plugin import from sources will allow you to build plugins from the master branch of the our repository.
Running yarn workspaces focus will only install the current workspace, plus any other workspace it might depend on. The --production flag will only install their production dependencies.
Running yarn exec will execute the specified command at the root of the current workspace (reintroduced from the Classic branch).
Running yarn create is now an alias to yarn dlx (with the create- prefix.)

CLI

yarn init will now generate an EditorConfig file, and run git init on the resulting folder.
yarn init now supports a -i flag which will automatically pin the Yarn version in the project.
yarn init will now inject the settings from the initFields configuration setting when generating the initial manifest (future release will remove the now deprecated initVersion and initLicense settings).
yarn init will now initialize a workspace project if given the -w flag.
yarn workspaces foreach now support glob patterns in --include and --exclude.
yarn set version now as an alias called yarn policies set-version (will be deprecated in 3.x).
yarn run now supports the --inspect and --inspect-brk switches for binaries (for example yarn run --inspect-brk jest).
yarn remove and yarn up now support glob patterns.
yarn dlx now respects the local project configuration (particularly the configured registries). This is still experimental and will be further improved in the next months.
yarn dlx now properly exits with an exit code when the underlying command returned an exit code too.
yarn config get (and set) can now access nested configuration values (for example, yarn config get npmScopes.foo.npmRegistryServer will tell you which server is configured for the given server, if any).
yarn config get will now hide its secrets (or rather yours) from the rest of the world. A new --no-redacted option will toggle off this behavior if needed.
yarn config set now has a --json option that will let Yarn know it should interpret the given value as a JSON object (useful to set server configuration, etc).
yarn workspace foreach will now exit with the expected status code if there's an error.

Configuration

Registry auth settings can now be declared per-scope (they previously had to be per-registry). This will be handy with the GitHub Package Registry model, where each scope may have different access tokens.
The configuration file now interpolates the values with the environment variables using the ${name} syntax (strict by default; use ${name:-default} to provide a default value).
The new changesetIgnorePatterns setting can be used to ignore some paths from the changeset detection from yarn version check (changes to those paths won't be taken into account when deciding which workspaces need to fresh releases).
The new changesetBaseRef setting can be used to change the name of the master branch that yarn version check will use in its changeset heuristic.
The new httpTimeout and httpRetry settings allow you to configure the behavior of the HTTP(s) requests.
The new preferTruncatedLines setting allow you to tell Yarn that it's ok if info and warning messages are truncated to fit in a single line (errors will always wrap as much as needed, and piping Yarn's output will toggle off this behaviour altogether).
The cache compression level can now be configured through compressionLevel. If you don't use Zero-Installs, using a value of 0 may yield speed improvements at little cost.
Plugins are now loaded from the location of the RC file.

Protocols

The Git protocol has been improved, and now supports multiple patterns that were missing.
The Git protocol can now clone any workspace from a given repository. To do this, use the owner/repo#workspace=name syntax (which you can mix with branch names as usual).
The repositories cloned using the Git protocol will now automatically disable core.autocrlf so that the builds lead to deterministic results. Generally speaking, improvements have been made to avoid freshly built packages from generating different results.
Packages fetched using the Git protocol will now be built using either of Yarn 1, Yarn 2, npm, or pnpm. The choice will be made based on the content of the sources (for example, we will pack the project using npm pack if we detect a package-lock.json).
The exec: protocol has a different API. In particular, builtin modules can now be accessed without having to actually require them.

Installs

Deprecation warnings are now shown during installs.
The out-of-file PnP data generation has been fixed (it allows to generate the PnP data in a JSON file separated from the JS loader itself).
An edge case in the virtual instances deduplication has been fixed; packages with the same effective peer dependencies now always share the exact same instance.
The heuristic we use to locate zip files within paths has been improved. As a result, running ESLint on our repository now takes 28s instead of 57s.
Yarn will now exclude the node_modules folder from the workspace detection. As a result, listing **/* in your workspaces field will now detect all child packages as workspaces.
The cache names have changed in order to make the cache content-addressed. In particular, this mean that in the event where we need to fix a bug in the fetch steps, we won't need to bump a global cache key anymore.
The PnP linker now features an additional loose mode (optional, and enabled through the pnpMode: loose setting). Under this mode, Yarn will compute the list of packages that would have been hoisted under the node_modules linker, and let the application code access them with only a warning. This mode will however not become the default - warnings cannot be caught by the application code, and as a result the output of the loose mode can be quite verbose, often being more confusing than the strict mode.
Because we're aware of no incorrect hoisting bug on the v2 (but have discovered a few in the v1), and because its performances are about the same, the node_modules linker from Yarn 2 is now deemed more stable than the one from the v1, and we recommend users to migrate to it even if you don't want to use Plug'n'Play. More improvements are to come, but they'll mostly be in the user experience (for example to mix PnP and nm into a single install).

Rendering

Rendering on small terminals (or terminals which didn't expose their size) could lead to failed assertions. This is now fixed.
The output of yarn upgrade-interactive has been revamped to reintroduce some elements that had been omitted when porting the command from the v1 to the v2.
Error codes are now hyperlinks on compatible terminals.

Third-party integrations

The PnP hook will now display the list of packages that broke the peer dependency chain (it previously only showed the name of the package that wasn't provided the peer dependency, but not the name of which ancestor was responsible).
We have added lutimes support into Node itself, since it was otherwise impossible to implement perfect copy mechanisms (the copied symlinks would end up with different mtime than their originals).
The SDK files have been moved from .vscode/pnpify to .yarn/sdks.
Improvements have been made in the VSCode integration. In particular, the PnP support is now good enough that it started to fix some longstanding issues that VSCode had with properly naming workspaces.
We have contributed to VSCode support for third-party protocols with TypeScript. As a result, zip archives now properly support the "Jump to definition" workflow (this requires the ZipFS extension to be installed).
The SDK output has been migrated to the same standard as the other commands.
The SDK can now prepare the development environment for both VSCode and Vim. More third-party tools have been added, such as the Svelte extension. Note: the SDK is only needed for editor integrations; you don't need it if you just want to author JavaScript on basic text editors.

Miscellaneous

Scripts can now use glob patterns, which will be resolved regardless of the underlying shell (so it'll work on Windows as well as Linux). Note that this only covers file globbing - using something like echo {foo,bar} won't work expect if there's actually a file named foo and/or bar.
Sending SIGKILL (or other signals) to the Yarn process wasn't causing the child processes to stop. Yarn will now forward the signal, and wait for its children to exit.
Some temporary folders weren't properly cleaned up; this has been fixed.
Support for the .cjs extension has been added to multiple files in order to make it easier to use "type": "module".
The bundle has received various size and startup time optimizations.

2.0.0

yarn set version 2.0.0

Remember that a migration guide is available to help you port your applications to Yarn 2.

Notable fixes

Using yarn link will now properly resolve peer dependencies based on the package that requires the linked package rather than the dependencies installed in the linked project folder.
Packages will now only be built when one of their dependencies is changed in some way. Note that this includes both direct dependencies and transitive dependencies, which might trigger unintuitive rebuilds in some case (for example, since node-sass depends on lodash.assign, upgrading lodash.assign will trigger a rebuild). This will be improved in a later release by introducing a new runtime field for the dependenciesMeta object that will exclude the package from the build key computation (feel free to start setting this flag as of now, even if it won't have any effect until then).
Registry hostnames finally aren't part of the lockfile anymore. It means that you can switch the registry at any time by changing the npmRegistryServer settings. One unfortunate limitation is that this doesn't apply to registries that use non-standard paths for their archives (ie /@scope/name/-/name-version.tgz). One such example is NPM Enterprise, which will see the full path being stored in the lockfile.
The --immutable option (new name for --frozen-lockfile) will now properly report when the lockfile would be changed because of entry removals (it would previously only reject new entries, not removals).

Notable changes

We dropped support for Node 8, which has reached its end of life in December.
Accessing registries through http is now forbidden by default (Yarn will throw an exception and require to use https instead). This can be overruled on a per-hostname basis by using unsafeHttpWhitelist.
The meaning of devDependencies is slightly altered. Until then dev dependencies were described as "dependencies we only use in development". Given that we now advocate for all your packages to be stored within the repository (in order to guarantee reproducible builds), this doesn't really make sense anymore. As a result, our description of dev dependencies is now "dependencies that aren't installed by the package consumers". It doesn't really change anything else than the name, but the more you know.
- One particular note is that you cannot install production dependencies only at the moment. We plan to add back this feature at a later time, but given that enabling Zero-Installs would cause your repository to contain all your packages anyway (prod & dev), this feature isn't deemed as important as it used to be.
Running yarn link <package> now has a semi-permanent effect in that <package> will be added as a dependency of your active workspace (using the new portal: protocol). Apart from that the workflow stays the same, meaning that running yarn link somewhere will add the local path to the local registry, and yarn link <package> will add a dependency to the previously linked package.
- To disable such a link, just remove its resolution entry and run yarn install again.
The Yarn configuration has been revamped and will not read the .npmrc files anymore. This used to cause a lot of confusion as to where the configuration was coming from, so the logic is now very simple: Yarn will look in the current directory and all its ancestors for .yarnrc.yml files.
- Note that the configuration files are now called .yarnrc.yml and thus are expected to be valid YAML. The available settings are listed here.
The lockfiles now generated should be compatible with Yaml, while staying compatible with old-style lockfiles. Old-style lockfiles will be automatically migrated, but that will require some round-trips to the registry to obtain more information that wasn't stored previously, so the first install will be slightly slower.
The cache files are now zip instead of tgz. This has an impact on cold install performances, because the currently available registries don't support it, which requires us to convert it on our side. Zero-Install is one way to offset this cost, and we're hoping that registries will consider offering zip as an option in the future.
- We chose zip because of its perfect combination in terms of tooling ubiquity and random access performances (tgz would require to decompress the whole archive to access a single file).

Package manifests (`package.json`)

To see a comprehensive documentation about each possible field, please check our documentation.

Two new fields are now supported in the publishConfig key of your manifests: the main, bin, and module fields will be used to replace the value of their respective top-level counterparts in the manifest shipped along with the generated file.
- The typings and types fields will also be replaced if you use the TypeScript plugin.
Two new fields are now supported at the root of the manifest: dependenciesMeta and peerDependenciesMeta (peerDependenciesMeta actually was supported in Yarn 1 as well, but dependenciesMeta is a new addition). These fields are meant to store dependency settings unique to each package.
- Both of these new fields, and all settings the support, are entirely optional. Yarn will keep doing what you expect if they're not there - they're just a mechanism to expose more fine-grained settings.
- Some of those settings can only be declared in the project top-level manifest and will be ignored anywhere else (for example built), while others will have a per-package effect (for example optional). As a rule of thumb, dependenciesMeta settings are always project-wide (and thus are only taken into account in the top-level package.json) while peerDependenciesMeta settings are package-specific.
- The dependenciesMeta field covers dependencies declared in either of the dependencies and devDependencies fields.
- The dependenciesMeta field accepts two types of keys: either a generic package name (lodash), or a specialized package version (lodash@1.2.3). This later syntax only works for the top-level manifest and will thus be ignored when seen in a dependency / transitive dependency.
The dependenciesMeta[].comment field is expected to be a string field. Even though it isn't actually used anywhere at the moment, we suggest you to write comments regarding the reason why some packages are used here rather than anywhere else. This might prove useful for plugin authors.
The dependenciesMeta[].built field is a boolean flag; setting it to false will cause the package manager to ignore this package when considering the list of packages that need to be built. If the project uses enable-scripts: false, the warning that would have traditionally been emitted will be downgraded into a simple notice. This settings is project-wide.
The peerDependenciesMeta[].optional field is a boolean flag; setting it to true will stop the package manager from emitting a warning when the specified peer dependency is missing (you typically want to use it if you provide optional integrations with specific third-party packages and don't want to pollute your users' installs with a bunch of irrelevant warnings). This settings is package-specific.
The resolutions field no longer support the glob syntax within its patterns, as it was redundant with its own glob-less syntax and caused unnecessary confusion.
```
{
  "resolutions": {
-    "**/@babel/core": "7.5.5",
+    "@babel/core": "7.5.5",
  }
}
```

Workspaces

Workspaces can now be referenced using the special workspace: protocol. This protocol accepts either a relative path to the workspace, or a semver range that will be compared against the version fields from candidate workspaces.
Workspaces don't have to specify a version anymore. If referenced through the workspace: resolver, the engine will assume that they have the version 0.0.0 (which makes workspace:* a good way to say "shut up and take my workspace").
- That being said, workspaces referenced through the workspace: protocol will see their referenced changed at pack-time if the target workspace defines a version. An error will be thrown otherwise and the package won't be packable.
Workspaces can now contain sub-workspaces. This follow the same restriction than before, meaning that any workspace that wishes to expose sub-workspaces must be declared private: true.

CLI

The npm-specific commands (such as yarn login or yarn publish) have been moved into a specific namespace (yarn npm login / yarn npm publish). This doesn't affect the yarn pack command which is considered generic enough for the top-level.
Running yarn <path> add ... will run the add command into the location pointed by <path>. This is true for any command. The only limitation is that <path> must be either be ., .., or must contain a slash (in order to disambiguate with script and command names).
Running yarn add -P <package> will use * by default instead of resolving a new range for <package>. This change only affects peer dependencies (-P), and can be disabled by manually specifying the range (yarn add -P lodash@^4.0.0).
Running yarn add <package> -i will now make suggestions based on the dependencies from your other workspaces. This behavior can be made a default by setting preferInteractive to true in your settings.
Running yarn foo:bar will run the foo:bar script regardless of what workspace declares it as long as only one workspace declares it. This change only affects scripts whose names contains at least one colon.
Running yarn remove -A <package> will remove <package> from all the dependency sets from all your workspaces, regardless of what your cwd is.
Running yarn set resolution <package> <resolution> will force the resolver to use a specific resolution for the given package descriptor. Note that the descriptor passed as parameter must be exactly the same as the one you want to override. This command is a handy tool to manually optimize some ranges that could benefit from overlapping.
Running yarn up <package> will upgrade <package> in all of your workspaces at once (only if they already use the specified package - those that don't won't see it being added). Adding the -i flag will also cause Yarn to ask you to confirm for each workspace.
Running yarn config --why will tell you the source for each value in your configuration. We recommend using it when you're not sure to understand why Yarn would have a particular settings.
Running yarn pack will no longer always include nested README, CHANGELOG, LICENSE or LICENCE files (note that those files will still be included if found at the root of the workspace being packed, as is usually the case). If you rely on this (somewhat unintended) behavior you can add those files manually to the files field of your package.json.
The yarn upgrade-interactive command has been moved into a plugin that needs to be installed through yarn plugin import interactive-tools. It's also been rewritten, and we'll keep improving over time.

Miscellaneous

A new protocol is now supported, portal:. Portals are very much like link: in that they directly point to a location on the disk, but unlike links they also take into account the dependencies of the target location (whereas links don't care about these). To give you a better idea, portals are what you use when you want to target a package, whereas links are what you use when you want to target a non-package folder (for example your src directory, or similar).
A new protocol is now supported, patch:. The patch protocol can be used to automatically apply changes to the sources of a package. It's very similar to patch-package, but is directly integrated within Yarn (including its cache and checksum systems).

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

Changelog

Sponsorship

Master

Major Changes

API Changes

Installs

Features

Bugfixes

Shell

Compatibility

3.4.1

3.4.0

Node.js parity

Bugfixes

Compatibility

3.3.0

Installs

Compatibility

3.2.4

Compatibility

3.2.3

Bugfixes

Compatibility

3.2.2

Compatibility

3.2.1

Installs

Bugfixes

3.2.0

Commands

Installs

Compatibility

Bugfixes

ZipFS Extension

Miscellaneous Features

3.1.1

3.1.0

Commands

Settings

Installs

Miscellaneous Features

Bugfixes

Compatibility

3.0.2

3.0.1

3.0.0

Breaking Changes

API

Installs

Bugfixes

Settings

Commands

Builtin Shell

Compatibility

Miscellaneous

2.4.3

2.4.2

2.4.1

Compatibility

2.4.0

Installs

CLI

Binaries

Settings

Shell

VSCode ZipFS Extension

Compatibility

2.3.1

CLI

2.3.0

CLI

Installs

PnP API

Shell

Package manifests (`package.json`)