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
Section titled “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 { defineConfig, packageJson } from "flint";
export default defineConfig({ use: [ { files: packageJson.files.all, rules: [packageJson.presets.logical], }, ],});logical
Section titled “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, }, ],});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
Section titled “Selectors”Flint’s package.json plugin will provide the following files selector:
all:**/package.json
Made with ❤️🔥 in Boston by
Josh Goldberg and contributors.