PACKAGE_JSON_DESCRIPTION_REQUIRED
Requires that every package.json file has the description field set.Conformance is available on Enterprise plans
This check ensures that every package.json
has a description
field.
This field is used to describe the workspace's purpose within the monorepo.
See the Node.js docs for more information.
- PACKAGE_JSON_NAME_REQUIRED
- PACKAGE_JSON_PRIVATE_REQUIRED
- PACKAGE_JSON_TYPE_REQUIRED
- PACKAGE_JSON_SIDE_EFFECTS_REQUIRED
Add the description
field to the package.json
file that explains
what the package does and when it should be used.
Last updated on March 4, 2025
Was this helpful?