torch-it 2.2.0 → 2.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -16
- package/dist/torch-it.js +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -18,7 +18,7 @@ Well better still - try torching it 🔥🔥🔥🔥🔥🔥
|
|
|
18
18
|
|
|
19
19
|
## What does `torch-it` do?
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
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**.
|
|
22
22
|
|
|
23
23
|
It's surprising how often this just fixes things. 🤞
|
|
24
24
|
|
|
@@ -28,7 +28,7 @@ It's surprising how often this just fixes things. 🤞
|
|
|
28
28
|
- **Fully customizable** — specify any directories or files to delete
|
|
29
29
|
- **Docker support** — removes containers, images, and volumes and rebuilds from scratch 🐳
|
|
30
30
|
- **Cross-platform** — works on Windows, Linux, and macOS
|
|
31
|
-
- **Zero-dependency** — no additional packages required
|
|
31
|
+
- **Zero-dependency** — lightweight and no additional packages required
|
|
32
32
|
|
|
33
33
|
## Supported Frameworks
|
|
34
34
|
|
|
@@ -59,32 +59,47 @@ If your project includes either a `Dockerfile`, `docker-compose.yml`, or `docker
|
|
|
59
59
|
|
|
60
60
|
## Usage
|
|
61
61
|
|
|
62
|
-
###
|
|
62
|
+
### Global Installation (Recommended)
|
|
63
|
+
|
|
64
|
+
Install torch-it globally to run it from anywhere:
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
npm install -g torch-it
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Then, in your project root,simply run:
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
torch-it
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
For per-project customisation, create a `torchrc.json` file in your project root (see Customization section below).
|
|
77
|
+
|
|
78
|
+
### Per-Project Installation (Alternative)
|
|
79
|
+
|
|
80
|
+
If you prefer to install torch-it per project:
|
|
63
81
|
|
|
64
82
|
```bash
|
|
65
83
|
npm install torch-it --save-dev
|
|
66
84
|
```
|
|
67
85
|
|
|
68
|
-
|
|
86
|
+
Then run via npm scripts or npx:
|
|
69
87
|
|
|
70
|
-
Add
|
|
88
|
+
Add to package.json scripts:
|
|
71
89
|
|
|
72
90
|
```json
|
|
73
91
|
{
|
|
74
92
|
"scripts": {
|
|
75
|
-
"torch": "torch-it"
|
|
76
|
-
"torch:test": "torch-it --test"
|
|
93
|
+
"torch": "torch-it"
|
|
77
94
|
}
|
|
78
95
|
}
|
|
79
96
|
```
|
|
80
97
|
|
|
81
|
-
Then run:
|
|
82
|
-
|
|
83
98
|
```bash
|
|
84
99
|
npm run torch
|
|
85
100
|
```
|
|
86
101
|
|
|
87
|
-
|
|
102
|
+
Or directly:
|
|
88
103
|
|
|
89
104
|
```bash
|
|
90
105
|
npx torch-it
|
|
@@ -92,34 +107,36 @@ npx torch-it
|
|
|
92
107
|
|
|
93
108
|
### Dry Run (`--test`)
|
|
94
109
|
|
|
95
|
-
Use `--test` to preview what `torch-it` would do without deleting directories, cleaning caches, installing dependencies, or changing Docker resources.
|
|
110
|
+
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.
|
|
96
111
|
|
|
97
112
|
```bash
|
|
98
|
-
|
|
113
|
+
torch-it --test
|
|
99
114
|
```
|
|
100
115
|
---
|
|
101
116
|
## Customization
|
|
102
117
|
|
|
103
|
-
For project-level customization
|
|
118
|
+
For project-level customization, create a local `torchrc.json` file in your project root with the following structure:
|
|
104
119
|
|
|
105
120
|
```json
|
|
106
121
|
{
|
|
107
122
|
"customPaths": ["apps/web/.next", "services/api/tmp", ".turbo/cache", "coverage-final.json"],
|
|
108
123
|
"protectedPaths": ["important-data/", "config/production.json"],
|
|
109
|
-
"dockerMode": true
|
|
124
|
+
"dockerMode": true,
|
|
125
|
+
"logfile": false
|
|
110
126
|
}
|
|
111
127
|
```
|
|
112
128
|
|
|
113
129
|
- `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.
|
|
114
130
|
- `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.
|
|
115
131
|
- `dockerMode`: Boolean flag to enable/disable Docker operations. Set to `false` to skip all Docker cleanup, rebuild, and launch steps. Defaults to `true`.
|
|
132
|
+
- `logfile`: Boolean flag to enable or disable writing runtime output to `torch-it.log`. Set to `false` to disable file logging. Defaults to `true`.
|
|
116
133
|
|
|
117
|
-
**Note**: The `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.
|
|
134
|
+
**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.
|
|
118
135
|
|
|
119
136
|
|
|
120
137
|
## Logging
|
|
121
138
|
|
|
122
|
-
`torch-it` outputs information to the console and writes logs to `torch-it.log` in your project root so you can troubleshoot any issues and see what was removed and reinstalled.
|
|
139
|
+
`torch-it` outputs information to the console and writes logs to `torch-it.log` in your project root by default so you can troubleshoot any issues and see what was removed and reinstalled. If you set `logfile` to `false` in `torchrc.json`, no log file will be written.
|
|
123
140
|
|
|
124
141
|
This file should be ignored by git to avoid accidental commits. Add this to your `.gitignore`:
|
|
125
142
|
|
package/dist/torch-it.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
"use strict";var
|
|
3
|
-
`)};function
|
|
4
|
-
${t.PURPLE("\u25B6")} ${t.BOLD(e)}${t.RESET("")}`;break;default:s=e}console.log(s),
|
|
2
|
+
"use strict";var V=Object.create;var I=Object.defineProperty;var Q=Object.getOwnPropertyDescriptor;var Z=Object.getOwnPropertyNames;var ee=Object.getPrototypeOf,oe=Object.prototype.hasOwnProperty;var ne=(e,n,s,l)=>{if(n&&typeof n=="object"||typeof n=="function")for(let i of Z(n))!oe.call(e,i)&&i!==s&&I(e,i,{get:()=>n[i],enumerable:!(l=Q(n,i))||l.enumerable});return e};var R=(e,n,s)=>(s=e!=null?V(ee(e)):{},ne(n||!e||!e.__esModule?I(s,"default",{value:e,enumerable:!0}):s,e));var y=R(require("fs"));var h=(e,n)=>s=>`\x1B[${e}m${s}\x1B[${n}m`,t={BOLD:h("1","22"),CYAN:h("36","39"),GREEN:h("32","39"),RED:h("31","39"),YELLOW:h("33","39"),PURPLE:h("35","39"),RESET:e=>`\x1B[0m${e}`},r={INFO:"\u{1F525}",SUCCESS:"\u2705",FAIL:"\u274C",EXCLAMATION:"\u2757",WARN:"\u26A0\uFE0F",ROCKET:"\u{1F525}",CLEAN:"\u{1F525}",PHOENIX:"\u{1F525}",BUILD:"\u{1F528}",TARGET:"\u{1F525}",CELEBRATE:"\u{1F525}",STARS:"\u2728",BOX:"\u{1F4E6}",CLIPBOARD:"\u{1F4CB}",DOCKER:"\u{1F433}"};var O=R(require("fs")),L=!0;function se(e){let n=new RegExp("\x1B\\[[0-9;]*m","g");return e.replace(n,"")}var w=e=>{L=e},v=()=>{L&&O.default.writeFileSync("torch-it.log","")},k=e=>{if(!L)return;let n=se(e).replace(/^\n/,""),s=new Date().toISOString();O.default.appendFileSync("torch-it.log",`[${s}] ${n}
|
|
3
|
+
`)};function o(e,n){let s;switch(n){case"info":s=`${t.CYAN(r.INFO)} ${t.BOLD(e)}${t.RESET("")}`;break;case"success":s=`${t.GREEN(r.SUCCESS)} ${e}${t.RESET("")}`;break;case"warn":s=`${t.YELLOW(r.WARN)} ${e}${t.RESET("")}`;break;case"fail":s=`${t.RED(r.FAIL)} ${e}${t.RESET("")}`;break;case"step":s=`
|
|
4
|
+
${t.PURPLE("\u25B6")} ${t.BOLD(e)}${t.RESET("")}`;break;default:s=e}console.log(s),k(s)}function P(){D([` ${r.TARGET} TORCH LIT ${r.ROCKET}`],t.PURPLE);let e=`
|
|
5
5
|
) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) )
|
|
6
6
|
(( (( (( (( (( (( (( (( (( (( (( (( (( ((
|
|
7
7
|
) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) )
|
|
@@ -12,4 +12,4 @@ ${t.PURPLE("\u25B6")} ${t.BOLD(e)}${t.RESET("")}`;break;default:s=e}console.log(
|
|
|
12
12
|
| _ \\| | | | |_) | \\| || || \\| | | _
|
|
13
13
|
| |_) | |_| | _ <| |\\ || || |\\ | |_| |
|
|
14
14
|
|____/ \\___/|_| \\_\\_| \\_|___|_| \\_|\\____|
|
|
15
|
-
`;console.log(e),
|
|
15
|
+
`;console.log(e),k(e)}function F(){console.log(""),D([` ${r.PHOENIX} RISING FROM THE ASHES ${r.PHOENIX}`],t.PURPLE)}function x(e){let n=new RegExp("\x1B\\[[0-9;]*m","g");return e.replace(n,"").length}function D(e,n=t.GREEN){let s=Math.max(56,...e.map(i=>x(i))),l=n("\u2550".repeat(s));console.log(n("\u2554"+l+"\u2557")),e.forEach(i=>{if(k(i),i.trim()==="")console.log(n("\u2551"+" ".repeat(s)+"\u2551"));else{let g=s-x(i);console.log(n("\u2551"+i+" ".repeat(g)+"\u2551"))}}),console.log(n("\u255A"+l+"\u255D"))}var _=require("child_process"),U=R(require("os"));function c(e,n={}){try{return(0,_.execSync)(e,{stdio:n.silent?"pipe":"inherit"}),!0}catch{return n.silent||o(`Command failed: ${e}`,"fail"),!1}}function a(e){try{return U.platform()==="win32"?(0,_.execSync)(`where ${e}`,{stdio:"ignore"}):(0,_.execSync)(`command -v ${e}`,{stdio:"ignore"}),!0}catch{return!1}}var m=R(require("fs"));var B=["node_modules","dist","build",".svelte-kit",".svelte",".next",".nuxt","out",".output",".vercel",".netlify",".astro",".angular",".angular/cache",".solid",".docusaurus",".vite",".cache",".parcel-cache",".webpack",".rollup.cache",".rpt2_cache",".swc",".eslintcache",".stylelintcache",".sass-cache",".tmp","tmp","temp","coverage",".nyc_output","storybook-static",".storybook-out",".turbo",".rush",".firebase",".serverless","android/.gradle","android/build","android/app/build","ios/Pods","ios/build",".expo",".expo-shared","lib","es","cjs","umd"],K=[".pnpm-store",".pnpm-debug.log",".yarn/cache",".yarn/unplugged",".yarn/install-state.gz",".yarn/build-state.yml",".npm","node_modules/.cache"],M=[];var f={customPaths:[],customDirs:[],customFiles:[],protectedPaths:[],dockerMode:!0,logfile:!0};var re=()=>{let e="torchrc.json";if(!m.existsSync(e))return{};try{return JSON.parse(m.readFileSync(e,"utf8"))}catch{return o("Invalid torchrc.json (must be valid JSON) - skipping custom config","warn"),{}}},p=()=>{let e=re();return{customPaths:e.customPaths??f.customPaths,customDirs:e.customDirs??f.customDirs,customFiles:e.customFiles??f.customFiles,protectedPaths:e.protectedPaths??f.protectedPaths,dockerMode:e.dockerMode??f.dockerMode,logfile:e.logfile??f.logfile}},te=()=>{let e=p();return[...e.customPaths,...e.customDirs,...e.customFiles].filter(s=>typeof s=="string").map(s=>s.trim()).filter(s=>s.length>0)},H=()=>{let e=process.env.TORCH_DRY_RUN==="1",n=0,s=p(),l=te(),i=s.protectedPaths,g=[...new Set([...B,...K,...M])],S=[...new Set(l)],$=g.filter(u=>!i.some(C=>u===C||u.startsWith(C+"/"))),b=S.filter(u=>!i.some(C=>u===C||u.startsWith(C+"/"))),A=u=>{if(m.existsSync(u)){o(`${e?"Would remove":"Removing"} ${u}...`,"step");try{e||m.rmSync(u,{recursive:!0,force:!0}),o(`${u} ${e?"marked for removal (dry-run)":"removed"}`,"success"),n++}catch{o(`Failed to remove ${u}`,"fail")}}};o("Scanning for build artifacts and cache directories...","step"),$.forEach(A),b.length>0&&(o("Deleting user defined custom directories and files","step"),b.forEach(A));let N=g.length-$.length+(S.length-b.length);return N>0&&o(`Skipped ${N} protected path(s) from torchrc.json`,"info"),n===0?(o("No build artifacts or cache directories found (project already clean)","info"),!1):(o(`Removed ${n} build/cache directories`,"success"),!0)},Y=()=>{let e=process.env.TORCH_DRY_RUN==="1",n=!1;return a("npm")&&(e||c("npm cache clean --force"))&&(o(e?"Dry-run: would clean npm cache":"npm cache cleaned","success"),n=!0),a("yarn")&&(e||c("yarn cache clean"))&&(o(e?"Dry-run: would clean yarn cache":"yarn cache cleaned","success"),n=!0),a("pnpm")&&(e||c("pnpm store prune"))&&(o(e?"Dry-run: would clean pnpm store":"pnpm store cleaned","success"),n=!0),n||o("No package manager caches cleaned (tools not available)","info"),n};function j(){return y.existsSync("Dockerfile")||y.existsSync("docker-compose.yml")||y.existsSync("docker-compose.yaml")}function G(){if(p().dockerMode===!1)return o("Docker mode disabled in torchrc.json - skipping Docker operations","info"),"NO_DOCKER";let n=process.env.TORCH_DRY_RUN==="1";return j()?(o("Stopping Docker services and removing all resources...","info"),a("docker")?c("docker info",{silent:!0})?c("docker compose ps",{silent:!0})?n?(o("Dry-run: would run 'docker compose down --rmi all --volumes'","info"),"OK"):c("docker compose down --rmi all --volumes")?(o("Docker services stopped and resources cleaned","success"),"OK"):(o("Docker cleanup encountered issues","warn"),o("Continuing with the rest of the script...","info"),"DOCKER_FAIL"):(o("No Docker Compose services found - skipping Docker cleanup","warn"),o("This is normal if no services were previously running","info"),"DOCKER_FAIL"):(o("Docker daemon is not running - skipping Docker cleanup","warn"),o("You may need to start Docker manually and run cleanup later","info"),"NO_DOCKER"):(o("Docker is not installed - skipping Docker cleanup","warn"),"NO_DOCKER")):(o("No Docker configuration found - skipping Docker operations","info"),"NO_DOCKER")}function W(){if(p().dockerMode===!1)return!1;let n=process.env.TORCH_DRY_RUN==="1";return j()?a("docker")?c("docker info",{silent:!0})?(o("Building Docker resources (this may take a while...)...","step"),console.log(` ${t.YELLOW("\u23F3 Please be patient - pulling fresh images and building...")}`),n?(o("Dry-run: would run 'docker-compose build --pull --no-cache'","info"),!0):c("docker-compose build --pull --no-cache")?!0:(o("Docker build encountered issues - check torch-it.log for details","fail"),!1)):(o("Docker daemon is not running - skipping Docker rebuild","warn"),o("Start Docker manually and run 'docker-compose build --pull --no-cache' later","info"),!1):(o("Docker is not installed - skipping Docker rebuild","warn"),!1):!1}function X(){if(p().dockerMode===!1)return!1;let n=process.env.TORCH_DRY_RUN==="1";return o("Starting Docker services in detached mode...","step"),n?(o("Dry-run: would run 'docker compose up -d'","info"),!0):c("docker compose up -d")?!0:(o("Failed to start Docker services - check torch-it.log for details","fail"),!1)}var E=R(require("fs"));var J=()=>{let e=process.env.TORCH_DRY_RUN==="1",n=!1;return o("Detecting package manager and installing dependencies...","step"),E.existsSync("pnpm-lock.yaml")&&a("pnpm")?(o("Using pnpm (detected pnpm-lock.yaml)...","step"),e||c("pnpm install")?(o(`Dependencies ${e?"would be installed":"installed successfully"} with pnpm`,"success"),n=!0):o("pnpm install failed","fail")):E.existsSync("yarn.lock")&&a("yarn")?(o("Using yarn (detected yarn.lock)...","step"),e||c("yarn install")?(o(`Dependencies ${e?"would be installed":"installed successfully"} with yarn`,"success"),n=!0):o("yarn install failed","fail")):E.existsSync("package-lock.json")&&a("npm")?(o("Using npm (detected package-lock.json)...","step"),e||c("npm install")?(o(`Dependencies ${e?"would be installed":"installed successfully"} with npm`,"success"),n=!0):o("npm install failed","fail")):a("npm")?(o("Using npm (fallback)...","info"),e||c("npm install")?(o(`Dependencies ${e?"would be installed":"installed successfully"} with npm`,"success"),n=!0):o("npm install failed","fail")):a("yarn")?(o("Using yarn (fallback)...","info"),e||c("yarn install")?(o(`Dependencies ${e?"would be installed":"installed successfully"} with yarn`,"success"),n=!0):o("yarn install failed","")):a("pnpm")?(o("Using pnpm (fallback)...","info"),e||c("pnpm install")?(o(`Dependencies ${e?"would be installed":"installed successfully"} with pnpm`,"success"),n=!0):o("pnpm install failed","fail")):o("No package manager found (npm/yarn/pnpm). Please install dependencies manually.","fail"),n};var q=e=>{let n="",s="",l="";e.dockerClean==="NO_DOCKER"?n=`${r.DOCKER} No Docker containers found`:e.dockerClean==="DOCKER_FAIL"&&(n=`${r.FAIL} Failed to remove Docker containers`),e.dockerClean==="OK"&&(e.dockerRebuild?s=`${r.DOCKER} Docker containers rebuilt from scratch`:s=`${r.FAIL} Failed to rebuild Docker containers`,e.dockerLaunch&&e.dockerRebuild?l=`${r.ROCKET} Services running in detached mode`:l=`${r.FAIL} Failed to start Docker containers`);let i=e.buildAndCacheClean&&e.packageManagerClean?`${r.CLEAN} All build artifacts & caches removed`:`${r.FAIL} Build artifacts or cache directories not found`,g=e.dependencyInstall?`${r.BOX} Dependencies freshly installed`:`${r.FAIL} Failed to install dependencies`;console.log(""),D(["\u{1F525} PROJECT SUCCESSFULLY TORCHED! \u{1F525}","",`${i}`,`${g}`,`${n}`,`${s}`,`${l}`,"",e.logfile===!1?`${r.CLIPBOARD} Logging to torch-it.log is disabled; set "logfile": true in torchrc.json to enable it`:`${r.CLIPBOARD} Check torch-it.log for detailed logs`])};var ce=process.argv.slice(2),z=ce.includes("--test");z&&(process.env.TORCH_DRY_RUN="1");var T=p();w(T.logfile);T.logfile&&v();P();z&&o("Running in --test dry-run mode (no files or services will be changed)","warn");var d={dockerClean:"NO_DOCKER",buildAndCacheClean:!1,packageManagerClean:!1,dependencyInstall:!1,dockerRebuild:!1,dockerLaunch:!1,logfile:T.logfile};o(`${r.CLEAN} DOCKER CLEANUP`,"step");d.dockerClean=G();o(`${r.CLEAN} BUILD ARTIFACTS & CACHE CLEANUP`,"step");d.buildAndCacheClean=H();o("Cleaning package manager caches...","step");d.packageManagerClean=Y();F();o(`${r.BUILD} DEPENDENCY INSTALLATION`,"step");d.dependencyInstall=J();d.dockerClean&&(o(`${r.BUILD} DOCKER REBUILD`,"step"),d.dockerRebuild=W());d.dockerRebuild&&(d.dockerLaunch=X(),o(`${r.ROCKET} LAUNCH`,"step"));q(d);
|