chore: wip

chrisbbreuer · chrisbbreuer · commit cc95e2f2517f · 2025-10-20T16:44:16.000-07:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -13,7 +13,8 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  build-and-test:
+  zig-core:
+    name: Zig Core Tests
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
@@ -37,8 +38,8 @@ jobs:
         with:
           path: |
             ~/.cache/zig
-            zig-cache
-          key: ${{ runner.os }}-zig-${{ matrix.zig-version }}-${{ hashFiles('build.zig') }}
+            packages/zig/zig-cache
+          key: ${{ runner.os }}-zig-${{ matrix.zig-version }}-${{ hashFiles('packages/zig/build.zig') }}
           restore-keys: |
             ${{ runner.os }}-zig-${{ matrix.zig-version }}-
 
@@ -48,24 +49,53 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev
 
-      - name: Build
+      - name: Build Zig core
+        working-directory: packages/zig
         run: zig build
 
-      - name: Run tests
+      - name: Run Zig tests
+        working-directory: packages/zig
         run: zig build test
 
-      - name: Build examples
-        run: |
-          zig build
-          zig build run-minimal -- --help
-
       - name: Check binary size
         if: runner.os == 'Linux'
         run: |
-          ls -lh zig-out/bin/
-          size zig-out/bin/zyte-minimal || true
+          ls -lh packages/zig/zig-out/bin/
+          size packages/zig/zig-out/bin/zyte || true
+
+  typescript-sdk:
+    name: TypeScript SDK Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Type check TypeScript SDK
+        working-directory: packages/typescript
+        run: bun run typecheck
+
+      - name: Run TypeScript SDK tests
+        working-directory: packages/typescript
+        run: bun test
+
+      - name: Build TypeScript SDK
+        working-directory: packages/typescript
+        run: bun run build
+
+      - name: Type check create-zyte
+        working-directory: packages/create-zyte
+        run: bun run typecheck
 
   lint:
+    name: Code Formatting
     runs-on: ubuntu-latest
 
     steps:
@@ -76,11 +106,14 @@ jobs:
         with:
           version: '0.15.1'
 
-      - name: Check formatting
+      - name: Check Zig formatting
+        working-directory: packages/zig
         run: zig fmt --check src/ build.zig
 
-  cross-compile:
+  integration:
+    name: Integration Tests
     runs-on: ubuntu-latest
+    needs: [zig-core, typescript-sdk]
 
     steps:
       - uses: actions/checkout@v4
@@ -90,26 +123,27 @@ jobs:
         with:
           version: '0.15.1'
 
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
       - name: Install Linux dependencies
         run: |
           sudo apt-get update
           sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev
 
-      - name: Cache Zig artifacts
-        uses: actions/cache@v4
-        with:
-          path: |
-            ~/.cache/zig
-            zig-cache
-          key: cross-compile-zig-0.15.1-${{ hashFiles('build.zig') }}
-          restore-keys: |
-            cross-compile-zig-0.15.1-
+      - name: Build Zig core
+        run: bun run build:core
 
-      - name: Build for all platforms
-        run: |
-          zig build build-linux
-          zig build build-macos
-          echo "Windows cross-compilation requires additional setup"
+      - name: Install TypeScript dependencies
+        run: bun install
+
+      - name: Test TypeScript SDK with built binary
+        run: bun run test:sdk
 
-      - name: List built artifacts
-        run: ls -lh zig-out/bin/
+      - name: Verify create-zyte works
+        run: |
+          bun run create test-app --skip-install
+          ls -la test-app/
+          cat test-app/package.json
diff --git a/README.md b/README.md
@@ -192,6 +192,33 @@ Build native menubar/system tray apps with full platform support:
 - 🔗 **Custom Protocols** - Register custom URL handlers (zyte://)
 - 🎯 **Drag & Drop** - File drag and drop support
 
+## Quick Start
+
+The fastest way to get started is with `create-zyte`:
+
+```bash
+# Create a new Zyte app
+bun create zyte my-app
+
+# Navigate to your app
+cd my-app
+
+# Start development
+bun run dev
+```
+
+Choose from multiple templates:
+- **minimal** - Simplest possible app
+- **full-featured** - Modern styled app with examples
+- **todo-app** - Interactive todo list
+
+```bash
+# Use a specific template
+bun create zyte my-app --template full-featured
+```
+
+**See [create-zyte documentation](./packages/create-zyte/README.md) for all options.**
+
 ## Get Started
 
 ### TypeScript/JavaScript (Recommended)
diff --git a/package.json b/package.json
@@ -13,18 +13,20 @@
     "build": "bun run build:core && bun run build:sdk",
     "build:core": "cd packages/zig && zig build -Doptimize=ReleaseSafe",
     "build:debug": "cd packages/zig && zig build",
-    "build:sdk": "cd packages/ts-zyte && bun run build",
+    "build:sdk": "cd packages/typescript && bun run build",
     "test": "cd packages/zig && zig build test",
-    "test:sdk": "cd packages/ts-zyte && bun test",
+    "test:sdk": "cd packages/typescript && bun test",
+    "typecheck": "cd packages/typescript && bun run typecheck && cd ../create-zyte && bun run typecheck",
     "run": "cd packages/zig && zig build run",
     "run:minimal": "cd packages/zig && zig build run-minimal",
+    "create": "cd packages/create-zyte && bun bin/cli.ts",
     "clean": "rm -rf packages/zig/zig-cache packages/zig/zig-out && bun run clean:packages",
     "clean:packages": "rm -rf packages/*/dist packages/*/node_modules",
     "fmt": "cd packages/zig && zig fmt src/ build.zig",
     "fmt:check": "cd packages/zig && zig fmt --check src/ build.zig",
-    "dev": "cd packages/ts-zyte && bun run dev",
-    "release": "bun run build && bun run publish:sdk",
-    "publish:sdk": "cd packages/ts-zyte && bun publish"
+    "dev": "cd packages/typescript && bun run dev",
+    "release": "bun run build && bun run publish:all",
+    "publish:all": "cd packages/typescript && bun publish && cd ../create-zyte && bun publish"
   },
   "devDependencies": {
     "better-dx": "^0.1.7"
diff --git a/packages/create-zyte/README.md b/packages/create-zyte/README.md
diff --git a/packages/create-zyte/tsconfig.json b/packages/create-zyte/tsconfig.json
@@ -5,11 +5,6 @@
     "isolatedDeclarations": true
   },
   "include": [
-    "src",
-    "bin",
-    "test"
-  ],
-  "exclude": [
-    "test/outputs"
+    "bin"
   ]
 }
