npm-package-json-lint-config-bconnorwhite

1.0.0 verified Fri May 01 auth: no javascript

Shared npm-package-json-lint configuration preset by bconnorwhite. Version 1.0.0 requires npm-package-json-lint ^9.1.0 as a peer dependency. Supports Bun ^1.3.0 and Node ^24.0.0 || ^26.0.0. Ships TypeScript types. Provides a base preset for private packages and an OSS variant that adds public-package requirements (author, homepage, bugs). The config is extended via the "extends" field in npm-package-json-lint's configuration.

Common errors

error Error: Cannot find module 'npm-package-json-lint-config-bconnorwhite' ↓

cause The package is not installed, or the peer dependency is missing.

fix

Install the package: npm install --save-dev npm-package-json-lint-config-bconnorwhite

error Error: Unable to load config file: /path/to/.npmpackagejsonlintrc.js Reason: The 'extends' property must refer to a valid npm-package-json-lint config package or file. ↓

cause The extends value is misspelled or the config package is not installed.

fix

Ensure extends is exactly "npm-package-json-lint-config-bconnorwhite" and the package is installed.

error TypeError: Cannot read properties of undefined (reading 'rules') ↓

cause npm-package-json-lint is not installed or version <9.1.0

fix

Install npm-package-json-lint@^9.1.0 as a dev dependency.

Warnings

gotcha Peer dependency npm-package-json-lint ^9.1.0 must be installed separately. If not present, the lint command will fail. ↓

fix Run: npm install --save-dev npm-package-json-lint@^9.1.0

gotcha The submodule path '/oss' is not a separate npm package; it's a file within the package. Ensure your require path is correct. ↓

fix Use require('npm-package-json-lint-config-bconnorwhite/oss') instead of require('npm-package-json-lint-config-bconnorwhite-oss')

deprecated Engines specify Node ^24.0.0 || ^26.0.0 and Bun ^1.3.0, which are very modern. Older Node versions (e.g., 18, 20) are unsupported. ↓

fix Upgrade Node to 24+ or use an older version of this config (if available).

Install

npm install npm-package-json-lint-config-bconnorwhite

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

pnpm add npm-package-json-lint-config-bconnorwhite

Imports

baseConfig
wrong
```
import config from 'npm-package-json-lint-config-bconnorwhite'
```
correct
```
const config = require('npm-package-json-lint-config-bconnorwhite')
```
This package is meant to be used in a CommonJS config file (e.g., .npmpackagejsonlintrc.js). The default export is the base preset for private packages.

ossConfig

wrong

import { oss } from 'npm-package-json-lint-config-bconnorwhite'

correct

const ossConfig = require('npm-package-json-lint-config-bconnorwhite/oss')

The OSS preset is available as a submodule file; it adds public-package rules. Access via require with path '/oss'.

extends
wrong
```
"extends": "bconnorwhite"
```
correct
```
"extends": "npm-package-json-lint-config-bconnorwhite"
```
In your package.json or .npmpackagejsonlintrc, set the 'extends' property to the package name (or package name + '/oss' for OSS rules).

Quickstart

Shows how to extend the base config in a lint config file and run the linter.

// Create a .npmpackagejsonlintrc.js file:
module.exports = {
  extends: 'npm-package-json-lint-config-bconnorwhite'
};
// Then run:
// npx npm-package-json-lint package.json
// For OSS variant:
// module.exports = {
//   extends: 'npm-package-json-lint-config-bconnorwhite/oss'
// };