⚙️ peer-gear

Forked from 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.
• 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

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
• Install dependencies using yarn install
• Run interactive tests using yarn dev

License

Made with 💛

Published under MIT License.