https://github.com/tclindner/npm-package-json-lint-config-default

Default npm-package-json-lint shareable config
https://github.com/tclindner/npm-package-json-lint-config-default

linter nodejs npm npm-package npm-package-json-lint

Last synced: 5 days ago
JSON representation

Default npm-package-json-lint shareable config

• Host: GitHub
• URL: https://github.com/tclindner/npm-package-json-lint-config-default
• Owner: tclindner
• License: mit
• Created: 2017-02-18T21:51:37.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-12-04T20:26:23.000Z (about 1 month ago)
• Last Synced: 2024-12-26T23:05:21.294Z (12 days ago)
• Topics: linter, nodejs, npm, npm-package, npm-package-json-lint
• Language: JavaScript
• Homepage:
• Size: 1.92 MB
• Stars: 11
• Watchers: 4
• Forks: 3
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# npm-package-json-lint-config-default

> Default [npm-package-json-lint](https://github.com/tclindner/npm-package-json-lint) shareable config

[![license](https://img.shields.io/github/license/tclindner/npm-package-json-lint-config-default.svg?maxAge=2592000&style=flat-square)](https://github.com/tclindner/npm-package-json-lint-config-default/blob/master/LICENSE)

[![npm](https://img.shields.io/npm/v/npm-package-json-lint-config-default.svg?maxAge=2592000?style=flat-square)](https://www.npmjs.com/package/npm-package-json-lint-config-default)

![ci](https://github.com/tclindner/npm-package-json-lint-config-default/workflows/ci/badge.svg?branch=master)

[![Dependency Status](https://david-dm.org/tclindner/npm-package-json-lint-config-default.svg?style=flat-square)](https://david-dm.org/tclindner/npm-package-json-lint-config-default)

[![devDependency Status](https://david-dm.org/tclindner/npm-package-json-lint-config-default/dev-status.svg?style=flat-square)](https://david-dm.org/tclindner/npm-package-json-lint-config-default#info=devDependencies)

## What is npm-package-json-lint-config-default?

Shared configuration for npm-package-json-lint. Follow the instructions below to easily include this configuration in another project without having to duplicate the file.

## How do I install it?

First thing first, let's make sure you have the necessary pre-requisites.

### System Dependencies

#### Node

* [Node.js](https://nodejs.org/) - v18.0.0+

* [npm](http://npmjs.com) - v9.0.0+

### Command

```bash

npm install npm-package-json-lint-config-default --save-dev

```

## Usage

Add the following to your `.npmpackagejsonlintrc.json` file:

```json

{

  "extends": "npm-package-json-lint-config-default"

}

```

If you need to override a rule, your `.npmpackagejsonlintrc.json` file should look like the example below. All shared rules will be used, but `license-type` will be turned off.

```json

{

  "extends": "npm-package-json-lint-config-default",

  "rules": {

    "license-type": "off"

  }

}

```

## Contributing

Please see [CONTRIBUTING.md](CONTRIBUTING.md).

## Release History

Please see [CHANGELOG.md](CHANGELOG.md).

## License

Copyright (c) 2017-2023 Thomas Lindner. Licensed under the MIT license.