README.md

@ices/check-dependency-engines

A tool for analyzing dependencies.

About

Check engines requirements of the dependency, and find the version of the dependency that meets the minimum engine version requirements of the current project through metadata.

Install

Used as a cli util:

npm i @ices/check-dependency-engines -g

or run without install:

npx @ices/check-dependency-engines

By default, only the dependencies for production will be analyzing, you can use the -D arg to analyze dev dependencies.

Used as a dev util:

npm i @ices/check-dependency-engines -D

Usage

As a cli util:

> check-engines

Options:

• --help, -h Show help
• --version, -v Show version number
• --allow-pre-release, -p Allow match pre-release version
• --exact, -e Use exact version when update
• --disable-auto-install, -t Disable auto install after update
• --update, -u Auto update package.json file
• --cwd, -d Current Working Directory
• --registry, -r Registry url for npm repository
• --development, -D Only update the devDependencies
• --quiet, -q Disable the logs

As a package:

;(async () => {
  const Checker = require('@ices/check-dependency-engines')
  const ck = new Checker({
    cwd: process.cwd(), // current working dir
    registry: 'https://registry.some.domain', // npm registry for download metadata
    preRelease: false, // should match pre-release version of dependency
    exact: true, // should use exact version when update matched version of dependency
    update: true, // should auto update package.json when there ara some changes
    log: 'log', // can be a string as log level (log、warn、error) or a function, or false to disable.
    development: false, // set only run with devDependencies.
  })
  const data = await ck.verify()
  // the data is an object that contains all dependency info.
})()

Author

@ices/check-dependency-engines © Stone, Released under the MIT License.