vibefast-cli 1.1.5 → 1.3.0

package/CHANGELOG.md

@@ -2,11 +2,28 @@
 
 All notable changes to VibeFast CLI will be documented in this file.
 
+## [1.2.0] - 2024-11-27
+
+### Added
+
+- **AST-Based Modifications**: The CLI now uses Abstract Syntax Trees (AST) to safely modify `app.config.ts` when installing plugins. This replaces fragile regex-based replacements.
+- **E2E Testing Suite**: Added comprehensive End-to-End tests for `init`, `add`, and `remove` commands to ensure stability.
+- **Local CI**: Integrated Husky for pre-push checks, running tests automatically before every push.
+- **Manual Testing Guide**: Added `docs/manual-testing.md` to help contributors test the CLI locally.
+- **`--skip-install` for `add`**: Added a flag to skip dependency installation during `vf add`, useful for testing and CI.
+
+### Fixed
+
+- **Recipe Imports**: Fixed incorrect import paths in `image-analysis` and `image-generator` recipes (`imageAnalysisFunctions` -> `imageAnalysis`).
+- **Path Handling**: Improved cross-platform path compatibility for Windows/Linux.
+- **Test Stability**: Fixed flaky tests by increasing timeouts and improving sandbox cleanup.
+
 ## [0.3.0] - 2024-11-15
 
 ### Added - Phase 1, 2 & 3 Features 🚀
 
 **Phase 1 & 2:**
+
 - **`vf init` Command**: One command to initialize a new VibeFast project
   - Interactive prompts for branch selection (clean/full)
   - Automatic repository cloning
@@ -31,6 +48,7 @@ All notable changes to VibeFast CLI will be documented in this file.
   - Better UX for interactive workflows
 
 **Phase 3:**
+
 - **Auto-Install Dependencies**: After `vf add`, automatically prompts to install required packages
   - Native: Uses `npx expo install` for compatible versions
   - Web: Auto-detects package manager (pnpm/npm/yarn/bun)
@@ -51,6 +69,7 @@ All notable changes to VibeFast CLI will be documented in this file.
   - Exit codes: 0 = healthy, 1 = warnings, 2 = errors
 
 ### Improved
+
 - **`vf add` Command**: Now uses spinners and auto-detects target
 - **`vf list` Command**: Shows spinner while fetching features
 - **Error Messages**: More helpful messages for Git and permission errors
@@ -58,26 +77,31 @@ All notable changes to VibeFast CLI will be documented in this file.
 - **Performance**: Parallel operations where possible
 
 ### New Core Modules
+
 - `src/core/detect.ts` - Target and package manager detection
 - `src/core/spinner.ts` - Progress indicators
 - `src/core/prompts.ts` - Interactive prompts
 
 ### New Dependencies
+
 - `ora` - Terminal spinners
 - `inquirer` - Interactive prompts
 - `simple-git` - Git operations
 
 ### Documentation
+
 - Added `PHASE-1-2-IMPLEMENTATION.md` - Implementation details
 - Added `QUICK-START.md` - Quick start guide with new features
 
 ### Testing
+
 - Added unit tests for detection module (9 tests)
 - All tests passing
 
 ## [0.2.2] - 2024-11-14
 
 ### Fixed
+
 - **Error Messages**: Removed nested error wrapping that caused confusing messages
 - Error messages are now clean and single-level with helpful context
 - Improved error display in `list`, `devices`, and `add` commands
@@ -85,6 +109,7 @@ All notable changes to VibeFast CLI will be documented in this file.
 ## [0.2.0] - 2024-11-13
 
 ### Added
+
 - **Interactive Confirmation**: CLI now asks before overwriting existing files
 - **Package Dependency Display**: Shows required packages with `npx expo install` command
 - **Modification Detection**: Warns before deleting files you've modified
@@ -97,6 +122,7 @@ All notable changes to VibeFast CLI will be documented in this file.
 - **Comprehensive Tests**: 34 unit tests covering all core functionality
 
 ### Improved
+
 - **Error Messages**: User-friendly error messages with clear actionable solutions
 - **Support Contact**: All error messages include support@vibefast.pro
 - **CI/CD Compatibility**: Detects non-interactive environments and behaves appropriately
@@ -104,10 +130,12 @@ All notable changes to VibeFast CLI will be documented in this file.
 - **Documentation**: Comprehensive documentation and examples
 
 ### Changed
+
 - **Package Management**: Now uses `npx expo install` for native apps (no version management needed)
 - **Journal Format**: Updated to store file hashes (auto-migrates old format)
 
 ### Fixed
+
 - Files being overwritten without confirmation
 - No warning when deleting modified files
 - Missing package installation information
@@ -116,6 +144,7 @@ All notable changes to VibeFast CLI will be documented in this file.
 ## [0.1.4] - 2024-11-11
 
 ### Added
+
 - Initial release
 - Basic `vf add` and `vf remove` commands
 - Authentication with `vf login` and `vf logout`
@@ -127,6 +156,7 @@ All notable changes to VibeFast CLI will be documented in this file.
 - Journal tracking
 
 ### Security
