squeaky-clean 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Squeaky Clean Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,465 @@
+# 🧼squeaky-clean✨
+<div align="center">
+
+**Easy cross-system development cache cleaner/manager with interactive configuration**
+
+Essentially a *"universal cachectl"*—**smart** *(sort of)*, **safe** (at least, I *think* it is...), and **configurable** cache cleaner/manager CLI-tool with support for *most* common development tools. Dsigned for easy integration expansion with additional tools *(forks **encouraged!**)*.
+
+[Features](#features) • [Installation](#installation) • [Usage](#usage) • [Configuration](#configuration) • [Supported Tools](#supported-tools) • [Contributing](#contributing)
+
+---
+
+[![npm downloads](https://img.shields.io/npm/dm/squeaky-clean.svg)](https://www.npmjs.com/package/squeaky-clean) [![Node.js Version](https://img.shields.io/node/v/squeaky-clean.svg)](https://nodejs.org) [![npm version](https://img.shields.io/npm/v/squeaky-clean.svg)](https://www.npmjs.com/package/squeaky-clean) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+---
+
+</div>
+
+## Features
+
+- **🎯 Smart Detection**: Automatically detects installed development tools and their cache locations
+- **🎨 Interactive Wizard**: Beautiful CLI interface with progress bars and colored output
+- **🔧 Highly Configurable**: Choose exactly which caches to clean and when
+- **📊 Size Analytics**: See how much space each cache is using before cleaning
+- **🛡️ Safe by Default**: Dry-run mode to preview what will be cleaned (v0.1.0+ defaults to dry-run)
+- **⚡ Performance**: Parallel cleaning operations for maximum speed
+- **🔄 Auto-clean Mode**: Schedule automatic cache cleaning based on your preferences
+- **📱 Cross-platform**: Works on macOS, Linux, and Windows
+- **🔄 Config Migration**: Automatic migration from legacy to new configuration format
+- **🔌 Plugin Support**: Discover and use community cleaners via npm packages
+- **📋 JSON Output**: Machine-readable output for scripting and automation
+
+## 📦 Installation
+
+### Global Installation (Recommended)
+
+```bash
+npm install -g squeaky-clean
+```
+
+Or using other package managers:
+
+```bash
+# Yarn
+yarn global add squeaky-clean
+
+# pnpm
+pnpm add -g squeaky-clean
+
+# Bun
+bun add -g squeaky-clean
+```
+
+### Local Installation
+
+```bash
+npm install --save-dev squeaky-clean
+```
+
+## Usage
+
+### Interactive Mode (Recommended)
+
+Start the interactive configuration wizard:
+
+```bash
+squeaky interactive
+```
+
+This will guide you through:
+- Selecting which tools to clean
+- Configuring cleaning preferences
+- Setting up automatic cleaning schedules
+
+### Command Line
+
+#### Clean all caches
+
+```bash
+squeaky clean --all
+```
+
+#### Clean specific cache types
+
+```bash
+# Clean only package manager caches
+squeaky clean --types package-manager
+
+# Clean multiple types
+squeaky clean --types package-manager,build-tool
+
+# Clean specific tools
+squeaky clean npm yarn webpack
+```
+
+#### Dry run mode (preview without cleaning)
+
+```bash
+squeaky clean --all --dry-run
+```
+
+#### Show cache sizes
+
+```bash
+squeaky sizes
+```
+
+#### List available caches
+
+```bash
+squeaky list
+# With sizes inline
+squeaky list --sizes
+```
+
+#### 🎯 Granular Cache Management
+
+```bash
+# View detailed cache categories
+squeaky categories --tool npm
+squeaky categories --verbose  # Show all tools with details
+
+# Clean caches older than 7 days
+squeaky clean --older-than 7d
+
+# Clean caches larger than 100MB
+squeaky clean --larger-than 100MB
+
+# Clean only low priority caches (preserve critical/important)
+squeaky clean --priority low
+
+# Clean archived/experimental caches
+squeaky clean --use-case archived
+
+# Combine multiple criteria
+squeaky clean --older-than 14d --priority low --larger-than 50MB
+
+# Clean specific categories by ID
+squeaky categories --tool npm  # First, list categories to get IDs
+squeaky clean --categories npm-logs,npm-metrics
+
+# Use custom config file
+squeaky clean --config my-config.json --dry-run
+```
+
+### Available Commands
+
+| Command | Description | Aliases |
+|---------|-------------|---------|
+| `clean` | Clean development caches with granular control | - |
+| `list` | List available caches and their status | `ls` |
+| `sizes` | Show cache sizes without clearing | - |
+| `categories` | Show detailed cache categories with usage patterns | `cats` |
+| `config` | Manage configuration | - |
+| `doctor` | Check system and diagnose issues | - |
+| `auto` | Configure automatic cleaning | - |
+| `interactive` | Start interactive configuration wizard | `i` |
+
+### Command Options
+
+#### `clean` Options
+
+- `-a, --all` - Clean all configured caches
+- `-t, --types <types>` - Comma-separated list of cache types
+- `-e, --exclude <tools>` - Comma-separated list of tools to exclude
+- `-d, --dry-run` - Show what would be cleaned without actually cleaning
+- `-f, --force` - Skip confirmation prompts
+- `-s, --sizes` - Show cache sizes before cleaning
+
+**🎯 Granular Selection Options:**
+- `--older-than <age>` - Clean caches older than specified age (e.g., `7d`, `2w`, `1m`)
+- `--newer-than <age>` - Clean caches newer than specified age
+- `--larger-than <size>` - Clean caches larger than specified size (e.g., `100MB`, `1GB`)
+- `--smaller-than <size>` - Clean caches smaller than specified size
+- `--use-case <case>` - Target specific use cases (`development`, `testing`, `production`, `experimental`, `archived`)
+- `--priority <level>` - Clean only specified priority (`critical`, `important`, `normal`, `low`)
+- `--categories <ids>` - Clean specific category IDs (comma-separated)
+
+#### `categories` Options
+
+- `-t, --tool <tool>` - Show categories for specific tool
+- `--type <type>` - Filter by cache type
+- `-v, --verbose` - Show detailed information
+
+#### `list` Options
+
+- `-s, --sizes` - Include cache sizes inline with the list
+- `-t, --type <type>` - Filter by cache type
+
+#### Global Options
+
+- `-v, --verbose` - Enable verbose output
+- `--no-color` - Disable colored output
+- `--config <path>` - Use custom configuration file
+- `--version` - Show version number
+- `-h, --help` - Display help
+
+## 🛠️ Supported Tools
+
+### Package Managers
+
+| Tool | Caches Cleaned |
+|------|----------------|
+| **npm** | `~/.npm`, `node_modules/.cache` |
+| **Yarn** | `~/.yarn/cache`, `.yarn/cache` |
+| **pnpm** | `~/.pnpm-store`, `~/.cache/pnpm` |
+| **Bun** | `~/.bun/install/cache` |
+| **pip** | `~/.cache/pip` |
+| **Homebrew** | `brew --cache`, old versions |
+| **Nix** | `/nix/store` garbage, old generations |
+
+### Build Tools
+
+| Tool | Caches Cleaned |
+|------|----------------|
+| **Webpack** | `.webpack-cache`, `node_modules/.cache/webpack` |
+| **Vite** | `node_modules/.vite`, `.vite-cache` |
+| **Nx** | `node_modules/.cache/nx`, `.nx/cache` |
+| **Turbo** | `.turbo`, `node_modules/.cache/turbo` |
+| **Flutter** | `~/.pub-cache`, `build/` |
+
+### IDEs & Editors
+
+| Tool | Caches Cleaned |
+|------|----------------|
+| **VS Code** | `~/.config/Code/Cache*`, Extensions cache |
+| **Xcode** | `~/Library/Developer/Xcode/DerivedData` |
+| **Android Studio** | `~/.android/cache`, Build cache |
+| **JetBrains IDEs** | `~/.cache/JetBrains/*/caches` |
+
+### Browsers (Development)
+
+| Tool | Caches Cleaned |
+|------|----------------|
+| **Chrome** | Dev tools cache, Service workers |
+| **Firefox** | Dev tools cache, Temporary files |
+
+### System Tools
+
+| Tool | Caches Cleaned |
+|------|----------------|
+| **Docker** | Unused containers, images, volumes |
+| **Gradle** | `~/.gradle/caches`, `.gradle/` |
+
+## ⚙️ Configuration
+
+Squeaky Clean can be configured through:
+
+1. **Interactive wizard**: `squeaky interactive`
+2. **Configuration file**: `~/.squeaky-clean/config.json`
+3. **Environment variables**: `SQUEAKY_*`
+
+### Configuration Migration (v0.2.0+)
+
+Squeaky Clean now supports automatic migration from legacy configuration format to the new schema:
+
+```bash
+# Migrate your config automatically
+squeaky config doctor
+
+# Or use the doctor command
+squeaky doctor --config
+
+# Preview migration without changing files
+squeaky config doctor --dry-run
+
+# Migrate to a different file
+squeaky config doctor --input old-config.json --output new-config.json
+```
+
+### Configuration File Examples
+
+#### New Schema (v0.2.0+)
+```json
+{
+  "cleaners": {
+    "npm": { "enabled": true },
+    "yarn": { "enabled": true },
+    "webpack": { "enabled": false }
+  },
+  "scheduler": {
+    "enabled": true,
+    "interval": "weekly",
+    "thresholds": {
+      "size": "1GB",
+      "age": "30d"
+    }
+  },
+  "defaults": {
+    "verbose": false,
+    "colors": true,
+    "format": "text"
+  }
+}
+```
+
+#### Legacy Schema (still supported)
+```json
+{
+  "tools": {
+    "npm": { "enabled": true },
+    "yarn": { "enabled": true },
+    "webpack": { "enabled": false }
+  },
+  "auto": {
+    "enabled": true,
+    "schedule": "weekly",
+    "sizeThreshold": "1GB"
+  },
+  "output": {
+    "verbose": false,
+    "useColors": true
+  }
+}
+```
+
+### Environment Variables
+
+- `SQUEAKY_AUTO_CLEAN` - Enable automatic cleaning
+- `SQUEAKY_DRY_RUN` - Always run in dry-run mode
+- `SQUEAKY_VERBOSE` - Enable verbose output
+- `SQUEAKY_NO_COLOR` - Disable colored output
+
+## 🔄 Automatic Cleaning
+
+Configure automatic cache cleaning based on:
+
+- **Schedule**: Daily, weekly, or monthly
+- **Size threshold**: Clean when caches exceed a certain size
+- **Smart detection**: Clean only when tools haven't been used recently
+
+```bash
+# Configure automatic cleaning
+squeaky auto
+
+# Enable with weekly schedule
+squeaky auto --enable --schedule weekly
+
+# Set size threshold
+squeaky auto --size-threshold 5GB
+```
+
+## 🏗️ Architecture
+
+Squeaky Clean is built with a modular architecture:
+
+```
+src/
+├── cli.ts              # CLI entry point
+├── commands/           # Command implementations
+│   ├── clean.ts       # Main cleaning logic
+│   ├── interactive.ts # Interactive wizard
+│   ├── config.ts      # Configuration management
+│   └── ...
+├── cleaners/          # Tool-specific cleaners
+│   ├── npm.ts
+│   ├── docker.ts
+│   └── ...
+├── config/            # Configuration system
+├── utils/             # Utility functions
+└── types/             # TypeScript definitions
+```
+
+Each cleaner module implements the `CleanerModule` interface:
+
+```typescript
+interface CleanerModule {
+  name: string;
+  type: CacheType;
+  description: string;
+  getCacheInfo(): Promise<CacheInfo>;
+  clear(dryRun?: boolean): Promise<ClearResult>;
+}
+```
+
+## 🧪 Development
+
+### Prerequisites
+
+- Node.js >= 16.0.0
+- npm, yarn, pnpm, or bun
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/justinchen/squeaky-clean.git
+cd squeaky-clean
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Run in development mode
+npm run dev
+```
+
+### Scripts
+
+- `npm run build` - Build the TypeScript source
+- `npm run dev` - Run in development mode with hot reload
+- `npm test` - Run tests
+- `npm run test:watch` - Run tests in watch mode
+- `npm run test:coverage` - Generate test coverage report
+- `npm run lint` - Lint the codebase
+- `npm run format` - Format code with Prettier
+
+### Testing
+
+```bash
+# Run all tests
+npm test
+
+# Run tests in watch mode
+npm run test:watch
+
+# Generate coverage report
+npm run test:coverage
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+### Adding a New Cleaner
+
+To add support for a new tool:
+
+1. Create a new cleaner module in `src/cleaners/`
+2. Implement the `CleanerModule` interface
+3. Register it in `src/cleaners/index.ts`
+4. Add tests in `src/__tests__/cleaners/`
+5. Update the README with the new tool
+
+## 📝 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+**Built with**:
+- *[Commander.js](https://github.com/tj/commander.js)* for CLI parsing
+- *[Chalk](https://github.com/chalk/chalk)* for puuurrrtty terminal output
+- *[Inquirer.js](https://github.com/SBoudrias/Inquirer.js)* for interactive prompts
+- *[Ora](https://github.com/sindresorhus/ora)* for elegant terminal spinners
+
+## 📮 Support
+
+- 🐛 [Report bugs](https://github.com/chendrizzy/squeaky-clean/issues)
+- 💡 [Request features](https://github.com/chendrizzy/squeaky-clean/issues)
+- 📖 [Read the docs](https://github.com/chendrizzy/squeaky-clean#readme)
+- ⭐ Star the project on GitHub!
+
+---
+
+<div align="center">
+Made with ❤️ by and for developers
+</div>

package/dist/cleaners/BaseCleaner.d.ts

@@ -0,0 +1,57 @@
+import { CleanerModule, CacheInfo, CacheCategory, ClearResult, CacheType, CacheSelectionCriteria } from "../types";
+export declare abstract class BaseCleaner implements CleanerModule {
+    abstract name: string;
+    abstract type: CacheType;
+    abstract description: string;
+    abstract isAvailable(): Promise<boolean>;
+    abstract getCacheInfo(): Promise<CacheInfo>;
+    /**
+     * Get detailed cache categories with metadata
+     */
+    getCacheCategories(): Promise<CacheCategory[]>;
+    /**
+     * Check if a path is protected
+     */
+    protected isProtectedPath(path: string, protectedPaths?: string[]): boolean;
+    /**
+     * Filter paths to exclude protected ones
+     */
+    protected filterProtectedPaths(paths: string[], protectedPaths?: string[]): string[];
+    /**
+     * Clear cache with selection criteria
+     */
+    clear(dryRun?: boolean, criteria?: CacheSelectionCriteria, _cacheInfo?: CacheInfo, protectedPaths?: string[]): Promise<ClearResult>;
+    /**
+     * Clear specific categories
+     */
+    clearByCategory(categoryIds: string[], dryRun?: boolean, _cacheInfo?: CacheInfo, protectedPaths?: string[]): Promise<ClearResult>;
+    /**
+     * Filter categories based on criteria
+     */
+    protected filterCategories(categories: CacheCategory[], criteria?: CacheSelectionCriteria): CacheCategory[];
+    /**
+     * Get directory size in bytes
+     */
+    protected getDirectorySize(path: string): Promise<number>;
+    /**
+     * Clear a specific path
+     */
+    protected clearPath(path: string): Promise<void>;
+    /**
+     * Detect if a path has been recently used
+     */
+    protected isRecentlyUsed(path: string, days?: number): boolean;
+    /**
+     * Detect if a path is project-specific
+     */
+    protected isProjectSpecific(path: string): boolean;
+    /**
+     * Get cache priority based on path and usage
+     */
+    protected getCachePriority(path: string): "critical" | "important" | "normal" | "low";
+    /**
+     * Detect use case based on path patterns
+     */
+    protected detectUseCase(path: string): "development" | "testing" | "production" | "experimental" | "archived";
+}
+//# sourceMappingURL=BaseCleaner.d.ts.map

package/dist/cleaners/BaseCleaner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseCleaner.d.ts","sourceRoot":"","sources":["../../src/cleaners/BaseCleaner.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,SAAS,EACT,aAAa,EACb,WAAW,EACX,SAAS,EACT,sBAAsB,EACvB,MAAM,UAAU,CAAC;AAWlB,8BAAsB,WAAY,YAAW,aAAa;IACxD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B,QAAQ,CAAC,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IACxC,QAAQ,CAAC,YAAY,IAAI,OAAO,CAAC,SAAS,CAAC;IAE3C;;OAEG;IACG,kBAAkB,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IA6BpD;;OAEG;IACH,SAAS,CAAC,eAAe,CACvB,IAAI,EAAE,MAAM,EACZ,cAAc,GAAE,MAAM,EAAO,GAC5B,OAAO;IA+BV;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAC5B,KAAK,EAAE,MAAM,EAAE,EACf,cAAc,GAAE,MAAM,EAAO,GAC5B,MAAM,EAAE;IAeX;;OAEG;IACG,KAAK,CACT,MAAM,CAAC,EAAE,OAAO,EAChB,QAAQ,CAAC,EAAE,sBAAsB,EACjC,UAAU,CAAC,EAAE,SAAS,EACtB,cAAc,CAAC,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,WAAW,CAAC;IA2CvB;;OAEG;IACG,eAAe,CACnB,WAAW,EAAE,MAAM,EAAE,EACrB,MAAM,CAAC,EAAE,OAAO,EAChB,UAAU,CAAC,EAAE,SAAS,EACtB,cAAc,CAAC,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,WAAW,CAAC;IA4CvB;;OAEG;IACH,SAAS,CAAC,gBAAgB,CACxB,UAAU,EAAE,aAAa,EAAE,EAC3B,QAAQ,CAAC,EAAE,sBAAsB,GAChC,aAAa,EAAE;IAmDlB;;OAEG;cACa,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAe/D;;OAEG;cACa,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAetD;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,MAAU,GAAG,OAAO;IAajE;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAelD;;OAEG;IACH,SAAS,CAAC,gBAAgB,CACxB,IAAI,EAAE,MAAM,GACX,UAAU,GAAG,WAAW,GAAG,QAAQ,GAAG,KAAK;IAc9C;;OAEG;IACH,SAAS,CAAC,aAAa,CACrB,IAAI,EAAE,MAAM,GACX,aAAa,GAAG,SAAS,GAAG,YAAY,GAAG,cAAc,GAAG,UAAU;CAO1E"}