PackageJSON Plugin

Rules for linting Node.js package.json manifest files in repositories and workspaces.
This plugin comes packaged with the flint npm package.

Presets

Flint’s package.json plugin provides the following preset:

Preset	Recommended	Description
`logical`	✅ Always	Common rules for finding bugs and good practices in package.json files.
`stylistic`	✅ Always	Common rules for consistent styling and best stylistic practices.

Flint recommends using the logical and stylistic presets:

import { defineConfig, packageJson } from "flint";

export default defineConfig({
  use: [
    {
      files: packageJson.files.all,
      rules: [packageJson.presets.logical, packageJson.presets.stylistic],
    },
  ],
});

`logical`

Rules that find bugs and enforce best practices and prevent common pitfalls for most-to-all package.json files.

import { defineConfig, packageJson } from "flint";

export default defineConfig({
  use: [
    {
      files: packageJson.files.all,
      rules: packageJson.presets.logical,
    },
  ],
});

`stylistic`

Rules that enforce consistent styling and best stylistic practices for most-to-all package.json files.

import { defineConfig, packageJson } from "flint";

export default defineConfig({
  use: [
    {
      files: packageJson.files.all,
      rules: packageJson.presets.stylistic,
    },
  ],
});

Rules

Implemented: 0 of 77 (0%)

Flint Rule	Preset
`attribution`	logical
`authorValidity`	logical
`binValidity`	logical
`bundleDependenciesValidity`	logical
`configValidity`	logical
`contributorsValidity`	logical
`cpuValidity`	logical
`dependenciesValidity`	logical
`dependencyUniqueness`	logical
`descriptionPresence`	logical
`descriptionValidity`	logical
`devDependenciesValidity`	logical
`directoriesValidity`	logical
`emptyFields`	logical
`enginesValidity`	logical
`exportsPresence`	logical
`exportsValidity`	logical
`filesRedundancy`	logical
`filesValidity`	logical
`homepageValidity`	logical
`keywordsValidity`	logical
`licensePresence`	logical
`licenseValidity`	logical
`manValidity`	logical
`moduleValidity`	logical
`namePresence`	logical
`nameValidity`	logical
`optionalDependenciesValidity`	logical
`osValidity`	logical
`peerDependenciesInstallation`	logical
`peerDependenciesValidity`	logical
`privateValidity`	logical
`propertyOrdering`	logical
`publishConfigRedundancy`	logical
`publishConfigValidity`	logical
`repositoryDirectoryValidity`	logical
`repositoryPresence`	logical
`repositoryShorthand`	logical
`repositoryValidity`	logical
`scriptsValidity`	logical
`sideEffectsPresence`	logical
`sideEffectsValidity`	logical
`typePresence`	logical
`typeValidity`	logical
`versionPresence`	logical
`versionValidity`	logical
`workspacesValidity`	logical
`binNameCasing`	stylistic
`exportsSubpathsStyle`	stylistic
`scriptsNameCasing`	stylistic
`authorPresence`	(none)
`binPresence`	(none)
`bugsPresence`	(none)
`bundleDependenciesPresence`	(none)
`configPresence`	(none)
`contributorsPresence`	(none)
`cpuPresence`	(none)
`dependenciesPresence`	(none)
`dependencyRanges`	(none)
`devDependenciesPresence`	(none)
`directoriesPresence`	(none)
`enginesPresence`	(none)
`filesPresence`	(none)
`fundingPresence`	(none)
`keywordsPresence`	(none)
`mainPresence`	(none)
`manPresence`	(none)
`modulePresence`	(none)
`optionalDependenciesPresence`	(none)
`osPresence`	(none)
`packageManagerPresence`	(none)
`peerDependenciesPresence`	(none)
`privatePackageProperties`	(none)
`privatePresence`	(none)
`publishConfigPresence`	(none)
`scriptsPresence`	(none)
`typesPresence`	(none)

Selectors

Flint’s package.json plugin will provide the following files selector:

all: **/package.json

Made with ❤️‍🔥 around the world by the Flint team and contributors.