🔥 Torch It

A powerful, all-in-one, zero-dependency, fully customizable tool to reset, clean, and rebuild your Node.js (and optionally Dockerized) project environments with a single command.

---

Project stopped working for no obvious reason 😠 ?

You'd like to kick it 🥾?
Hit it with a hammer 🔨?
Turn it off and on again 📺?

Well better still - try torching it 🔥🔥🔥🔥🔥🔥

What does torch-it do?

Intelligently nukes your local caches, dependencies, and Docker environment depending on your framework and package manager — then rebuilds everything from a clean slate, with a single command.

It's surprising how often this just fixes things. 🤞

Features

• One command to clean up 50+ build artifacts, cache directories, log files, and reinstall dependencies
• Comprehensive framework support — handles React, Next.js, Vue, Vite, SvelteKit, Remix, Qwik, Nuxt, Astro, Angular, Solid, and 40+ more
• Smart file pattern matching — removes *.log, *.tgz, *.tar.gz, and other temporary files automatically
• Fully customizable — specify any directories or files to delete via torchrc.json
• Docker support — removes containers, images, and volumes and rebuilds from scratch 🐳
• Cross-platform — works on Windows, Linux, and macOS
• Zero-dependency — lightweight and no additional packages required

Supported Frameworks

React, Next.js, Vue, Vite, SvelteKit, React Native, Expo, Remix, Qwik, Nuxt, Astro, Angular, Solid, Docusaurus, and 40+ more frameworks and tools.

Comprehensive Cleanup Targets

torch-it cleans up 50+ common build artifacts, cache directories, and temporary files:

Framework Build Outputs

• dist, build, out, .output - Standard build directories
• .next - Next.js build cache
• .nuxt - Nuxt.js build output
• .svelte-kit, .svelte - Svelte/SvelteKit builds
• .remix - Remix framework build output
• .qwik - Qwik framework build output
• .astro - Astro framework build output
• .angular, .angular/cache - Angular build artifacts
• .solid - Solid.js build output
• .docusaurus - Docusaurus static site output
• .nitro - Nuxt Nitro server output

Development Tool Caches

• .cache, .parcel-cache, .webpack, .rollup.cache - Build tool caches
• .vite - Vite build tool cache
• .swc, .rpt2_cache - JavaScript transpiler caches
• .eslintcache, .stylelintcache, .sass-cache - Linter/preprocessor caches
• .babel-cache, .cache-loader - Babel and webpack loader caches

Package Manager Caches

• node_modules/.cache - npm package cache
• .npm - npm global cache
• .pnpm-store, .pnpm-debug.log - pnpm caches
• .yarn/cache, .yarn/unplugged, .yarn/install-state.gz - Yarn caches

Monorepo & Build Tools

• .turbo - Turborepo cache
• .nx/cache - Nx build system cache
• .lerna - Lerna monorepo cache
• .rush - Rush monorepo cache
• .yalc - Yalc local package manager

Blockchain & Web3 Tools

• .hardhat - Hardhat Ethereum development
• .foundry - Foundry Ethereum development
• .anchor - Anchor Solana development

Deployment & Platform Files

• .vercel - Vercel deployment cache
• .netlify - Netlify build cache
• .wrangler - Cloudflare Workers
• .amplify - AWS Amplify
• .sst - SST framework
• .firebase - Firebase hosting files
• .serverless - Serverless framework

Mobile Development

• android/.gradle, android/build, android/app/build - Android builds
• ios/Pods, ios/build - iOS builds
• .expo, .expo-shared - Expo React Native

File Patterns

• *.log - All log files
• *.tgz, *.tar.gz - Compressed archives
• tsconfig.tsbuildinfo - TypeScript incremental build info
• coverage, .nyc_output - Test coverage reports
• storybook-static, .storybook-out - Storybook builds

Temporary Files

• .tmp, tmp, temp - Temporary directories
• lib, es, cjs, umd - Compiled JavaScript outputs
• jspm_packages, .typings - Package manager files

Supported Package Managers

npm · yarn · pnpm

Core Operations (Always Performed)

• Removes build artifacts and cache directories for 50+ JavaScript/Node.js frameworks and tools (e.g., node_modules, dist, .next, .cache, .vite, .remix, .qwik, etc.).
• Removes log files and temporary artifacts including *.log, *.tgz, *.tar.gz, and build info files.
• Removes custom directories/paths that you define in torchrc.json.
• Cleans package manager caches for npm, yarn, and pnpm.
• Reinstalls dependencies using your preferred package manager (npm, yarn, or pnpm).

