You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Renames everything to the yarnpkg scope
* More renaming
* Fixes snapshots
* Updates the README
* Fixes the merge conflict resolution test
* Updates the documentation
Copy file name to clipboardexpand all lines: README.md
+18-18
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Yarn is a modern package manager split into various packages. Its novel architec
23
23
- Yarn supports Node by default but isn't limited to it - plugins can add support for other languages
24
24
- Yarn supports [workspaces](https://yarnpkg.github.io/berry/features/workspaces) natively, and its CLI takes advantage of that
25
25
- Yarn uses a portable shell to execute package scripts, guaranteeing they work the same way on Windows and Linux
26
-
- Yarn is first and foremost a Node API that can be used programmatically (via [@berry/core](packages/berry-core))
26
+
- Yarn is first and foremost a Node API that can be used programmatically (via [@yarnpkg/core](packages/yarnpkg-core))
27
27
- Yarn is written in TypeScript, and fully typechecked
28
28
29
29
## Install
@@ -47,8 +47,8 @@ On top of our classic integration tests, we also run Yarn every day against the
47
47
48
48
Clone this repository, then run the following commands:
49
49
50
-
```
51
-
$> yarn build:cli
50
+
```bash
51
+
yarn build:cli
52
52
```
53
53
54
54
**How it works**
@@ -68,21 +68,21 @@ Those plugins typically come bundled with Yarn. You don't need to do anything sp
68
68
-[★ plugin-constraints](packages/plugin-constraints) adds support for `yarn constraints check` and `yarn constraints fix`.
69
69
-[★ plugin-dlx](packages/plugin-dlx) adds support for the [`yarn dlx`](https://yarnpkg.github.io/berry/cli/dlx) command.
70
70
-[★ plugin-essentials](packages/plugin-essentials) adds various commands deemed necessary for a package manager (add, remove, ...).
71
-
-[★ plugin-file](packages/plugin-file) adds support for using `file:`references as dependencies.
71
+
-[★ plugin-file](packages/plugin-file) adds support for using the `file:`protocol within your dependencies.
72
72
-[★ plugin-github](packages/plugin-github) adds support for using Github references as dependencies. [This plugin doesn't use git.](https://stackoverflow.com/a/13636954/880703)
73
73
-[★ plugin-http](packages/plugin-http) adds support for using straight URL references as dependencies (tgz archives only).
74
74
-[★ plugin-init](packages/plugin-init) adds support for the [`yarn init`](https://yarnpkg.github.io/berry/cli/init) command.
75
75
-[★ plugin-link](packages/plugin-link) adds support for using `link:` and `portal:` references as dependencies.
76
-
-[★ plugin-npm](packages/plugin-npm) adds support for using [semver ranges]() as dependencies, resolving them to an NPM-like registry.
77
-
-[★ plugin-npm-cli](packages/plugin-npm-cli) adds support for the NPM-specific commands (`yarn npm login`, [`yarn npm publish`](https://yarnpkg.github.io/berry/cli/npm/publish), ...).
76
+
-[★ plugin-npm](packages/plugin-npm) adds support for using [semver ranges](https://semver.org) as dependencies, resolving them to an NPM-like registry.
77
+
-[★ plugin-npm-cli](packages/plugin-npm-cli) adds support for the NPM-specific commands ([`yarn npm login`](https://yarnpkg.github.io/berry/cli/npm/login), [`yarn npm publish`](https://yarnpkg.github.io/berry/cli/npm/publish), ...).
78
78
-[★ plugin-pack](packages/plugin-pack) adds support for the [`yarn pack`](https://yarnpkg.github.io/berry/cli/pack) command.
79
79
-[★ plugin-pnp](packages/plugin-pnp) adds support for installing Javascript dependencies through the [Plug'n'Play](https://yarnpkg.github.io/berry/features/pnp) specification.
80
80
81
81
### Contrib plugins
82
82
83
-
Although developed on the same repository as Yarn itself, those plugins are optionals and need to be explicitly installed through `yarn plugin import @berry/<plugin-name>`.
83
+
Although developed on the same repository as Yarn itself, those plugins are optionals and need to be explicitly installed through `yarn plugin import @yarnpkg/<plugin-name>`.
84
84
85
-
-[☆ plugin-exec](packages/plugin-exec) adds support for using `exec:`references as dependencies.
85
+
-[☆ plugin-exec](packages/plugin-exec) adds support for using the `exec:`protocol within your dependencies.
86
86
-[☆ plugin-stage](packages/plugin-pack) adds support for the [`yarn stage`](https://yarnpkg.github.io/berry/cli/stage) command.
87
87
-[☆ plugin-typescript](packages/plugin-typescript) improves the user experience when working with TypeScript.
88
88
-[☆ plugin-workspace-tools](packages/plugin-workspace-tools) adds support for the [`yarn workspaces foreach`](https://yarnpkg.github.io/berry/cli/workspaces/foreach) command.
@@ -99,18 +99,18 @@ To create your own plugin, please refer to the [documentation](https://yarnpkg.g
99
99
100
100
The following packages are generic and can be used in a variety of purposes (including to implement other package managers, but not only):
101
101
102
-
-[@berry/core](packages/berry-core) allows any application to manipulate a project programmatically.
103
-
-[@berry/fslib](packages/berry-fslib) is a set of tools to efficiently abstract filesystem accesses.
104
-
-[@berry/json-proxy](packages/berry-json-proxy) allows to temporarily convert any POD object to an immutable object.
105
-
-[@berry/libzip](packages/berry-libzip) contains zlib+libzip bindings compiled to WebAssembly.
106
-
-[@berry/parsers](packages/berry-parsers) can be used to parse [Syml]() and the language used by [berry-shell](packages/berry-shell).
107
-
-[@berry/pnp](packages/berry-pnp) can be used to generate [Plug'n'Play](https://yarnpkg.github.io/berry/features/pnp)-compatible hooks.
108
-
-[@berry/pnpify](packages/berry-pnpify) is a CLI tool to transparently add PnP support to various tools.
109
-
-[@berry/shell](packages/berry-shell) is a portable bash-like shell interpreter.
102
+
-[@yarnpkg/core](packages/yarnpkg-core) allows any application to manipulate a project programmatically.
103
+
-[@yarnpkg/fslib](packages/yarnpkg-fslib) is a set of tools to abstract the filesystem through type-safe primitives.
104
+
-[@yarnpkg/json-proxy](packages/yarnpkg-json-proxy) allows to temporarily convert any POD object to an immutable object.
105
+
-[@yarnpkg/libzip](packages/yarnpkg-libzip) contains zlib+libzip bindings compiled to WebAssembly.
106
+
-[@yarnpkg/parsers](packages/yarnpkg-parsers) can be used to parse the language used by [@yarnpkg/shell](packages/yarnpkg-shell).
107
+
-[@yarnpkg/pnp](packages/yarnpkg-pnp) can be used to generate [Plug'n'Play](https://yarnpkg.github.io/berry/features/pnp)-compatible hooks.
108
+
-[@yarnpkg/pnpify](packages/yarnpkg-pnpify) is a CLI tool to transparently add PnP support to various tools.
109
+
-[@yarnpkg/shell](packages/yarnpkg-shell) is a portable bash-like shell interpreter.
110
110
111
111
## Yarn packages
112
112
113
113
The following packages are meant to be used by Yarn itself, and probably won't be useful to other applications:
114
114
115
-
-[@berry/builder](packages/berry-builder) contains a CLI tool to package berry and its plugins.
116
-
-[@berry/cli](packages/berry-cli) is a CLI entry point built on top of [@berry/core](packages/berry-core).
115
+
-[@yarnpkg/builder](packages/yarnpkg-builder) contains a CLI tool to package berry and its plugins.
116
+
-[@yarnpkg/cli](packages/yarnpkg-cli) is a CLI entry point built on top of [@yarnpkg/core](packages/yarnpkg-core).
0 commit comments