+
 - Path security with directory traversal prevention
 - Token storage in user home directory
 - HTTPS-only communication
@@ -141,6 +171,7 @@ All notable changes to VibeFast CLI will be documented in this file.
 No breaking changes! The CLI will automatically migrate your journal to the new format.
 
 **New Features You Can Use:**
+
 ```bash
 # Check what's installed
 vf status
@@ -161,6 +192,7 @@ The CLI now provides much clearer error messages with actionable solutions.
 ## Support
 
 For issues or questions:
+
 - Email: support@vibefast.pro
 - GitHub: https://github.com/vibefast/vibefast-cli/issues
 - Website: https://vibefast.pro

package/README.md

@@ -1,219 +1,113 @@
 # VibeFast CLI
 
-Official CLI for installing VibeFast features into your monorepo.
+<div align="center">
+  <img src="vibefast_cli_architecture.png" alt="VibeFast CLI Architecture" width="100%" />
+  <br />
+  <br />
+  <a href="https://vibefast.pro">
+    <img src="https://img.shields.io/badge/VibeFast-Pro-7C3AED?style=for-the-badge" alt="VibeFast Pro" />
+  </a>
+  <a href="https://www.npmjs.com/package/vibefast-cli">
+    <img src="https://img.shields.io/npm/v/vibefast-cli?style=for-the-badge&color=blue" alt="NPM Version" />
+  </a>
+</div>
 
-## ✨ New in v0.2.0
+## Overview
 
-- **Interactive Confirmation** - No more silent overwrites! CLI asks before replacing files
-- **Package Management** - Shows required packages with `npx expo install` command
-- **Modification Detection** - Warns before deleting files you've modified
-- **Manual Steps** - Clear setup instructions for services like Sentry, PostHog
-- **New Commands** - `vf status` and `vf checklist` for better management
-- **Better Errors** - User-friendly error messages with actionable solutions
+The **VibeFast CLI** is the command center for your VibeFast monorepo. It automates the complex task of integrating full-stack features—handling file copying, dependency management, configuration updates, and code modifications safely and reliably.
 
-[See full changelog](CHANGELOG.md)
+Think of it as a "smart installer" that understands your project structure.
 
-## Installation
+## Architecture
 
-```bash
-npm install -g vibefast-cli
-```
+The CLI operates as a bridge between the **VibeFast Cloud** (where recipes are stored) and your **Local Project**.
 
-Or use directly with npx:
-
-```bash
-npx vibefast-cli <command>
-```
+1.  **Command Execution**: You run a command like `vf add chatbot`.
+2.  **Authentication & Fetch**: The CLI verifies your license and fetches the latest "Recipe" (a zip bundle of code) from our edge network (R2).
+3.  **Smart Installation**:
+    - **Extraction**: Files are extracted to the correct locations (`apps/native`, `apps/web`, `packages/backend`).
+    - **AST Modification**: We use Abstract Syntax Trees to safely modify your `app.config.ts`, `babel.config.js`, and other config files—no fragile regex replacements.
+    - **Dependency Management**: Automatically detects your package manager (pnpm, npm, yarn, bun) and installs required libraries.
+4.  **Journaling**: Every action is recorded in `.vibefast/journal.json`, allowing for clean uninstalls via `vf remove`.
 
 ## Quick Start
 
-1. **Login with your token:**
-Use the same license key you received in your LemonSqueezy receipt:
-
-```bash
-vf login --token YOUR_LICENSE_KEY
-```
-
-2. **Verify your setup:**
-```bash
-vf doctor
-```
+### 1. Installation
 
-3. **List available features:**
 ```bash
-vf list
+npm install -g vibefast-cli
 ```
 
-4. **Install a feature:**
-```bash
-vf add charts
-vf add charts-web --target web
-```
+### 2. Login
 
-5. **Check what's installed:**
-```bash
-vf status
-```
+Authenticate with your license key (from your purchase receipt):
 
-6. **Remove a feature:**
 ```bash
-vf remove charts
+vf login --token YOUR_LICENSE_KEY
 ```
 
-## Commands
-
-### `vf login --token <TOKEN>`
-Authenticate with your VibeFast license token.
-
-### `vf logout`
-Clear your stored token.
-
-### `vf devices`
-List your active device activations.
-
-**Options:**
-- `--deactivate <id>` - Free up a device slot
-
-### `vf doctor`
-Check your VibeFast setup and verify all requirements.
-
-### `vf list`
-Show all available features for your license.
+### 3. Initialize a Project
 
-### `vf add <feature>`
-Install a feature into your project.
+Start a new VibeFast project from scratch:
 
-**Options:**
-- `--target <native|web>` - Target platform (default: native)
-- `--dry-run` - Preview changes without applying
-- `--force` - Overwrite existing files without asking
-- `--yes` - Answer yes to all prompts (for automation)
-
-**Example:**
 ```bash