Docker Operations (Only if Docker is Configured)

If your project includes either a Dockerfile, docker-compose.yml, or docker-compose.yaml, torch-it will also:

• Stop and clean up Docker resources (containers, images, volumes) if Docker is running.
• Rebuild Docker images from scratch.
• Restart Docker services in detached mode.

torch-it intelligently detects your project's configuration and only performs Docker operations when appropriate.

---

Usage

Global Installation (Recommended)

Install torch-it globally to run it from anywhere:

npm install -g torch-it

Then, in your project root,simply run:

torch-it

For per-project customisation, create a torchrc.json file in your project root (see Customization section below) or use command line flags (see Command Line Options section below).

Per-Project Installation (Alternative)

If you prefer to install torch-it per project:

npm install torch-it --save-dev

Then run via npm scripts or npx:

Add to package.json scripts:

{
  "scripts": {
    "torch": "torch-it"
  }
}

npm run torch

Or directly:

npx torch-it

Dry Run (--test)

Use --test to preview what torch-it would do without deleting directories, cleaning caches, installing dependencies, or changing Docker resources. Results are saved to the torch-it.log file.

torch-it --test

Configuration (--config)

Use --config to display the current torch-it configuration, including all files and directories that will be targeted for deletion during a torch-it run. This is useful for verifying your setup before performing actual cleanup operations.

torch-it --config

The configuration display shows:

• Current settings from torchrc.json (if present) or defaults
• All built-in cleanup targets
• Custom paths that will be removed
• Protected paths that will be preserved
• Docker and rebuild operation settings

This helps you understand exactly what will be affected before running torch-it, making it easier to verify your configuration is correct.

---

Customization

For project-level customization, create a local torchrc.json file in your project root with the following structure:

{
  "customPaths": ["apps/web/.next", "services/api/tmp", ".turbo/cache", "coverage-final.json"],
  "protectedPaths": ["important-data/", "config/production.json"],
  "dockerMode": true,
  "rebuild": true,
  "logfile": true
}

• customPaths: Array of additional directories and files to remove during cleanup. Supports both directories and files. torch-it will remove these in the same cleanup pass as the built-in targets.
• protectedPaths: Array of directories and files to skip during cleanup. These paths will be preserved even if they match built-in or custom cleanup targets.
• dockerMode: Boolean flag to enable/disable Docker operations. Set to false to skip all Docker cleanup, rebuild, and launch steps. Defaults to true.
• rebuild: Boolean flag to enable/disable rebuild operations. Set to false to skip both package manager dependency installation and Docker rebuild/launch while still performing cleanup. Defaults to true.
• logfile: Boolean flag to enable or disable writing runtime output to torch-it.log. Set to true to enable file logging. Defaults to false.

Note: The local torchrc.json file is completely optional. torch-it works with sensible defaults out of the box. Only create this file if you need to customize the behavior.

Command Line Options

You can override torchrc.json settings directly from the command line using flags. This is useful for one-off runs or CI/CD pipelines.

torch-it --dockerMode=false --rebuild=false --customPaths=["temp/","logs/"]

All configuration options can be overridden using --optionName=value syntax. For arrays and objects, use JSON syntax:

• --help - Show help message and available options
• --version, -v - Show version information and exit
• --config - Show current configuration and exit
• --test - Run in dry-run mode (preview changes without executing)
• --customPaths=["path1","path2"]
• --dockerMode=false
• --rebuild=false
• --logfile=true

Command line flags take precedence over torchrc.json settings.

The config option --config will show all current settings including those from command line flags and a list of all files and directories that will be cleaned in the current project.

Logging

torch-it outputs information to the console. By default, no log file is written. If you want to save runtime output to torch-it.log in your project root for troubleshooting purposes, set logfile to true in torchrc.json.

This file should be ignored by git to avoid accidental commits. Add this to your .gitignore:

torch-it.log

Troubleshooting

• If you see errors related to Docker, check:
  1. Is Docker installed and running?
  2. Does your project have Docker configuration files?
  3. Are your Docker configuration files valid?
• If you see errors about missing package.json, initialize your project with npm init -y or add your project files.
• For detailed information about any failures, check the torch-it.log file.

---

License

MIT

---

Happy torching! 🔥✨