@architect/arc-macro-node-prune

@architect/arc-macro-node-prune

Node.js-specific Architect macro based on node-prune that cleans node_modules cruft from your Functions during deployment

Warning

Pruning your node_modules tree(s) has some inherent risks. While we have found it to be stable and reliable, the packages your project uses may provide different results.

For example: while unlikely, a package that includes and makes use of a file with a commonly .npmignored filename may be impacted by this pruner. For a list of files and folders that are pruned, please review the pruner script source.

Installation

• Run: npm i @architect/arc-macro-node-prune

• Then add the following to your Architect project file (usually .arc):

@macros
architect/arc-macro-node-prune

Note, no @ in the macro name!

• Deploy your project (npx deploy) and watch the filesizes drop 📉

Results

In practice, we have seen average filesize and file count reductions of about 25-30% across the board. That's a meaningful number for cloud functions!

Disabling the macro

If for whatever reason you need to disable the macro, simply comment it out in (or remove it from) your Architect project file:

@macros
# architect/arc-macro-node-prune

Limitations

• Architect supports shared code by selectively copying src/shared and src/views into all Functions' node_modules dirs by default.
  • Because this macro runs just prior to deployment, it must avoid Architect shared code dirs so as not to inadvertently destroy user files.
  • As such, any node_modules folders within src/shared or src/views will not be pruned.
• This macro relies on shelling out to a bash script, so ymmv on Windows.

Changelog

[1.0.0] 2020-03-08

Added

• Architect node-prune is now a v6-compatible macro
  • Ported from the now-deprecated v5-compatible plugin
  • Fixes @arc-plugin-node-prune#7; thanks to @alexbepple for the kick in the pants!
• Improved file counting and formatting of output along the way

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.