Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wayfair/one-version
Implementation of Google’s One Version Rule for JS monorepos
https://github.com/wayfair/one-version
dependencies hacktoberfest javascript js monorepo node pnpm pnpm-workspaces yarn yarn-workspaces
Last synced: 7 days ago
JSON representation
Implementation of Google’s One Version Rule for JS monorepos
- Host: GitHub
- URL: https://github.com/wayfair/one-version
- Owner: wayfair
- License: mit
- Created: 2022-04-29T13:46:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-04T05:20:08.000Z (about 1 month ago)
- Last Synced: 2024-12-25T19:05:04.233Z (14 days ago)
- Topics: dependencies, hacktoberfest, javascript, js, monorepo, node, pnpm, pnpm-workspaces, yarn, yarn-workspaces
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@wayfair/one-version
- Size: 25.4 MB
- Stars: 24
- Watchers: 8
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](CHANGELOG.md)
[](LICENSE)
[](CODE_OF_CONDUCT.md)
[](https://wayfair.github.io)
@wayfair/one-version
One Version to rule them all, One Version to find them,
One Version to bring them all, and in the darkness bind them.1
Opinionated Monorepo Dependency Management CLI
**🚨 Enforcement**: Require all workspaces in a monorepo to conform to the [One-Version rule](#one-version-rule).
**📦 Supports multiple package managers**: Support for `yarn` classic, `yarn` berry, and `pnpm` workspaces.
**💥 Coordinated upgrades**: Coming Soon!
---
## Table Of Contents
- [One-Version Rule](#one-version-rule)
- [Getting Started](#getting-started)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [License](#license)
## One-Version Rule
This package implements a version of Google's `One-Version Rule`:
> For every dependency in [a] repository, there must be only one version of that dependency to choose.2
Please refer to the [implementation notes](ONE-VERSION.md) for our specific evaluation criteria.
There is some overlap between this tool and [experimental yarn constraints](https://yarnpkg.com/features/constraints), without requiring use of a particular package manager.
## Getting Started
Install `@wayfair/one-version` at the workspace root using yarn:
```bash
yarn add --dev -w @wayfair/one-version
```
Or pnpm:
```bash
pnpm add -save-dev -w @wayfair/one-version
```
Add the following section to your package.json:
```json
{
"scripts": {
"one-version:check": "one-version check"
}
}
```
Run `yarn one-version:check` or `pnpm run one-version:check`.
If the repo is compliant, the tool will print this message:
```text
✨ One Version Rule Success - found no version conflicts!
```
If the repo is not compliant, you will see a version of this message:
```text
🚫 One Version Rule Failure - found multiple versions of the following dependencies:
prettier
2.1.2
dev: @wayfair/app-a, @wayfair/app-b
^2.3.2
dev: @wayfair/app-c
2.2.1
dev: @wayfair/lib-a
```
## Configuration
The behavior of `@wayfair/one-version` can be configured by a `one-version.config.json` at the root of the repository.
### Supported Options
#### overrides (optional, object)
Overrides lets workspaces opt out of the one-version rule. This may be useful while performing major upgrades.
### Examples
```json
{
"overrides": {
"dependency": {
"versionSpecifier": ["workspaceA", "workspaceB"]
}
}
}
```
For example, the below config will allow `app-A` and `lib-L` to specify `react@^16.9`, even if the rest of the repo specifies `react@^17`.
```json
{
"overrides": {
"react": {
"^16.9": ["app-A", "lib-L"]
}
}
}
```
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated** 💜. For contributing guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md)
## License
Distributed under the `MIT` License. See `LICENSE` for more information.
---
`1`: J.R.R. Tolkien, 1954. Mostly.
`2`: [Software Engineering At Google](https://abseil.io/resources/swe_at_google.2.pdf) - Winters, Manshreck and Wright, 2020, p. 341