Tools - npm-package-json-lint configuration

Shared npm-package-json-lint configuration for JavaScript projects.

Table of contents

• How to install
  • Rules
• How to use
• Author

How to install

Run the following command to install the required dependencies:

$ <yarn|npm|pnpm> add -D @jpapini/npm-package-json-lint-config npm-package-json-lint

Add the following fields to your package.json:

{
    "scripts": {
        "lint:pkglint": "npmPkgJsonLint ."
    },
    "npmpackagejsonlint": {
        "extends": "@jpapini/npm-package-json-lint-config"
    }
}

Rules

| Rule name | Description | | ------------------------------------------------------------ | ---------------------------------------------------------------- | | @jpapini/npm-package-json-lint-config | Rules for private single repo project (e.g. React application). | | @jpapini/npm-package-json-lint-config/single-public | Rules for public single repo project (under MIT license). | | @jpapini/npm-package-json-lint-config/single-private-package | Rules for private single repo package (e.g. Single NPM package). | | @jpapini/npm-package-json-lint-config/single-public-package | Rules for public single repo package (under MIT license). | | @jpapini/npm-package-json-lint-config/monorepo-private | Rules for private monorepo project (e.g. Multiple NPM packages). | | @jpapini/npm-package-json-lint-config/monorepo-public | Rules for public monorepo project (under MIT license). |

How to use

Run pnpm run lint:pkglint for linting package.json files.

Author

• Julien Papini [email protected]