diff --git a/packages/typescript/src/index.ts b/packages/typescript/src/index.ts
@@ -116,6 +116,19 @@ export class ZyteApp {
   private config: AppConfig
 
   constructor(config: AppConfig = {}) {
+    // Validate window dimensions
+    if (config.window?.width !== undefined && (config.window.width < 100 || config.window.width > 10000)) {
+      throw new Error(`Invalid window width: ${config.window.width}. Must be between 100 and 10000 pixels.`)
+    }
+    if (config.window?.height !== undefined && (config.window.height < 100 || config.window.height > 10000)) {
+      throw new Error(`Invalid window height: ${config.window.height}. Must be between 100 and 10000 pixels.`)
+    }
+
+    // Validate that either html or url is provided, not both
+    if (config.html && config.url) {
+      console.warn('⚠️  Both html and url provided. URL will take precedence.')
+    }
+
     this.config = {
       window: {
         title: 'Zyte App',
@@ -143,6 +156,14 @@ export class ZyteApp {
       this.config.html = html
     }
 
+    // Validate that we have something to show
+    if (!this.config.html && !this.config.url) {
+      throw new Error(
+        'No content to display. Provide either html or url:\n' +
+        '  show(html, options) or loadURL(url, options)'
+      )
+    }
+
     const args = this.buildArgs()
     const zytePath = await this.findZyteBinary()
 
@@ -151,13 +172,49 @@ export class ZyteApp {
     })
 
     return new Promise((resolve, reject) => {
-      this.process?.on('error', reject)
+      this.process?.on('error', (error: Error & { code?: string }) => {
+        const errorMessage = [
+          `❌ Failed to start Zyte process: ${error.message}`,
+          '',
+        ]
+
+        // Provide platform-specific troubleshooting
+        if (error.code === 'EACCES') {
+          errorMessage.push(
+            'Permission denied. Try making the binary executable:',
+            `  chmod +x ${zytePath}`,
+          )
+        }
+        else if (error.code === 'ENOENT') {
+          errorMessage.push(
+            'Binary not found or not executable.',
+            'Ensure Zyte core is built:',
+            '  bun run build:core',
+          )
+        }
+        else {
+          errorMessage.push(
+            'For troubleshooting, visit:',
+            '  https://github.com/stacksjs/zyte/issues',
+          )
+        }
+
+        reject(new Error(errorMessage.join('\n')))
+      })
+
       this.process?.on('exit', (code) => {
-        if (code === 0) {
+        if (code === 0 || code === null) {
           resolve()
         }
         else {
-          reject(new Error(`Zyte process exited with code ${code}`))
+          reject(new Error(
+            `❌ Zyte process exited with code ${code}\n\n` +
+            'This may indicate:\n' +
+            '  • Invalid window configuration\n' +
+            '  • Malformed HTML content\n' +
+            '  • System resource constraints\n\n' +
+            'Check the console output above for more details.'
+          ))
         }
       })
     })
@@ -229,6 +286,13 @@ export class ZyteApp {
 
   private async findZyteBinary(): Promise<string> {
     if (this.config.zytePath) {
+      if (!existsSync(this.config.zytePath)) {
+        throw new Error(
+          `Custom Zyte binary path not found: ${this.config.zytePath}\n\n` +
+          'Please ensure the path is correct or build the Zyte core:\n' +
+          '  bun run build:core'
+        )
+      }
       return this.config.zytePath
     }
 
@@ -261,7 +325,28 @@ export class ZyteApp {
       }
     }
 
-    throw new Error('Zyte binary not found. Please build the project first with: bun run build:core')
+    // Provide helpful error message with troubleshooting steps
+    const errorMessage = [
+      '❌ Zyte binary not found',
+      '',
+      'Tried the following locations:',
+      ...possiblePaths.map(p => `  • ${p}`),
+      '',
+      'To fix this issue:',
+      '',
+      '1. Build the Zyte core:',
+      '   bun run build:core',
+      '',
+      '2. Or install Zyte globally:',
+      '   bun install -g ts-zyte',
+      '',
+      '3. Or specify a custom binary path:',
+      '   createApp({ zytePath: "/path/to/zyte" })',
+      '',
+      'For more help, visit: https://github.com/stacksjs/zyte',
+    ].join('\n')
+
+    throw new Error(errorMessage)
   }
 
   private checkBinaryExists(path: string): Promise<void> {
diff --git a/packages/typescript/test/index.test.ts b/packages/typescript/test/index.test.ts

Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,6 @@`
`5`	`5`	`"isolatedDeclarations": true`
`6`	`6`	`},`
`7`	`7`	`"include": [`
`8`		`- "src",`
`9`		`- "bin",`
`10`		`- "test"`
`11`		`- ],`
`12`		`- "exclude": [`
`13`		`- "test/outputs"`
	`8`	`+ "bin"`
`14`	`9`	`]`
`15`	`10`	`}`