docs: add documentation for exclude patterns (#2132)

Mivr · web-flow · commit fbb245615778 · 2025-03-13T08:31:49.000-07:00
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -162,6 +162,27 @@ This can lead to builds performing slower due to IO throttling, or even failing
 
 If you are experiencing slower than expected builds, you can try disabling or reducing parallelism for the tools you are using.
 
+### Unnecessary npm package content
+
+Npm packages sometimes include unnecessary files such as tests, test data etc. Large files or a large number of files
+can effect performance and are sometimes worth explicitly excluding content.
+
+In these cases you can add such packages and the respective files/folders you want to exclude to your npm_translate_lock
+rule in the `exclude_package_contents` attribute like so:
+
+```starlark
+npm.npm_translate_lock(
+    ...
+    exclude_package_contents = {
+        "resolve": ["**/test/*"],
+    },
+)
+```
+
+This example will remove the test folder.
+
+You can use this to remove whatever you find to be not needed for your project.
+
 #### Jest
 
 See [rules_jest](https://github.com/aspect-build/rules_jest) specific [troubleshooting](https://docs.aspect.build/rulesets/aspect_rules_jest/docs/troubleshooting#performance).
