From 75870c615c20b043e99fb78b449e6ed860cccf70 Mon Sep 17 00:00:00 2001 From: Anthony Shew Date: Tue, 30 Jul 2024 20:12:18 -0600 Subject: [PATCH] (docs): Mention sideEffects key in Internal Packages documentation. (#8888) ### Description Addresses #6513 --- docs/repo-docs/core-concepts/internal-packages.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/repo-docs/core-concepts/internal-packages.mdx b/docs/repo-docs/core-concepts/internal-packages.mdx index 7cc30e5f36cc1..5c806ef708559 100644 --- a/docs/repo-docs/core-concepts/internal-packages.mdx +++ b/docs/repo-docs/core-concepts/internal-packages.mdx @@ -126,7 +126,7 @@ Compiling your library produces compiled JavaScript outputs into a directory (`d #### Limitations and tradeoffs - **Using the TypeScript compiler**: The majority of Compiled Packages should use `tsc`. Since the package is highly likely to be consumed by an application that is using a bundler, the application's bundler will prepare the library package for distribution in the application's final bundles, handling polyfilling, downleveling, and other concerns. A bundler should only be used if you have a specific use case that requires it, like bundling static assets into your package's outputs. -- **More configuration**: Compiled Packages require deeper knowledge and configuration to create build outputs. There are [many configurations for the TypeScript compiler](https://www.typescriptlang.org/docs/handbook/compiler-options.html#compiler-options) that can be difficult to manage and understand. You can find some of our recommendations in [our dedicated TypeScript guide](/repo/docs/guides/tools/typescript). +- **More configuration**: Compiled Packages require deeper knowledge and configuration to create build outputs. There are [many configurations for the TypeScript compiler](https://www.typescriptlang.org/docs/handbook/compiler-options.html#compiler-options) that can be difficult to manage and understand, and further configuration to optimize for bundlers, like [the `sideEffects` key in `package.json`](https://webpack.js.org/guides/tree-shaking/#mark-the-file-as-side-effect-free). You can find some of our recommendations in [our dedicated TypeScript guide](/repo/docs/guides/tools/typescript). ### Publishable packages