Rules for consistent, readable, and valid package.json files. ๐๏ธ
See Getting Started for details.
๐ผ Configurations enabled in.
โ
Set in the recommended configuration.
๐ฆ Set in the recommended-publishable configuration.
๐จ Set in the stylistic configuration.
๐ง Automatically fixable by the --fix CLI option.
๐ก Manually fixable by editor suggestions.
| Nameย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย | Description | ๐ผ | ๐ง | ๐ก |
|---|---|---|---|---|
| bin-name-casing | Enforce that names for bin properties are in kebab case. | ๐จ | ๐ก | |
| exports-subpaths-style | Enforce consistent format for the exports field (implicit or explicit subpaths). | ๐จ | ๐ง | |
| no-empty-fields | Reports on unnecessary empty arrays and objects. | โ ๐ฆ | ๐ก | |
| no-local-dependencies | Requires that dependencies do not use local file paths, which will likely result in errors when installing from a registry. | |||
| no-redundant-files | Prevents adding unnecessary / redundant files. | โ ๐ฆ | ๐ก | |
| no-redundant-publishConfig | Warns when publishConfig.access is used in unscoped packages. | โ ๐ฆ | ๐ก | |
| order-properties | Enforces that package properties are declared in a consistent order. | ๐จ | ๐ง | |
| repository-shorthand | Enforce either object or shorthand declaration for repository. | โ ๐ฆ | ๐ง | |
| require-attribution | Ensures that proper attribution is included, requiring that either author or contributors is defined, and that if contributors is present, it should include at least one contributor. |
โ ๐ฆ | ๐ก | |
| restrict-dependency-ranges | Restricts the range of dependencies to allow or disallow specific types of ranges. | ๐ก | ||
| restrict-private-properties | Disallows unnecessary properties in private packages. | ๐ง | ๐ก | |
| restrict-top-level-properties | Disallows specified top-level properties in package.json. | ๐ก | ||
| scripts-name-casing | Enforce that names for scripts are in kebab case (optionally separated by colons). |
๐จ | ๐ก | |
| sort-collections | Selected collections must be in a consistent order (lexicographical for most; lifecycle-aware for scripts). | โ ๐ฆ | ๐ง | |
| specify-peers-locally | Requires that all peer dependencies are also declared as dev dependencies | โ ๐ฆ | ๐ก | |
| unique-dependencies | Checks a dependency isn't specified more than once (i.e. in dependencies and devDependencies) |
โ ๐ฆ | ๐ก | |
| valid-peerDependenciesMeta-relationship | Enforces that any dependencies declared in peerDependenciesMeta are also defined in the package's peerDependencies. |
โ ๐ฆ | ๐ก | |
| valid-repository-directory | Enforce that if repository directory is specified, it matches the path to the package.json file | โ ๐ฆ | ๐ก |
This group of rules allows you to require that the associated top-level property must be present in the package.json.
| Name | Description | ๐ผ | ๐ง | ๐ก |
|---|---|---|---|---|
| require-author | Requires the author property to be present. |
|||
| require-bin | Requires the bin property to be present. |
|||
| require-browser | Requires the browser property to be present. |
|||
| require-bugs | Requires the bugs property to be present. |
|||
| require-bundleDependencies | Requires the bundleDependencies property to be present. |
|||
| require-config | Requires the config property to be present. |
|||
| require-contributors | Requires the contributors property to be present. |
|||
| require-cpu | Requires the cpu property to be present. |
|||
| require-dependencies | Requires the dependencies property to be present. |
|||
| require-description | Requires the description property to be present. |
โ ๐ฆ | ||
| require-devDependencies | Requires the devDependencies property to be present. |
|||
| require-devEngines | Requires the devEngines property to be present. |
|||
| require-directories | Requires the directories property to be present. |
|||
| require-engines | Requires the engines property to be present. |
|||
| require-exports | Requires the exports property to be present. |
โ ๐ฆ | ||
| require-files | Requires the files property to be present. |
โ ๐ฆ | ||
| require-funding | Requires the funding property to be present. |
|||
| require-gypfile | Requires the gypfile property to be present. |
|||
| require-homepage | Requires the homepage property to be present. |
|||
| require-keywords | Requires the keywords property to be present. |
|||
| require-libc | Requires the libc property to be present. |
|||
| require-license | Requires the license property to be present. |
โ ๐ฆ | ||
| require-main | Requires the main property to be present. |
|||
| require-man | Requires the man property to be present. |
|||
| require-module | Requires the module property to be present. |
|||
| require-name | Requires the name property to be present. |
โ ๐ฆ | ||
| require-optionalDependencies | Requires the optionalDependencies property to be present. |
|||
| require-os | Requires the os property to be present. |
|||
| require-packageManager | Requires the packageManager property to be present. |
|||
| require-peerDependencies | Requires the peerDependencies property to be present. |
|||
| require-peerDependenciesMeta | Requires the peerDependenciesMeta property to be present. |
|||
| require-private | Requires the private property to be present. |
๐ง | ||
| require-publishConfig | Requires the publishConfig property to be present. |
|||
| require-repository | Requires the repository property to be present. |
โ ๐ฆ | ||
| require-scripts | Requires the scripts property to be present. |
|||
| require-sideEffects | Requires the sideEffects property to be present. |
โ ๐ฆ | ||
| require-type | Requires the type property to be present. |
โ ๐ฆ | ๐ง | |
| require-types | Requires the types property to be present. |
|||
| require-version | Requires the version property to be present. |
โ ๐ฆ |
This group of rules allows you to enforce that the value of the associated top-level property is valid. All of these rules are include in the recommended config.
| Nameย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย | Description | ๐ผ | ๐ง | ๐ก |
|---|---|---|---|---|
| valid-author | Enforce that the author property is valid. |
โ ๐ฆ | ||
| valid-bin | Enforce that the bin property is valid. |
โ ๐ฆ | ||
| valid-browser | Enforce that the browser property is valid. |
โ ๐ฆ | ||
| valid-bugs | Enforce that the bugs property is valid. |
โ ๐ฆ | ||
| valid-bundleDependencies | Enforce that the bundleDependencies (also bundledDependencies) property is valid. |
โ ๐ฆ | ||
| valid-config | Enforce that the config property is valid. |
โ ๐ฆ | ||
| valid-contributors | Enforce that the contributors property is valid. |
โ ๐ฆ | ||
| valid-cpu | Enforce that the cpu property is valid. |
โ ๐ฆ | ||
| valid-dependencies | Enforce that the dependencies property is valid. |
โ ๐ฆ | ||
| valid-description | Enforce that the description property is valid. |
โ ๐ฆ | ||
| valid-devDependencies | Enforce that the devDependencies property is valid. |
โ ๐ฆ | ||
| valid-devEngines | Enforce that the devEngines property is valid. |
โ ๐ฆ | ||
| valid-directories | Enforce that the directories property is valid. |
โ ๐ฆ | ||
| valid-engines | Enforce that the engines property is valid. |
โ ๐ฆ | ||
| valid-exports | Enforce that the exports property is valid. |
โ ๐ฆ | ||
| valid-files | Enforce that the files property is valid. |
โ ๐ฆ | ||
| valid-funding | Enforce that the funding property is valid. |
โ ๐ฆ | ||
| valid-gypfile | Enforce that the gypfile property is valid. |
โ ๐ฆ | ||
| valid-homepage | Enforce that the homepage property is valid. |
โ ๐ฆ | ||
| valid-keywords | Enforce that the keywords property is valid. |
โ ๐ฆ | ||
| valid-libc | Enforce that the libc property is valid. |
โ ๐ฆ | ||
| valid-license | Enforce that the license property is valid. |
โ ๐ฆ | ||
| valid-main | Enforce that the main property is valid. |
โ ๐ฆ | ||
| valid-man | Enforce that the man property is valid. |
โ ๐ฆ | ||
| valid-module | Enforce that the module property is valid. |
โ ๐ฆ | ||
| valid-name | Enforce that the name property is valid. |
โ ๐ฆ | ||
| valid-optionalDependencies | Enforce that the optionalDependencies property is valid. |
โ ๐ฆ | ||
| valid-os | Enforce that the os property is valid. |
โ ๐ฆ | ||
| valid-packageManager | Enforce that the packageManager property is valid. |
โ ๐ฆ | ||
| valid-peerDependencies | Enforce that the peerDependencies property is valid. |
โ ๐ฆ | ||
| valid-peerDependenciesMeta | Enforce that the peerDependenciesMeta property is valid. |
โ ๐ฆ | ||
| valid-private | Enforce that the private property is valid. |
โ ๐ฆ | ||
| valid-publishConfig | Enforce that the publishConfig property is valid. |
โ ๐ฆ | ||
| valid-repository | Enforce that the repository property is valid. |
โ ๐ฆ | ||
| valid-scripts | Enforce that the scripts property is valid. |
โ ๐ฆ | ||
| valid-sideEffects | Enforce that the sideEffects property is valid. |
โ ๐ฆ | ||
| valid-type | Enforce that the type property is valid. |
โ ๐ฆ | ||
| valid-version | Enforce that the version property is valid. |
โ ๐ฆ | ||
| valid-workspaces | Enforce that the workspaces property is valid. |
โ ๐ฆ |
These rules only run on package.json files; they will ignore all other files being linted.
They can lint package.json files at project root and in any subfolder of the project, making this plugin great for monorepos.
We never want to remove things, when we're building them! But the reality is that libraries evolve and deprecations are a fact of life. Following are the different timeframes that we've defined as it relates to deprecating APIs in this project.
When some aspect of our API is going to be deprecated (and eventually removed), it must initially go through an RFC phase. Whoever's motivating the removal of the api, should create an RFC issue explaining the proposal and inviting feedback from the community. That RFC should remain active for at least 6 weeks. The RFC text should make clear what the target date is for closing the RFC. Once the RFC period is over, if the removal is still moving forward, the API(s) should be officially deprecated.
Once an API has been marked as deprecated, it will remain intact for at least 6 months. After 6 months from the date of deprecation, the API is subject to removal.
See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md.
Thanks! ๐
See the LICENSE file for license rights and limitations (MIT).