-vf add charts --target native
-vf add chatbot --target web --force
-vf add sentry --yes  # For CI/CD
+vf init
 ```
 
-**What happens:**
-1. Downloads and extracts the feature
-2. Copies files to your project
-3. Adds navigation link (if applicable)
-4. Shows required packages to install
-5. Shows manual setup steps (if needed)
-
-### `vf remove <feature>`
-Remove an installed feature.
+### 4. Add Features
 
-**Options:**
-- `--target <native|web>` - Target platform (default: native)
-- `--dry-run` - Preview changes without applying
-- `--force` - Skip modification check
-- `--yes` - Answer yes to all prompts
+Install pre-built features instantly:
 
-**Example:**
 ```bash
-vf remove charts --target native
+vf add charts
+vf add chatbot --target web
 ```
 
-**What happens:**
-1. Checks if files were modified (warns you)
-2. Deletes all tracked files
-3. Removes navigation link
-4. Updates journal
-
-### `vf status` 🆕
-Show all installed features and their status.
-
-**Example:**
-```bash
-$ vf status
-
-Installed features:
+## Core Commands
 
-  ✓ charts (v1.0.0) - native
-    Files: 17
-    Installed: 11/13/2024
+| Command                  | Description                                              |
+| :----------------------- | :------------------------------------------------------- |
+| `vf init`                | Scaffolds a new VibeFast monorepo project.               |
+| `vf add <feature>`       | Installs a feature, handling all file ops and configs.   |
+| `vf remove <feature>`    | Uninstalls a feature and cleans up files.                |
+| `vf list`                | Lists all available features for your license.           |
+| `vf status`              | Shows installed features and their health.               |
+| `vf doctor`              | Diagnoses issues with your project setup.                |
+| `vf checklist <feature>` | Shows manual setup steps (e.g., API keys) for a feature. |
+| `vf devices`             | Manages your active device sessions.                     |
 
-  ✓ sentry (v1.2.0) - native
-    Files: 5
-    Installed: 11/13/2024
-    ⚠ Has manual setup steps
+## Advanced Usage
 
-Total: 2 feature(s) installed
-```
-
-### `vf checklist <feature>` 🆕
-Show manual setup steps for an installed feature.
-
-**Options:**
-- `--target <native|web>` - Target platform (default: native)
-
-**Example:**
-```bash
-vf checklist sentry
-```
+### Automation (CI/CD)
 
-**When to use:**
-Some features (like Sentry, PostHog, Stripe) require external service setup. After installing such features, you'll see:
+The CLI is designed for automation. Use flags to bypass interactive prompts:
 
 ```bash
-⚠ MANUAL STEPS REQUIRED:
+# Install without prompts
+vf add sentry --yes --force
 
-Step 1: Create Sentry Account
-  Sign up at sentry.io and create a project
-  🔗 https://sentry.io/signup/
-
-💡 Run 'vf checklist sentry' to see these steps again
+# Skip dependency installation (faster for CI)
+vf add chatbot --skip-install
 ```
 
-Run `vf checklist <feature>` anytime to see the setup instructions again.
-
-## Requirements
-
-- Node.js 18+
-- A VibeFast monorepo with `.vibefast/starter.json`
-- Valid VibeFast license token
-
-## Device Limits
+### Manual Testing
 
-Each license includes 2 device slots by default. A device is identified by a stable ID based on your machine's username, hostname, and OS. You can manage your devices with:
-
-```bash
-vf devices                    # List active devices
-vf devices --deactivate <id>  # Free a slot
-```
+If you are contributing to the CLI, see our [Manual Testing Guide](docs/manual-testing.md).
 
 ## Troubleshooting
 
 **"Not a VibeFast repo"**
-- Make sure you're in the root of your VibeFast monorepo
-- Check that `.vibefast/starter.json` exists
-
-**"Not logged in"**
-- Run `vf login --token <YOUR_TOKEN>`
+Ensure you are in the root of your project and that `.vibefast/starter.json` exists.
 
 **"Device limit reached"**
-- Run `vf devices` to see active devices
-- Deactivate unused devices with `vf devices --deactivate <id>`
-
-**"Missing navigation markers"**
-- Ensure your nav files have the required marker comments
-- Run `vf doctor` to check
-
-## Environment Variables
+Your license has a limit on active devices. Run `vf devices` to see them and `vf devices --deactivate <id>` to free up a slot.
 
-- `VIBEFAST_WORKER_URL` - Override the API endpoint (default: https://api.vibefast.pro)
-
-## Documentation
+## Support
 
-- **[README.md](README.md)** - This file (user guide)
-- **[CHANGELOG.md](CHANGELOG.md)** - Version history
-- **[HOW-IT-WORKS.md](HOW-IT-WORKS.md)** - Technical architecture
-- **[MANUAL-STEPS-GUIDE.md](MANUAL-STEPS-GUIDE.md)** - Guide for recipe creators
-- **[IMPLEMENTATION-COMPLETE.md](IMPLEMENTATION-COMPLETE.md)** - Implementation details
+For issues, please contact [support@vibefast.pro](mailto:support@vibefast.pro).
 
-## Support
+---
 
-For issues or questions, contact support@vibefast.pro
+<div align="center">
+  <sub>Built with ❤️ by the VibeFast Team</sub>
+</div>