THIS REPO IS ARHIVED.
Validate the support
property in the package.json
following the package-maintenance guidelines!
โ This project has been deprecated. Use @pkgjs/support
instead.
You can use this package as a CLI or as a Module if you need to use the core function of this module.
// As a CLI
npm i package-compliant -g
// As a module
npm i package-compliant
To run the commands you can execute:
package-compliant validate --file ./package-custom.json
// or simply in a project folder
package-compliant validate
// npx is supported of course
npx package-compliant validate
package-compliant validate [--file|-f <file path>]
Validation applied:
- โ Validate
support
property of the JSON--file
if it exists. The default--file
is thepackage.json
in the directory where the command is executed.
To use this package as a module you need to:
const packageCompliant = require('package-compliant')
const aPackageJson = require('./package.json')
try {
packageCompliant.validateSupportField(aPackageJson.support)
// the package is valid
} catch (err) {
// the package has some errors
}
// or you can use callback:
packageCompliant.validateSupportField(aPackageJson.support, (err, valid) => {
if (err) {
// there are some errors!!
}
})
Read the CONTRIBUTING guidelines to start help us!
Licensed under MIT.