PACKAGE_JSON_PRIVATE_REQUIREDPACKAGE_JSON_SIDE_EFFECTS_REQUIRED
Requires that every package.json file has the sideEffects field set to ensure tree-shaking works optimally.Conformance is available on Enterprise plans
This check ensures that every package.json has a sideEffects field.
The sideEffects field is required for shared packages. This field helps bundlers
make assumptions about packages that improve tree shaking, or pruning
files that aren't used and don't have any global side effects.
See https://webpack.js.org/guides/tree-shaking/ for more information.
- PACKAGE_JSON_NAME_REQUIRED
- PACKAGE_JSON_DESCRIPTION_REQUIRED
- PACKAGE_JSON_PRIVATE_REQUIRED
- PACKAGE_JSON_TYPE_REQUIRED
The sideEffects field should be set to false unless the code in that workspace has
global side effects, in which case it should be set to true or an array of glob
patterns for files that do have side effects.
Last updated on March 4, 2025
Was this helpful?