package-compliant

KO | EN

gitlite — search

#javascript #hacktoberfest #react #ai #golang #deep-learning #linux #macos #java #windows #vue #awesome-list #mcp #openai

package-compliant

(★ 9)

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

package-compliant Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

THIS REPO IS ARHIVED.

# package-compliant

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![Build Status](https://travis-ci.com/Eomm/package-compliant.svg?branch=master)](https://travis-ci.com/Eomm/package-compliant)

Validate the `support` property in the `package.json` following the [package-maintenance guidelines][validation]!

⚠ This project has been deprecated. Use [`@pkgjs/support`](https://github.com/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:

```sh
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

```sh
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:

```js
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](./CONTRIBUTING.md) guidelines to start help us!

## License

Licensed under [MIT](./LICENSE).

[validation]: https://raw.githubusercontent.com/nodejs/package-maintenance/781a6bb752f4928e9e5e916b10ba38eb5289f316/docs/drafts/Baseline%20practive%20-%20Document%20support%20levels.md

package-compliant

package-compliant Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

package-compliant

package-compliant Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README