vitesse-dependency-scripts

# Which Script Should I Use? 🤔 Quick guide to help you choose the right script for your needs. --- ## 🎯 Quick Decision Tree ``` ┌─────────────────────────────────────┐ │ What do you need to do? │ └──────────────┬──────────────────────┘ │ ┌────────┴────────┐ │ │ NEW PROJECT UPDATE EXISTING │ │ ▼ ▼ │ ┌─────────────────┐ │ │ auto-update- │ │ │ full.js │ │ │ │ │ │ Updates deps in │ │ │ current project │ │ └─────────────────┘ │ ┌─────┴──────┐ │ │ │ Do you need│ │ LATEST │ │ versions? │ │ │ └─────┬──────┘ │ ┌───┴───┐ YES NO │ │ ▼ ▼ ┌──────────────┐ ┌────────────────┐ │ ⭐ create- │ │ create- │ │ project- │ │ vitesse- │ │ instant.js │ │ project.js │ │ │ │ │ │ RECOMMENDED! │ │ Basic setup │ └──────────────┘ └────────────────┘ ``` --- ## 📊 Feature Comparison | Feature | create-project-instant.js ⚡ | create-vitesse-project.js | auto-update-full.js | |---------|------------------------------|---------------------------|---------------------| | **Creates new project** | ✅ | ✅ | ❌ | | **Updates existing project** | ❌ | ❌ | ✅ | | **Fetches latest npm versions** | ✅ Real-time | ✅ | ✅ Real-time | | **Enhanced console output** | ⭐ YES | Basic | Basic | | **Shows progress in real-time** | ⭐ YES | Basic | ⚠️ Limited | | **Displays timing** | ⭐ YES | ❌ | ❌ | | **Better error handling** | ⭐ YES | Basic | Basic | | **Skip detection** | ⭐ Detailed | Basic | Basic | | **Creates backups** | ❌ (new project) | ❌ (new project) | ✅ | | **Best for** | ⭐ New projects | Basic new projects | Existing projects | --- ## 🚀 The Three Scripts Explained ### 1. ⚡ create-project-instant.js (RECOMMENDED for new projects) **What it does:** - Creates a new Vitesse project from scratch - Fetches the LATEST version of every package in real-time - Updates workspace catalogs with latest versions - Updates package.json with catalog references - Installs all dependencies - Shows beautiful, detailed progress **When to use:** - ✅ Starting a brand new project - ✅ You want the absolute latest versions - ✅ You want a polished user experience - ✅ You want to see detailed progress **Command:** ```bash node create-project-instant.js my-awesome-app ``` **Example output:** ``` 🚀 Creating new Vitesse project: my-awesome-app 📥 Cloning Vitesse template... ✅ Project created at ./my-awesome-app 📝 Updating pnpm-workspace.yaml with latest versions... 📦 Processing 'frontend' catalog (20 packages)... 🔍 Fetching @casl/ability... ^6.7.1 ✅ @casl/ability: ^6.7.1 ... ⏱️ Total time: 52.1s 🎉 PROJECT READY! ``` --- ### 2. 📦 create-vitesse-project.js (Basic) **What it does:** - Creates a new Vitesse project from scratch - Fetches latest versions and adds dependencies - Updates workspace and package.json - Installs dependencies - Simpler, more basic output **When to use:** - ✅ Starting a new project - ✅ You're okay with basic console output - ✅ You don't need detailed progress **Command:** ```bash node create-vitesse-project.js my-app ``` **Difference from instant:** - Less detailed console output - No timing information - No enhanced progress indicators - Same functionality, simpler presentation --- ### 3. 🔄 auto-update-full.js (For existing projects) **What it does:** - Updates an EXISTING project - Fetches latest versions from npm - Updates pnpm-workspace.yaml - Updates package.json with catalog references - Runs pnpm install - Creates backups before modifying **When to use:** - ✅ You already have a project - ✅ You want to update to latest versions - ✅ You want to add new dependencies - ✅ You need backups of your files **Command:** ```bash node auto-update-full.js ``` **Important:** Run this FROM your project directory or the dependency-scripts folder. --- ## 💡 Common Scenarios ### Scenario 1: "I'm starting a brand new project" **Use:** `create-project-instant.js` ⚡ ```bash cd dependency-scripts node create-project-instant.js my-new-project cd ../my-new-project pnpm dev ``` **Why?** You get the best experience with latest versions and detailed progress. --- ### Scenario 2: "I'm starting a new project but I don't care about fancy output" **Use:** `create-vitesse-project.js` ```bash cd dependency-scripts node create-vitesse-project.js my-project cd ../my-project pnpm dev ``` **Why?** Simpler output, same result. --- ### Scenario 3: "I have an existing project and want to update dependencies" **Use:** `auto-update-full.js` ```bash cd dependency-scripts node auto-update-full.js ``` **Why?** This is designed specifically for updating existing projects. --- ### Scenario 4: "I have an existing project and want to add NEW dependencies" **Use:** `auto-update-full.js` 1. First, add the packages to the `DEPENDENCIES` object in the script 2. Then run: ```bash cd dependency-scripts node auto-update-full.js ``` --- ### Scenario 5: "I just want to test packages without the catalog system" **Use:** `install-missing-deps.sh` ```bash cd dependency-scripts ./install-missing-deps.sh ``` **Why?** Direct install, no catalog configuration. --- ## 🎨 Visual Comparison ### create-project-instant.js ⚡ ``` ╔═════════════════════════════════════════════╗ ║ 🏕️ Vitesse Instant Project Creator ║ ╚═════════════════════════════════════════════╝ 🚀 Creating new Vitesse project... 📝 Updating pnpm-workspace.yaml... 📦 Processing 'frontend' catalog (20 packages)... 🔍 Fetching @casl/ability... ^6.7.1 ✅ @casl/ability: ^6.7.1 ... ⏱️ Total time: 52.1s ═══════════════════════════════════════════════ 🎉 PROJECT READY! 🎉 ═══════════════════════════════════════════════ ``` ### create-vitesse-project.js ``` 🚀 Creating new Vitesse project: my-app 📥 Cloning Vitesse template... ✅ Project created at ./my-app 📝 Updating pnpm-workspace.yaml... ✅ Workspace file updated! 📝 Updating package.json... ✅ Added 33 catalog references 📦 Installing dependencies... ✅ Dependencies installed successfully! 🎉 Project setup complete! ``` ### auto-update-full.js ``` 🚀 Complete Auto Update - Workspace & Package.json 📦 Backups created: - pnpm-workspace.yaml.backup.1697123456789 - package.json.backup.1697123456789 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 📥 Processing 'frontend' catalog... 🔍 Fetching @casl/ability... ✅ Adding to workspace: @casl/ability: ^6.7.1 ... ✨ Files updated successfully! 📦 Installing dependencies with pnpm... ✅ All done! ``` --- ## 🏆 Recommendations ### For Most Users **Use `create-project-instant.js`** when creating new projects. It provides: - ✅ Best user experience - ✅ Detailed progress - ✅ Latest versions - ✅ Clear feedback - ✅ Timing information ### For Advanced Users If you prefer simplicity and don't need fancy output, use `create-vitesse-project.js`. ### For Existing Projects Always use `auto-update-full.js` - it's the only one designed for updates. --- ## 📝 Summary | I want to... | Use this script | |--------------|-----------------| | Create a new project with best experience | `create-project-instant.js` ⭐ | | Create a new project (basic) | `create-vitesse-project.js` | | Update an existing project | `auto-update-full.js` | | Add new deps to existing project | `auto-update-full.js` | | Test packages without catalogs | `install-missing-deps.sh` | | Only update workspace file | `auto-update-catalog.js` | --- ## 🔗 Learn More - [INSTANT-CREATE-README.md](./INSTANT-CREATE-README.md) - Detailed guide for create-project-instant.js - [CREATE-PROJECT-README.md](./CREATE-PROJECT-README.md) - Guide for create-vitesse-project.js - [AUTO-UPDATE-README.md](./AUTO-UPDATE-README.md) - Guide for auto-update-full.js - [README.md](./README.md) - Main documentation --- ## 💬 Still Confused? **Rule of thumb:** - **New project?** → `create-project-instant.js` ⚡ - **Existing project?** → `auto-update-full.js` That's it! 🎉