1 min read

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.
Table of Contents

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.

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 February 22, 2024