Getting started

publint is a linter that checks npm packages to ensure the widest compatibility across environments, such as Vite, Webpack, Rollup, Node.js, etc. It also reports best practices and common configuration mistakes that aim to improve the overall quality of the package.

Check out the comparisons page to see how publint differs from other tools.

Usage

The easiest way to use publint is through publint.dev (this website!). Search for an npm package, paste an npm link, or paste a pkg.pr.new link to start linting the package.

You can also run publint locally with npx publint, which performs the checks as a CLI. See the CLI page for more information.

npm

npx publint

pnpm

pnpm dlx publint

yarn

yarn dlx publint

Local requirements

When running publint locally, it requires Node.js >=18 and only supports these package managers:

• npm (v9, v10, v11)
• yarn (v3, v4)
• pnpm (v8, v9, v10)
• bun

Older versions of these package managers may still work, but they're not officially tested. Yarn 1 is also explicitly not supported. See the troubleshooting page for more information.

Local installation

You can install publint locally if you prefer to integrate it in your publish or CI workflow. First, install publint with your package manager:

npm

npm install --save-dev publint

pnpm

pnpm add --save-dev publint

yarn

yarn add --dev publint

Then, setup a script to execute publint in your package.json:

{
  "scripts": {
    "lint:package": "publint"
  }
}

You can then call the script with your package manager:

npm

npm run lint:package

pnpm

pnpm lint:package

yarn

yarn lint:package

If you'd like to lint a package in a different directory, you can pass the path as an argument, like publint ./dir. See the CLI page for more information.

If you'd like to use publint programmatically, check out the JavaScript API page.

TIP

If the package has a build step, it must be run first before running publint so that it can lint against the files to be published.

Community integration

publint can also be used through different tools below:

Name	Description
vscode-publint	A VSCode extension to lint package.json with publint. (Marketplace)
renoma	A recursive node_modules analyzer with opinionated package health checks. Run npx renoma --filter-rules publint to run publint on all packages.