yarn (package manager)
 | |
| Developer(s) | Maël Nison, Yarn core team |
|---|---|
| Initial release | 18 June 2016[1] |
| Stable release | 4.6.0[2] 
/ 29 December 2024 |
| Repository | |
| Written in | TypeScript, JavaScript |
| Platform | Cross-platform |
| Type | Package manager |
| License | BSD 2-Clause License |
| Website | yarnpkg |
Yarn is one of the main JavaScript package managers,[3][4] initially started in 2016 by Sebastian McKenzie of Meta (formerly Facebook) for the Node.js JavaScript runtime environment. An alternative to the npm package manager, Yarn was created as a collaboration of Facebook (now Meta), Exponent (now Expo.dev), Google, and Tilde (the company behind Ember.js) to solve consistency, security, and performance problems with large codebases.[5]
While bootstrapped by tech companies, the project was setup from the get go as its own GitHub organization, and eventually became fully autonomous in 2019, following its lead maintainer as he left Facebook for Datadog.
Yarn 2 & Yarn Plug'n'Play
[edit]In 2020 the Yarn team released a major update, Yarn 2.0, also codenamed "Berry"[6]. This version came with a full rewriting of both the codebase (which migrated to TypeScript in the process) and test suite. Many features were introduced, a cleaving one being a new unique installation strategy called Yarn Plug'n'Play.
Under this default but optional mode, Yarn wouldn't generate a node_modules folder anymore, instead opting to generate a single Node.js resolver file named .pnp.cjs.[7] While justified by the Yarn team as a need to address multiple design flaws in the typical Node.js module resolution, this change required some support from other projects in the ecosystem which took some time to materialise, adding friction to the migration from Yarn 1.22. to Yarn 2.0.
Plugins
[edit]Users can write their own plugins for Yarn.
Constraints
[edit]Yarn constraints allow users to enforce rules for their dependencies or manifest fields across scoped workspaces.
Offline cache
[edit]Downloaded packages are cached and stored as a single file.
Plug'n'Play
[edit]Plug'n'Play allows users to run Node projects without node_modules folder, defining the way or location to resolve dependencies package files with the Plug-n-Play-control file. This feature is aimed to fix an unwell structured node_modules architecture and resulting in a faster Node.js application start-up time.
Plugins
[edit]Plugins can add new resolvers, fetchers, linkers, commands, and can also register to some events or be integrated with each other, most features of Yarn are implemented through plugins, including yarn add and yarn install, which are also preinstalled plugins.
Protocols
[edit]Users can define which protocol will be used to resolve certain packages, for example, the git protocol is used for downloading a public package from a Git repository, and the patch protocol is used for creating a patched copy of the original package.
Release Workflow
[edit]Release Workflow automatically upgrades relative packages among monorepos workspaces when root packages are upgraded.
Workspaces
[edit]Workspaces allow multiple projects to work together in the same repository and automatically apply changes to other relatives when source code is modified, allowing installation of multiple packages in a single pass by running the installation command only once.
Zero-Installs
[edit]Zero-Installs solve the needs of installation of packages when packages is required to install when the codes is just fresh fetched to local.
Comparison to npm
[edit]- Yarn can install packages from local cache.[8]
- Yarn binds versions of the package strongly.
- Yarn uses checksum for ensuring data integrity, while npm uses SHA-512 to check data integrity of the packages downloaded.[9]
- Yarn installs packages in parallel, while npm installs one package at a time.
Syntax
[edit]To install yarn:
npm install -g yarn
To install a package with yarn:[10]
yarn add package-name
To install a package with yarn for development and testing purposes:
yarn add package-name --dev
NB: in the first versions, it was:
yarn install package-name --save-dev
See also
[edit]References
[edit]- ^ "Earliest releases of yarn". GitHub. Retrieved 18 June 2016.
- ^ "Release 4.6.0". 29 December 2024. Retrieved 29 December 2024.
- ^ "Package management basics". MDN. 2022-09-28.
- ^ "5 best JavaScript Package Managers". Dunebook.com. 2022-02-05.
- ^ "Yarn: A new package manager for JavaScript". Engineering at Meta. 2016-10-11. Retrieved 2021-11-22.
- ^ "Introducing Yarn 2 ! 🧶🌟". DEV Community. 2020-01-24. Retrieved 2025-01-09.
- ^ "Plug'n'Play | Yarn". yarnpkg.com. Retrieved 2025-01-09.
- ^ "Package Manager – NPM and Yarn Explained with Examples". Sitepoint. 2021-09-21.
- ^ "How To Install and Use the Yarn Package Manager for Node.js". DigitalOcean. 2021-08-10.
- ^ "Yarn vs npm: Everything You Need to Know". CodeSweetly. 2023-02-04.