Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/motea927/peer-gear
Checks the peer dependencies of the current Node.js package and offers solutions for any unmet dependencies.
https://github.com/motea927/peer-gear
peer-dependencies yarn
Last synced: about 6 hours ago
JSON representation
Checks the peer dependencies of the current Node.js package and offers solutions for any unmet dependencies.
- Host: GitHub
- URL: https://github.com/motea927/peer-gear
- Owner: motea927
- License: mit
- Created: 2024-02-07T02:18:23.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-02-20T09:57:34.000Z (9 months ago)
- Last Synced: 2024-11-15T21:39:05.238Z (4 days ago)
- Topics: peer-dependencies, yarn
- Language: TypeScript
- Homepage:
- Size: 184 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚙️ peer-gear
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
[![Codecov][codecov-src]][codecov-href]
Forked from [check-peer-dependencies](https://github.com/christopherthielen/check-peer-dependencies)
Checks the peer dependencies of the current Node.js package and offers solutions for any unmet dependencies.
> **Note**:
> Before proceeding, make sure to run `yarn install` to install all the necessary dependencies.
###### Changes in this fork
- The package is renamed to `peer-gear`, allowing you to use `npx peer-gear` directly.
- Removed npm options because `npm 7` and later versions will [automatically install peer dependencies](https://github.com/npm/rfcs/blob/main/implemented/0025-install-peer-deps.md).
- Refactored some code to make test writing easier.
- Added unit tests for more robustness.
- Added `--includePrerelease` option. Note that includePrerelease is disabled by default.
## Usage
```bash
npx peer-gear [--install] [--help]
```
Options:
```
-h, --help Print usage information [boolean]
--version Show version number [boolean]
--orderBy Order the output by depender or dependee
[choices: "depender", "dependee"] [default: "dependee"]
--debug Print debugging information
[boolean] [default: false]
--verbose Prints every peer dependency, even those that
are met [boolean] [default: false]
--ignore package name to ignore (may specify multiple)
[array] [default: []]
--runOnlyOnRootDependencies Run tool only on package root dependencies
[boolean] [default: false]
--findSolutions Search for solutions and print package
installation commands
[boolean] [default: false]
--install Install missing or incorrect peerDependencies
[boolean] [default: false]
--includePrerelease Include prerelease versions when searching
for solutions
[boolean] [default: false]
```
## Development
- Clone this repository
- Install latest LTS version of [Node.js](https://nodejs.org/en/)
- Install dependencies using `yarn install`
- Run interactive tests using `yarn dev`
## License
Made with 💛
Published under [MIT License](./LICENSE).
[npm-version-src]: https://img.shields.io/npm/v/peer-gear?style=flat&colorA=18181B&colorB=F0DB4F
[npm-version-href]: https://npmjs.com/package/peer-gear
[npm-downloads-src]: https://img.shields.io/npm/dm/peer-gear?style=flat&colorA=18181B&colorB=F0DB4F
[npm-downloads-href]: https://npmjs.com/package/peer-gear
[codecov-src]: https://img.shields.io/codecov/c/gh/motea927/peer-gear/main?style=flat&colorA=18181B&colorB=F0DB4F
[codecov-href]: https://codecov.io/gh/motea927/peer-gear
[bundle-src]: https://img.shields.io/bundlephobia/minzip/peer-gear?style=flat&colorA=18181B&colorB=F0DB4F
[bundle-href]: https://bundlephobia.com/result?p=peer-gear