nodejs / package-compliant

Validate the `support` property in the `package.json`

THIS REPO IS ARHIVED.

package-compliant

Validate the support property in the package.json following the package-maintenance guidelines!

⚠ This project has been deprecated. Use @pkgjs/support instead.

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 the package.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!

License

Licensed under MIT.

package-compliant's Issues

cli as a module

Refactor in order to use this tool also as a module, not only as a CLI

Archive the repo

Since this has been superceeded by the support module in the pkgjs org I @Eomm can we archive this repo?

backing as array

Based on the docs the backing field could be an array or a string.

Add CODE_OF_CONDUCT and CONTRIBUTING

To add all the missing docs from this guideline in order to transfer this repo.

Ref nodejs/admin#343

Add CI

Guideline:
https://github.com/nodejs/package-maintenance/blob/8e4483ad6cc638d6af20472ae6af110246946320/docs/drafts/ci-cd-guidelines.md