5393616209
Add developer doc to explain how contributors and developers on the team should treat the `package.json` file now that `angular-cli` in a mixed mode of yarn workspaces and Bazel.
1.4 KiB
Yarn Workspaces
The package architecture of angular-cli repository is originally setup using
yarn workspaces. This means the
dependencies of various package.json in the repository are linked and
installed together.
Bazel
Since then, Bazel was introduced to manage some of the build dependencies in
angular-cli repo. However, Bazel does not yet support yarn workspaces,
since it requires laying out more than one node_modules directory. In this
mixed mode, developers ought to take extra care to synchronize the dependencies.
Since the yarn_install rule that installs all NPM dependencies in this
repository only reads from the root package.json, every Bazel target that
depends on packages downloaded from the NPM registry will need to have the
dependency declared in the root package.json.
In addition, if the dependency is also needed at runtime (non-dev dependencies),
the dependency on the individual package's package.json has to be updated as
well. This is to ensure that when users download a published version from NPM,
they will be able to install all dependencies correctly without Bazel. It is the
responsibility of the developer to keep both package.json in sync.
Issues
- Yarn workspaces is not compatible with Bazel-managed deps (#12736)