Skip to content

joaopalmeiro/npm-package-json-lint-config-package

Repository files navigation

npm-package-json-lint-config-package

Shareable npm-package-json-lint configuration for packages.

Getting Started

Installation

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

or

yarn add --dev npm-package-json-lint-config-package

or

pnpm add --save-dev npm-package-json-lint-config-package

or

bun add --dev npm-package-json-lint-config-package

Usage

To use this configuration, choose one of the options below.

Edit the package.json file

{
  "npmpackagejsonlint": {
    "extends": "npm-package-json-lint-config-package"
  }
}

Create a .npmpackagejsonlintrc.json file

{
  "extends": "npm-package-json-lint-config-package"
}

Check the npm-package-json-lint documentation or the @stylelint/npm-package-json-lint-config package to learn how to override this configuration.

Development

Install fnm (if necessary).

fnm install && fnm use && node --version && npm --version
npm install
npm run lint
npm run format

Deployment

npm pack --dry-run
npm version patch
npm version minor
npm version major
  • Update the version in the Licenses link at the top.
  • Commit and push changes.
  • Create a tag on GitHub Desktop.
  • Check GitHub.
npm login
npm publish