/berry

📦🐈 The active development trunk for Yarn 2 ⚒

Primary LanguageTypeScriptOtherNOASSERTION

Yarn

Fast, reliable, and secure dependency management.

GitHub Actions status Discord Chat Stable Release Prerelease


Yarn is a modern package manager split into various packages. Its novel architecture allows to do things currently impossible with existing solutions:

  • Yarn supports plugins; adding a plugin is as simple as adding it into your repository
  • Yarn supports Node by default but isn't limited to it - plugins can add support for other languages
  • Yarn supports workspaces natively, and its CLI takes advantage of that
  • Yarn uses a portable shell to execute package scripts, guaranteeing they work the same way on Windows and Linux
  • Yarn is first and foremost a Node API that can be used programmatically (via berry-core)
  • Yarn is written in TypeScript, and fully typechecked

Install

Consult the dedicated page for more details.

Documentation

The documentation is being reworked to contain an updated content and a refreshed design, and the most up-to-date version can be found on the repository GitHub pages: yarnpkg.github.io/berry

Generic packages

The following packages are generic and can be used in a variety of purposes (including to implement other package managers, but not only):

Yarn plugins

The following packages are plugins for Berry and can be installed through berry add plugin <plugin-name>. Note that some of them are typically already shipped with the regular Yarn bundles. Such plugins are marked with a star (★).

To create your own plugin, please refer to the documentation.

Yarn packages

The following packages are meant to be used by Yarn itself, and probably won't be useful to other applications:

Build your own bundle

Clone this repository, then run the following commands:

$> yarn build:cli

How it works

After building the CLI your global yarn will immediately start to reflect your local changes. This is because Yarn will pick up the yarnPath settings in this repository's .yarnrc.yml, which is configured to use the newly built CLI if available.

Works out of the box!

Note that no other command is needed! Given that our dependencies are checked-in within the repository (within the .yarn/cache directory), you don't even need to run yarn install. Everything just works right after cloning the project, and is guaranteed to continue to work ten years from now 🙂