validate /ˈvalɪdeɪt/
This package can be used to validate if all defined engine versions in the package.json file are matched.
There are different ways to use this package.
You can use this package by adding the following entry to your
package.json
and force npm
or yarn
to ensure that all
engine requirements are matched before it starts installing
your dependencies. There's no need to add this package to your
dependencies.
{
"scripts": {
"preinstall": "npx valideit"
}
}
It is also possible to use this package as dependency in your project and use its functionality inside your code like the following example is showing.
const valideit = require('valideit');
valideit.validate();
By installing this package globally it is possible use it as cli tool as described in the following example.
$ npm install -g valideit
$ valideit
The following arguments can be passed via CLI or also to the preinstall hook.
--path, -p file to check engines from [string]
--warn, -w doesn't abort on error [boolean]
You can also pass those arguments as a Javascript object to the function call.
const valideit = require('valideit');
valideit.validate({
level: 'warn',
path: '/path/to/package.json'
});