Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

eslint-plugin-pkg-json

zanminkian184MIT0.4.0TypeScript support: included

ESLint plugin for linting package.json file

eslint, config, eslint-config, eslint-plugin, package-json, packagejson, package, json, node

readme

eslint-plugin-pkg-json

PRs Welcome

ESLint plugin for linting package.json file.

Features

  • Lint package.jsons.
  • Simple. Tiny. Fast.
  • Zero dependencies.

Requirement

  • ESLint >= 8.57.0

Usage

Install

npm i eslint eslint-plugin-pkg-json -D

Config eslint.config.js

import * as pkg from "eslint-plugin-pkg-json";
import parser from 'eslint-plugin-pkg-json/jsonc-eslint-parser';

export default [
  ...
  {
    files: ["**/package.json"],
    languageOptions: {
      parser,
    },
    plugins: { "pkg-json": pkg },
    rules: {
      "pkg-json/no-lifecycle-script": "error",
      ...
      // Visit https://github.com/zanminkian/fenge/tree/main/packages/eslint-plugin-pkg-json/doc/rules for more other rules
    },
  },
  ...
];

Config package.json

{
  "scripts": {
    "lint": "eslint .",
    "lint:fix": "eslint . --fix"
  }
}

Rules

Click here.

License

MIT