@burger-api/cli 0.7.0 → 0.9.1

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 All notable changes to the Burger API CLI will be documented in this file.
 
+## Version 0.9.0 - (March 15, 2026)
+
+-   ✨ **Create** – New projects get a config file (`burger.config.ts`) from
+    your answers; the build uses this config when present.
+-   🔨 **Build** – One build pipeline for both bundle and executable; routes
+    are found at build time so production is fast and reliable.
+-   📂 **Defaults** – Executable output: `.build/executable/<project>` (or
+    `.exe` on Windows); bundle: `.build/bundle/app.js`.
+-   🧪 **Tests** – New tests for routes, config, and build output; CI catches
+    broken builds early.
+-   🐛 **Fixed** – Invalid route combinations are caught at build time.
+-   🐛 **Fixed** – Production build keeps your middleware and options (e.g.
+    title, description) instead of dropping them.
+-   📚 **Docs** – README updated with production build steps and test
+    commands.
+
 ## Version 0.7.0 - (December 23, 2025)
 
 ### Added
@@ -32,7 +48,7 @@ All notable changes to the Burger API CLI will be documented in this file.
 - `list` command to show available middleware from ecosystem
 - `add` command to download and install middleware
 - `build` command to bundle projects to single JS file
-- `build:executable` command to compile to standalone executable
+- `build:exec` command to compile to standalone executable
 - `serve` command for development server with hot reload
 - Beautiful console output with colors and symbols
 - Zero external dependencies for file operations (uses Bun's native APIs)

package/README.md

@@ -1,79 +1,57 @@
-# Burger API CLI
+# BurgerAPI CLI 👨‍💻
 
-Simple command-line tool for creating and managing Burger API projects.
+A Command-Line Tool for Creating and Managing BurgerAPI Projects.
 
 ## Installation
 
-### Option 1: npm/bun (Recommended if you have Bun installed)
+### Option 1: Bun Global Installation (Recommended if you have Bun installed)
+
+**Global Installation:**
 
-**Global installation:**
 ```bash
 bun add -g @burger-api/cli
 ```
 
-**Or use with bunx (no installation needed):**
+**Or use with bunx (No Installation Needed):**
+
 ```bash
 bunx @burger-api/cli create my-project
 ```
 
-### Option 2: Standalone Executable
+### Option 2: Standalone Executable (Alternative Installation Method)
 
 **macOS, Linux, WSL:**
+
 ```bash
 curl -fsSL https://burger-api.com/install.sh | bash
 ```
 
 **Windows PowerShell:**
+
 ```powershell
 irm https://burger-api.com/install.ps1 | iex
 ```
 
-### Option 3: Manual Download
+### Option 3: Manual Download (Alternative Installation Method)
 
-1. Download the executable for your platform from [GitHub Releases](https://github.com/isfhan/burger-api/releases/latest)
+1. Download the executable for your platform from
+   [GitHub Releases](https://github.com/isfhan/burger-api/releases/latest)
 2. Add to PATH
 3. Make executable (Linux/macOS): `chmod +x burger-api`
 
-### Verify Installation
+### Verify Installation (To Check if the CLI is Installed Correctly)
 
 ```bash
 burger-api --version
 ```
 
-## Quick Start
-
-Create a new project in 30 seconds:
-
-```bash
-# Create a new project
-burger-api create my-awesome-api
-
-# Navigate to your project
-cd my-awesome-api
-
-# Start development server
-bun run dev
-
-# Open http://localhost:4000 in your browser
-```
-
-That's it! Your Burger API server is running! 🎉
-
----
-
-## Commands
+## Available Commands (To Manage Your Project)
 
 ### `burger-api create <project-name>`
 
 Create a new Burger API project with interactive prompts.
 
-**Example:**
-
-```bash
-burger-api create my-api
-```
-
-The CLI will ask you:
+**Questions You Will Be Asked:**
 
 -   Do you need API routes? (yes/no)
 -   API directory name (default: api)
@@ -91,9 +69,24 @@ installed!
 -   ✅ Full project structure
 -   ✅ TypeScript configured
 -   ✅ Dependencies installed
+-   ✅ `burger.config.ts` generated from your answers
 -   ✅ Example routes
 -   ✅ Ready to run!
 
+Generated config example:
+
+```ts
+export default {
+    apiDir: './src/api',
+    pageDir: './src/pages',
+    apiPrefix: '/api',
+    pagePrefix: '/',
+    debug: false,
+};
+```
+
+Edit `burger.config.ts` anytime to change routes, prefixes, or debug mode.
+
 ---
 
 ### `burger-api list`
@@ -173,7 +166,8 @@ const app = new Burger({
 
 ### `burger-api build <file>`
 
-Bundle your project into a single JavaScript file.
+Bundle your project with build-time (AOT) route discovery.
+The CLI scans routes first, generates a virtual entry file, then runs Bun build.
 
 **Example:**
 
@@ -193,22 +187,29 @@ burger-api build index.ts --sourcemap linked
 
 **Options:**
 
--   `--outfile <path>` - Output file path (default: `.build/bundle.js`)
+-   `--outfile <path>` - Output file path (default: `.build/bundle/app.js`)
 -   `--minify` - Minify the output for smaller file size
 -   `--sourcemap <type>` - Generate sourcemaps (inline, linked, or none)
 -   `--target <target>` - Target environment (e.g., bun, node)
 
+Build config is loaded from `burger.config.ts` or `burger.config.js` when
+present. If no config exists, the CLI uses defaults:
+`apiDir=./src/api`, `pageDir=./src/pages`, `apiPrefix=/api`, `pagePrefix=/`.
+
 **Output:**
 
 ```
 ✓ Build completed successfully!
-  Output: .build/bundle.js
+  Output: .build/bundle/app.js
   Size: 42.5 KB
 ```
 
+- API-only apps: `app.js` is usually enough to deploy.
+- Apps with pages/assets: deploy the full `.build/bundle/` directory.
+
 ---
 
-### `burger-api build:executable <file>`
+### `burger-api build:exec <file>`
 
 Compile your project to a standalone executable that runs without Bun installed!
 
@@ -216,19 +217,19 @@ Compile your project to a standalone executable that runs without Bun installed!
 
 ```bash
 # Build for current platform
-burger-api build:executable index.ts
+burger-api build:exec index.ts
 
 # Build for Windows
-burger-api build:executable index.ts --target bun-windows-x64
+burger-api build:exec index.ts --target bun-windows-x64
 
 # Build for Linux
-burger-api build:executable index.ts --target bun-linux-x64
+burger-api build:exec index.ts --target bun-linux-x64
 
 # Build for Mac (ARM)
-burger-api build:executable index.ts --target bun-darwin-arm64
+burger-api build:exec index.ts --target bun-darwin-arm64
 
 # Custom output name
-burger-api build:executable index.ts --outfile my-server.exe
+burger-api build:exec index.ts --outfile my-server.exe
 ```
 
 **Options:**
@@ -250,11 +251,11 @@ burger-api build:executable index.ts --outfile my-server.exe
 
 ```
 ✓ Compilation completed successfully!
-  Executable: .build/my-api.exe
+  Executable: .build/executable/<project>.exe
   Size: 45.2 MB
 
   Your standalone executable is ready to run!
-  Run it: .build/my-api.exe
+  Run it: .build/executable/<project>.exe
 ```
 
 **Use case:** Perfect for deploying your API to production servers without
@@ -346,69 +347,24 @@ export async function POST(req: BurgerRequest) {
 
 That's it! The route is automatically available at `/api/users`
 
-## Common Workflows
-
-### Workflow 1: Create and Run a Project
-
-```bash
-# 1. Create project
-burger-api create my-api
-
-# 2. Navigate to it
-cd my-api
-
-# 3. Start dev server
-bun run dev
-
-# 4. Make changes and see them instantly!
-```
-
-### Workflow 2: Add Middleware
-
-```bash
-# 1. See what's available
-burger-api list
+### Adding Pages
 
-# 2. Add what you need
-burger-api add cors logger rate-limiter
+Create a new file in the `pages/` folder:
 
-# 3. Use them in index.ts (CLI shows you how!)
+```html
+<!-- pages/about.html -->
+<html>
+    <body>
+        <h1>About Page</h1>
+        <p>This is the about page.</p>
+    </body>
+</html>
 ```
 
-### Workflow 3: Build for Production
-
-```bash
-# 1. Test your app works
-burger-api serve
-
-# 2. Build an executable
-burger-api build:executable index.ts --target bun-linux-x64
-
-# 3. Deploy to your server
-scp .build/my-api user@server:/opt/
-ssh user@server
-chmod +x /opt/my-api
-/opt/my-api
-```
+That's it! The page is automatically available at `/about`
 
 ## Troubleshooting
 
-### "burger-api: command not found"
-
-**Solution:** Install the CLI using the install script:
-
-**macOS/Linux:**
-```bash
-curl -fsSL https://burger-api.com/install.sh | bash
-```
-
-**Windows:**
-```powershell
-irm https://burger-api.com/install.ps1 | iex
-```
-
-Or manually download from [GitHub Releases](https://github.com/isfhan/burger-api/releases/latest) and add to PATH.
-
 ### "Directory already exists"
 
 **Solution:** Choose a different project name or remove the existing directory:
@@ -438,9 +394,13 @@ burger-api serve
 1. You're in a Burger API project directory
 2. The entry file exists
 3. There are no TypeScript errors in your code
+4. Route folder rules are valid (no mixed dynamic + wildcard siblings)
 
 Run `bun run dev` first to see any errors.
 
+If you use custom folders or prefixes, verify your `burger.config.ts` /
+`burger.config.js` values.
+
 ### Cross-compilation fails from Windows (D:\ drive)
 
 **Error:**
@@ -567,17 +527,23 @@ you encounter crashes, rebuild without `--bytecode`. The build scripts use
 
 ### Testing
 
-Test commands locally:
+Run tests (from `packages/cli`):
 
 ```bash
-# Create a test project
-bun run src/index.ts create test-app
+# Run all CLI tests
+bun run test
 
-# Test other commands
-cd test-app
-bun run ../src/index.ts list
-bun run ../src/index.ts add cors
-bun run ../src/index.ts serve
+# Run build tests only (check production matches dev)
+bun run test:build
+
+# Run one test file
+bun test test/build-output.test.ts
+```
+
+From the **repo root**, run all CLI tests with:
+
+```bash
+bun run test:cli
 ```
 
 ### Contributing
@@ -594,6 +560,11 @@ bun run ../src/index.ts serve
 -   Add comments explaining your code
 -   Test all commands before submitting
 -   Update README if adding new features
+-   Keep route rules in one place:
+    - runtime/shared rules: `packages/burger-api/src/utils/pathConversion.ts`
+    - scanner traversal: `packages/cli/src/utils/scanner.ts`
+-   Run build tests when changing routing/build (keeps dev and production behavior the same):
+    - `bun run test:build`
 
 ### Design Principles
 
@@ -602,30 +573,6 @@ bun run ../src/index.ts serve
 -   **Simple language** - No jargon, clear explanations
 -   **Well commented** - Explain why, not just what
 
----
-
-## Release Process
-
-For maintainers releasing new versions:
-
-1. **Update versions** in `package.json` and `src/index.ts`
-2. **Update CHANGELOG.md** with all changes
-3. **Create and push a version tag:**
-   ```bash
-   git tag v1.0.0
-   git push origin v1.0.0
-   ```
-4. **GitHub Actions automatically:**
-   - Builds executables for all platforms (Linux, Windows, macOS ARM64, macOS Intel)
-   - Creates a GitHub Release with all executables attached
-   - Generates SHA256 checksums for verification
-
-The release workflow is triggered automatically when you push a tag matching `v*` pattern.
-
-See [CHANGELOG.md](./CHANGELOG.md) for version history.
-
----
-
 ## Technical Details
 
 **Built with:**
@@ -653,4 +600,4 @@ See [CHANGELOG.md](./CHANGELOG.md) for version history.
 
 MIT License - See [LICENSE](../../LICENSE) for details.
 
-**Built with ❤️ for the Burger API community**
+**Built with ❤️ for the BurgerAPI community**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@burger-api/cli",
-  "version": "0.7.0",
+  "version": "0.9.1",
   "description": "Simple command-line tool for Burger API projects",
   "module": "src/index.ts",
   "type": "module",
@@ -18,6 +18,8 @@
   },
   "scripts": {
     "dev": "bun run src/index.ts",
+    "test": "bun test --timeout 30000 ./test",
+    "test:build": "bun test test/scanner.test.ts test/virtual-entry.test.ts test/entry-options.test.ts test/build-preserve-options.test.ts",
     "build:win": "bun build ./src/index.ts --compile --target bun-windows-x64 --outfile dist/burger-api.exe --minify",
     "build:linux": "bun build ./src/index.ts --compile --target bun-linux-x64 --outfile dist/burger-api-linux --minify",
     "build:mac": "bun build ./src/index.ts --compile --target bun-darwin-arm64 --outfile dist/burger-api-mac --minify",
@@ -29,8 +31,7 @@
     "@clack/prompts": "^0.7.0"
   },
   "devDependencies": {
-    "@types/bun": "latest",
-    "@types/commander": "^2.12.5"
+    "@types/bun": "latest"
   },
   "peerDependencies": {
     "typescript": "^5"
@@ -47,5 +48,8 @@
     "type": "git",
     "url": "git+https://github.com/isfhan/burger-api.git",
     "directory": "packages/cli"
+  },
+  "publishConfig": {
+    "access": "public"
   }
-}
+}