1.1.1 • Published 5 years ago
package-compliant v1.1.1
package-compliant
Validate the support
property in the package.json
following the package-maintenance guidelines!
Install
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
Commands
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
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.
Module
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!!
}
})
Contributions
Read the CONTRIBUTING guidelines to start help us!
Add new commands
- Add to
commands
array inlib\index.js
the command name (Ex:awesome
) - Create a
lib/commands/<command name>.js
file that expose this APImodule.exports = function (args) { /* YOUR CODE */ }
- Create a
man/<command name>
file with all the information to run the command - Create a
test/<command name>.test.js
where you test your command
License
Copyright Manuel Spigolon, Licensed under MIT.