nukelear 1.0.0 β 1.0.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 +5 -189
- package/dist/package.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<picture>
|
|
4
|
+
<source media="(prefers-color-scheme: dark)" srcset="assets/banner-dark.png">
|
|
5
|
+
<source media="(prefers-color-scheme: light)" srcset="assets/banner-light.png">
|
|
6
|
+
<img alt="Fallback image description" src="assets/banner-dark.png">
|
|
7
|
+
</picture>
|
|
4
8
|
|
|
5
9
|
[](https://www.npmjs.com/package/nukelear)
|
|
6
10
|
[](https://opensource.org/licenses/MIT)
|
|
@@ -44,20 +48,6 @@ command. No more forgotten `node_modules` sitting around for months or years.
|
|
|
44
48
|
|
|
45
49
|
---
|
|
46
50
|
|
|
47
|
-
## β¨ Features
|
|
48
|
-
|
|
49
|
-
- π― **Recursive Scanning** - Finds and deletes unwanted files across deeply
|
|
50
|
-
nested project structures
|
|
51
|
-
- π¦ **Multi-Technology Support** - Delete dependencies for Python, Node.js,
|
|
52
|
-
Next.js, VSCode, and macOS
|
|
53
|
-
- π₯οΈ **Interactive TUI** - User-friendly terminal interface for selecting what
|
|
54
|
-
to delete
|
|
55
|
-
- β‘ **Bulk Operations** - Clean up multiple projects with a single command
|
|
56
|
-
- π‘οΈ **Safe by Default** - Review selections before confirming deletion
|
|
57
|
-
- π **Zero Configuration** - Works out of the box with sensible defaults
|
|
58
|
-
|
|
59
|
-
---
|
|
60
|
-
|
|
61
51
|
## π Quick Start
|
|
62
52
|
|
|
63
53
|
### Using npx (Recommended)
|
|
@@ -239,66 +229,6 @@ nukelear/
|
|
|
239
229
|
|
|
240
230
|
---
|
|
241
231
|
|
|
242
|
-
## π How Nukelear Works (Behind the Scenes)
|
|
243
|
-
|
|
244
|
-
High-level flow when running `nukelear <directory>`:
|
|
245
|
-
|
|
246
|
-
1. **Parse CLI Arguments** - Use Commander.js to parse the directory path and
|
|
247
|
-
optional flags
|
|
248
|
-
2. **Validate Directory** - Ensure the provided directory exists and is
|
|
249
|
-
accessible
|
|
250
|
-
3. **Interactive Selection** (if no flags provided) - Use interactive prompts to
|
|
251
|
-
let users select which technologies to delete
|
|
252
|
-
4. **Scan for Directories** - Recursively scan the directory tree to find all
|
|
253
|
-
instances of the selected directories
|
|
254
|
-
5. **Confirmation** - Display a summary of what will be deleted and ask for
|
|
255
|
-
confirmation
|
|
256
|
-
6. **Delete Recursively** - Remove all matching directories and files
|
|
257
|
-
7. **Report Results** - Show a summary of what was deleted and storage freed
|
|
258
|
-
|
|
259
|
-
---
|
|
260
|
-
|
|
261
|
-
## π Example Scenarios
|
|
262
|
-
|
|
263
|
-
### Scenario 1: Clean a Multi-Stack Development Folder
|
|
264
|
-
|
|
265
|
-
```bash
|
|
266
|
-
$ nukelear ~/Dev --node --python
|
|
267
|
-
|
|
268
|
-
Scanning ~/Dev for Node.js and Python dependencies...
|
|
269
|
-
|
|
270
|
-
Found:
|
|
271
|
-
β’ 47 node_modules directories (~3.2 GB)
|
|
272
|
-
β’ 12 venv directories (~450 MB)
|
|
273
|
-
β’ 8 __pycache__ directories (~120 MB)
|
|
274
|
-
|
|
275
|
-
Total space that will be freed: ~3.77 GB
|
|
276
|
-
|
|
277
|
-
Proceed with deletion? (yes/no)
|
|
278
|
-
```
|
|
279
|
-
|
|
280
|
-
### Scenario 2: Interactive Selection
|
|
281
|
-
|
|
282
|
-
```bash
|
|
283
|
-
$ nukelear ~/Dev
|
|
284
|
-
|
|
285
|
-
? Select technologies to nuke:
|
|
286
|
-
β Node.js
|
|
287
|
-
β Next.js
|
|
288
|
-
β Python
|
|
289
|
-
β VSCode
|
|
290
|
-
β macOS
|
|
291
|
-
```
|
|
292
|
-
|
|
293
|
-
### Scenario 3: Targeted Cleanup
|
|
294
|
-
|
|
295
|
-
```bash
|
|
296
|
-
# Only clean Python environments
|
|
297
|
-
$ nukelear ~/Dev --python
|
|
298
|
-
```
|
|
299
|
-
|
|
300
|
-
---
|
|
301
|
-
|
|
302
232
|
## π CLI Reference
|
|
303
233
|
|
|
304
234
|
### Basic Usage
|
|
@@ -321,120 +251,6 @@ nukelear <directory> [options]
|
|
|
321
251
|
|
|
322
252
|
---
|
|
323
253
|
|
|
324
|
-
## π¨ Safety & Best Practices
|
|
325
|
-
|
|
326
|
-
### Before Running Nukelear
|
|
327
|
-
|
|
328
|
-
1. **Backup Important Data** - If you have uncommitted changes, commit or stash
|
|
329
|
-
them first
|
|
330
|
-
2. **Review Selections** - Always confirm the directories that will be deleted
|
|
331
|
-
3. **Test on a Small Folder** - Try Nukelear on a small test directory first
|
|
332
|
-
4. **Version Control** - Ensure all important code is committed to git
|
|
333
|
-
|
|
334
|
-
### Recovery
|
|
335
|
-
|
|
336
|
-
If you accidentally delete important files:
|
|
337
|
-
|
|
338
|
-
- **Git Repositories** - Run `npm install`, `pip install -r requirements.txt`,
|
|
339
|
-
etc. to restore dependencies from lock files
|
|
340
|
-
- **Untracked Files** - These cannot be recovered; ensure they're committed to
|
|
341
|
-
version control
|
|
342
|
-
|
|
343
|
-
---
|
|
344
|
-
|
|
345
|
-
## π Project Policies & Community Files
|
|
346
|
-
|
|
347
|
-
For details on contributing, security, and community standards, see:
|
|
348
|
-
|
|
349
|
-
- [LICENSE](./LICENSE)
|
|
350
|
-
- [Code of Conduct](./CODE_OF_CONDUCT.md)
|
|
351
|
-
- [Contributing Guidelines](./CONTRIBUTING.md)
|
|
352
|
-
- [Security Policy](./SECURITY.md)
|
|
353
|
-
|
|
354
|
-
---
|
|
355
|
-
|
|
356
|
-
## π Issues and Support
|
|
357
|
-
|
|
358
|
-
We're here to help! If you encounter any issues or have questions:
|
|
359
|
-
|
|
360
|
-
### π¨ Bug Reports
|
|
361
|
-
|
|
362
|
-
- **GitHub Issues**:
|
|
363
|
-
[Report bugs here](https://github.com/ajaykumarn3000/nukelear/issues)
|
|
364
|
-
- Please use our bug report template for faster resolution
|
|
365
|
-
|
|
366
|
-
### π‘ Feature Requests
|
|
367
|
-
|
|
368
|
-
- **GitHub Discussions**:
|
|
369
|
-
[Suggest new features](https://github.com/ajaykumarn3000/nukelear/discussions)
|
|
370
|
-
- Help us understand your use case (e.g., new technology support)
|
|
371
|
-
|
|
372
|
-
### β Questions and Support
|
|
373
|
-
|
|
374
|
-
- **GitHub Discussions**:
|
|
375
|
-
[Ask questions here](https://github.com/ajaykumarn3000/nukelear/discussions)
|
|
376
|
-
- **Documentation**: Check this README for common use cases
|
|
377
|
-
|
|
378
|
-
### π Before Reporting
|
|
379
|
-
|
|
380
|
-
1. **Search existing issues** to avoid duplicates
|
|
381
|
-
2. **Check the latest version** - your issue might already be fixed
|
|
382
|
-
3. **Review the documentation** - the answer might already be here
|
|
383
|
-
4. **Test with a minimal example** - helps us reproduce the issue
|
|
384
|
-
|
|
385
|
-
---
|
|
386
|
-
|
|
387
|
-
## π Community
|
|
388
|
-
|
|
389
|
-
Join our growing community of developers:
|
|
390
|
-
|
|
391
|
-
- β **Star the project** on GitHub to show your support
|
|
392
|
-
- π **Report issues** to help us improve
|
|
393
|
-
- π¬ **Join discussions** to share ideas and ask questions
|
|
394
|
-
- π€ **Contribute code** to make Nukelear even better
|
|
395
|
-
- π’ **Share with others** who might find Nukelear useful
|
|
396
|
-
|
|
397
|
-
---
|
|
398
|
-
|
|
399
|
-
## π Security
|
|
400
|
-
|
|
401
|
-
If you discover a security vulnerability, please report it privately by emailing
|
|
402
|
-
[ajaykumarn3000@gmail.com](mailto:ajaykumarn3000@gmail.com). Please do not
|
|
403
|
-
report security vulnerabilities through public GitHub issues.
|
|
404
|
-
|
|
405
|
-
---
|
|
406
|
-
|
|
407
|
-
## π Project Stats
|
|
408
|
-
|
|
409
|
-
- **Language**: TypeScript
|
|
410
|
-
- **Package Manager**: npm
|
|
411
|
-
- **License**: MIT
|
|
412
|
-
- **Maintained**: β
Actively maintained
|
|
413
|
-
- **Node.js**: 18.0+ required
|
|
414
|
-
|
|
415
|
-
### Key Dependencies
|
|
416
|
-
|
|
417
|
-
- Runtime: `@clack/prompts` (interactive prompts), `chalk` (colors), `commander`
|
|
418
|
-
(CLI parsing)
|
|
419
|
-
- Dev: `eslint`, `prettier`, `husky`, `@commitlint/cli`, `typescript`, `tsx`
|
|
420
|
-
|
|
421
|
-
---
|
|
422
|
-
|
|
423
|
-
## πΊοΈ Roadmap
|
|
424
|
-
|
|
425
|
-
We're continuously working to improve Nukelear. Here's what's on our radar:
|
|
426
|
-
|
|
427
|
-
- [ ] **Additional Technologies**: Ruby, PHP, Go, Java, Rust support
|
|
428
|
-
- [ ] **Dry Run Mode**: Preview what will be deleted without actually deleting
|
|
429
|
-
- [ ] **Ignore Files**: Support for `.nukelearignore` to exclude specific paths
|
|
430
|
-
- [ ] **Statistics**: Show disk space freed per technology
|
|
431
|
-
- [ ] **Parallel Processing**: Speed up scanning of very large directory trees
|
|
432
|
-
- [ ] **Configuration Profiles**: Save and reuse common deletion patterns
|
|
433
|
-
|
|
434
|
-
Want to contribute to any of these? We'd love your help!
|
|
435
|
-
|
|
436
|
-
---
|
|
437
|
-
|
|
438
254
|
## π License
|
|
439
255
|
|
|
440
256
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
|
package/dist/package.json
CHANGED