Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.47 KB

README.md

File metadata and controls

50 lines (32 loc) · 1.47 KB
Raw

NPMprune

npmprune.sh is an lightweight script designed to clean up your node_modules directory by removing unnecessary files like Markdown, doc and config files.

It helps in reducing the overall size of node_modules, optimizing storage space, and speeding up deployments, especially in containerized environments.

By detecting NODE_ENV, it can perform a more aggressive cleanup, tailored for production builds such as in Docker containers.

  1. Install
  2. Usage
  3. Integration
  4. Compatibility

Install

wget -O /usr/local/bin/npmprune https://raw.githubusercontent.com/xthezealot/npmprune/master/npmprune.sh && chmod +x /usr/local/bin/npmprune

Usage

npmprune

Production mode

If the NODE_ENV environment variable is set to production, NPMprune performs a more extensive cleanup by also removing type definitions.

Integration

In deployment scripts

wget -qO- https://raw.githubusercontent.com/xthezealot/npmprune/master/npmprune.sh | sh

In a Dockerfile

RUN wget -qO- https://raw.githubusercontent.com/xthezealot/npmprune/master/npmprune.sh | sh

Compatibility

NPMprune is compatible with both Linux and macOS environments, even with the most basic Alpine Linux setup.