Skip to content

Commit

Permalink
Mention pnpm workspaces in readme (#589)
Browse files Browse the repository at this point in the history
  • Loading branch information
bmish authored May 11, 2023
1 parent 689a79f commit 07675fe
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![npm version][npm-image]][npm-url]
[![CI][ci-image]][ci-url]

This CLI tool enforces the following aspects of consistency across a monorepo with npm or Yarn workspaces:
This CLI tool enforces the following aspects of consistency across a monorepo with npm / pnpm / Yarn workspaces:

1. Dependencies are on consistent versions. For example, every package in a workspace that has a dependency on `eslint` should specify the same version for it.
2. Dependencies on local packages use the local packages directly instead of older versions of them. For example, if one package `package1` in a workspace depends on another package `package2` in the workspace, `package1` should request the current version of `package2`.
Expand Down Expand Up @@ -130,6 +130,7 @@ Found 2 dependencies with mismatching versions across the workspace. Fix with `-
## References

* [npm workspaces](https://docs.npmjs.com/cli/using-npm/workspaces)
* [pnpm workspaces](https://pnpm.io/pnpm-workspace_yaml)
* [Yarn workspaces](https://classic.yarnpkg.com/lang/en/docs/workspaces/)

[npm-image]: https://badge.fury.io/js/check-dependency-version-consistency.svg
Expand Down

0 comments on commit 07675fe

Please sign in to comment.