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.

Flint recommends using the logical preset:

import { 
function defineConfig(definition: ConfigDefinition): Config
Defines a new linter configuration for a Flint config file.
@see ― https://flint.fyi/configuration flint.fyi/configuration
defineConfig, 
const packageJson: Plugin<RuleAbout, "all", []>
packageJson } from "flint";

export default 
function defineConfig(definition: ConfigDefinition): Config
Defines a new linter configuration for a Flint config file.
@see ― https://flint.fyi/configuration flint.fyi/configuration
defineConfig({
  
ConfigDefinition.use: ConfigUseDefinition[]
Specifies the files to be linted alongside the rules and settings to lint with.
@see ― https://flint.fyi/configuration#use flint.fyi/configuration#use
use: [
    {
      
ConfigUseDefinition.files: AnyLevelDeep<FilesValue>
A list of glob patterns describing which file(s) to lint.
@see ― https://flint.fyi/configuration#files flint.fyi/configuration#files
files: 
const packageJson: Plugin<RuleAbout, "all", []>
packageJson.
Plugin<RuleAbout, "all", []>.files: Record<"all", FilesValue>
Selectors of files this plugin suggests applying its rules to.
@see ― https://flint.fyi/glossary#files flint.fyi/glossary#files
files.
all: FilesValue
all,
      
ConfigUseDefinition.rules: AnyLevelDeep<ConfigRuleDefinition>
Any number of rules and/or presets of rules to enable for those files.
@see ― https://flint.fyi/configuration#rules flint.fyi/configuration#rules
rules: [
const packageJson: Plugin<RuleAbout, "all", []>
packageJson.
Plugin<RuleAbout, "all", []>.presets: PluginPresets<RuleAbout, never>
Preset lists of rules to enable on files.
@see ― https://flint.fyi/glossary#preset flint.fyi/glossary#preset
presets.
any
logical],
    },
  ],
});

`logical`

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

import { 
function defineConfig(definition: ConfigDefinition): Config
Defines a new linter configuration for a Flint config file.
@see ― https://flint.fyi/configuration flint.fyi/configuration
defineConfig, 
const packageJson: Plugin<RuleAbout, "all", []>
packageJson } from "flint";

export default 
function defineConfig(definition: ConfigDefinition): Config
Defines a new linter configuration for a Flint config file.
@see ― https://flint.fyi/configuration flint.fyi/configuration
defineConfig({
  
ConfigDefinition.use: ConfigUseDefinition[]
Specifies the files to be linted alongside the rules and settings to lint with.
@see ― https://flint.fyi/configuration#use flint.fyi/configuration#use
use: [
    {
      
ConfigUseDefinition.files: AnyLevelDeep<FilesValue>
A list of glob patterns describing which file(s) to lint.
@see ― https://flint.fyi/configuration#files flint.fyi/configuration#files
files: 
const packageJson: Plugin<RuleAbout, "all", []>
packageJson.
Plugin<RuleAbout, "all", []>.files: Record<"all", FilesValue>
Selectors of files this plugin suggests applying its rules to.
@see ― https://flint.fyi/glossary#files flint.fyi/glossary#files
files.
all: FilesValue
all,
      
ConfigUseDefinition.rules: AnyLevelDeep<ConfigRuleDefinition>
Any number of rules and/or presets of rules to enable for those files.
@see ― https://flint.fyi/configuration#rules flint.fyi/configuration#rules
rules: 
const packageJson: Plugin<RuleAbout, "all", []>
packageJson.
Plugin<RuleAbout, "all", []>.presets: PluginPresets<RuleAbout, never>
Preset lists of rules to enable on files.
@see ― https://flint.fyi/glossary#preset flint.fyi/glossary#preset
presets.
any
logical,
    },
  ],
});

Rules

Implemented: 0 of 51 (0%)

Flint Rule	Preset
`authorValidity`	logical
`binValidity`	logical
`bundleDependenciesValidity`	logical
`configValidity`	logical
`cpuValidity`	logical
`dependenciesValidity`	logical
`dependencyUniqueness`	logical
`descriptionPresence`	logical
`descriptionValidity`	logical
`devDependenciesValidity`	logical
`directoriesValidity`	logical
`emptyFields`	logical
`exportsValidity`	logical
`filesRedundancy`	logical
`filesValidity`	logical
`homepageValidity`	logical
`keywordsValidity`	logical
`licenseRequired`	logical
`licenseValidity`	logical
`mainValidity`	logical
`manValidity`	logical
`namePresence`	logical
`nameValidity`	logical
`optionalDependenciesValidity`	logical
`osValidity`	logical
`peerDependenciesValidity`	logical
`privateValidity`	logical
`propertyOrdering`	logical
`publishConfigValidity`	logical
`repositoryDirectoryValidity`	logical
`repositoryShorthand`	logical
`repositoryValidity`	logical
`scriptsValidity`	logical
`typePresence`	logical
`typeRequired`	logical
`typeValidity`	logical
`versionPresence`	logical
`versionValidity`	logical
`workspacesValidity`	logical
`authorPresence`	(none)
`bugsPresence`	(none)
`bundleDependenciesPresence`	(none)
`dependenciesPresence`	(none)
`dependencyRanges`	(none)
`devDependenciesPresence`	(none)
`enginesPresence`	(none)
`filesPresence`	(none)
`keywordsPresence`	(none)
`optionalDependenciesPresence`	(none)
`peerDependenciesPresence`	(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.