portapack 0.3.2 → 0.4.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [0.4.0](https://github.com/manicinc/portapack/compare/v0.3.3...v0.4.0) (2025-06-07)
+
+
+### Features
+
+* add initial Vue 3 frontend with Wails integration and project structure ([0a4edd8](https://github.com/manicinc/portapack/commit/0a4edd8b7c14a15acaaf8554536fa1792eec8049))
+
+## [0.3.3](https://github.com/manicinc/portapack/compare/v0.3.2...v0.3.3) (2025-04-20)
+
+
+### Bug Fixes
+
+* typo in link ([e79e1d1](https://github.com/manicinc/portapack/commit/e79e1d105f800550d067d62ec04d0af6888eb82d))
+
 ## [0.3.2](https://github.com/manicinc/portapack/compare/v0.3.1...v0.3.2) (2025-04-18)
 
 

package/README.md

@@ -19,6 +19,8 @@ _Minimal input. Maximal output._
 - [⚙️ CLI Reference](https://manicinc.github.io/portapack/cli)
 - [🛠 Configuration Guide](https://manicinc.github.io/portapack/configuration)
 - [💻 API Reference](https://manicinc.github.io/portapack/api/)
+- [🏛️ Architecture](https://manicinc.github.io/portapack/architecture/)
+- [🚧 Roadmap](https://manicinc.github.io/portapack/roadmap/)
 - [🤝 Contributing Guidelines](https://manicinc.github.io/portapack/contributing)
 
 ## 🚀 Quick Start
@@ -33,26 +35,6 @@ npm install -g portapack
 npx portapack ./index.html -o bundle.html
 ```
 
-### 🧰 CLI Options
-
-```bash
-portapack [input] [options]
-```
-
-| Option                 | Description                             |
-| ---------------------- | --------------------------------------- |
-| `-o, --output <file>`  | Output file path                        |
-| `-r, --recursive [n]`  | Crawl site up to n levels deep          |
-| `--max-depth <n>`      | Explicit crawl depth                    |
-| `-m, --minify`         | Enable all minification                 |
-| `--no-minify-*`        | Disable html, css, or js minify         |
-| `-e, --embed-assets`   | Inline all assets (default: true)       |
-| `--no-embed-assets`    | Leave links as-is                       |
-| `-b, --base-url <url>` | Override base URL resolution            |
-| `-v, --verbose`        | Show debug output                       |
-| `--log-level <lvl>`    | Set log level: debug, info, warn, error |
-| `-d, --dry-run`        | Run without writing file                |
-
 ### 📋 CLI Examples
 
 ```bash
@@ -93,6 +75,7 @@ console.log(result.html); // bundled HTML
 
 ```typescript
 import { pack, LogLevel } from 'portapack';
+import fs from 'fs';
 
 const result = await pack('https://example.com', {
   minifyCss: true,
@@ -101,14 +84,9 @@ const result = await pack('https://example.com', {
   output: 'site.html',
   logLevel: LogLevel.INFO,
 });
-```
-
-### Save to Disk
 
-```typescript
-import fs from 'fs';
+// Save to disk
 fs.writeFileSync('output.html', result.html);
-```
 
 ### Advanced API Usage
 
@@ -118,8 +96,7 @@ You can access individual building blocks too:
 import {
   generatePortableHTML,
   generateRecursivePortableHTML,
-  bundleMultiPageHTML,
-  fetchAndPackWebPage,
+  bundleMultiPageHTML
 } from 'portapack';
 ```
 
@@ -127,19 +104,8 @@ import {
 | --------------------------------- | ------------------------------------- |
 | `generatePortableHTML()`          | Bundle a single file or URL           |
 | `generateRecursivePortableHTML()` | Crawl & bundle entire site            |
-| `fetchAndPackWebPage()`           | Just fetch HTML (no asset processing) |
 | `bundleMultiPageHTML()`           | Combine multiple HTMLs with router    |
 
-## 🤝 Contribute
-
-```bash
-# Get started
-git clone https://github.com/manicinc/portapack
-cd portapack
-npm install
-npm run dev
-```
-
 ## 📊 Project Health
 
 | Metric      | Value                                                                                                                                                           |

package/desktop/README.md

@@ -0,0 +1,112 @@
+# 📦 Portapack Desktop GUI – Documentation
+
+## 📖 Overview
+
+**Portapack Desktop GUI** is a Wails-based cross-platform desktop application with a Vue.js frontend. It provides a user-friendly graphical interface to the `portapack` CLI tool, allowing users to run it with various options through an intuitive UI.
+
+**GitHub Repository:**
+👉 [https://github.com/manicinc/portapack.git](https://github.com/manicinc/portapack.git)
+
+---
+
+## 🧰 Prerequisites
+
+Install the following tools before using the application:
+
+| Tool                          | Install Command                                            |
+| ----------------------------- | ---------------------------------------------------------- |
+| Go ≥ 1.20                     | [https://golang.org/dl/](https://golang.org/dl/)           |
+| Node.js ≥ 18.x (includes npm) | [https://nodejs.org/](https://nodejs.org/)                 |
+| Wails CLI                     | `go install github.com/wailsapp/wails/v2/cmd/wails@latest` |
+| Portapack CLI                 | `npm install -g portapack`                                 |
+
+---
+
+## 🚀 Getting Started
+
+### 1. Clone the Repository
+
+```bash
+git clone https://github.com/manicinc/portapack.git
+cd portapack/desktop
+```
+
+### 2. Run the App in Development Mode
+
+```bash
+wails dev
+```
+
+Wails will automatically install frontend dependencies and launch the app with hot-reloading.
+
+---
+
+## 🏗️ Build for Production
+
+To generate a distributable binary:
+
+```bash
+wails build
+```
+
+This creates a standalone executable in `build/bin/` for your platform with all assets embedded.
+
+---
+
+## ⚙️ Features
+
+* Full support for `portapack` CLI options via GUI
+* Input/output paths, recursive crawling, and minification toggles
+* Toggle dark/light mode
+* View real-time command output
+* Responsive, theme-aware layout
+
+---
+
+## 🎛️ CLI Options Mapped to UI
+
+| UI Control              | CLI Flag(s)            |
+| ----------------------- | ---------------------- |
+| Input HTML/URL          | `<input>`              |
+| Output File Path        | `-o`, `--output`       |
+| Enable All Minification | `-m`, `--minify`       |
+| Disable Minify (HTML)   | `--no-minify-html`     |
+| Disable Minify (CSS)    | `--no-minify-css`      |
+| Disable Minify (JS)     | `--no-minify-js`       |
+| Embed Assets            | `-e`, `--embed-assets` |
+| Recursive Crawl         | `-r`, `--recursive`    |
+| Max Depth               | (argument to `-r`)     |
+| Base URL                | `-b`, `--base-url`     |
+| Dry Run                 | `-d`, `--dry-run`      |
+| Verbose Logging         | `-v`, `--verbose`      |
+| Log Level               | `--log-level <level>`  |
+
+---
+
+## 🐛 Troubleshooting
+
+### Portapack not found?
+
+Make sure it's globally installed:
+
+```bash
+npm install -g portapack
+```
+
+And accessible in your shell:
+
+```bash
+portapack --help
+```
+
+If it still fails, you may need to add the npm global bin directory to your PATH:
+
+```bash
+export PATH="$PATH:$(npm bin -g)"
+```
+
+---
+
+## 🪪 License
+
+Font: **Nunito** – licensed under the [SIL Open Font License v1.1](https://scripts.sil.org/OFL) (included in the repo).

package/desktop/app.go

@@ -0,0 +1,61 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"os/exec" // For spawning subprocesses
+	"strings" // For joining command arguments
+)
+
+// App struct
+type App struct {
+	ctx context.Context
+}
+
+// NewApp creates a new App application struct
+func NewApp() *App {
+	return &App{}
+}
+
+// startup is called when the app starts.
+// The context is saved
+// so we can call the runtime methods
+func (a *App) startup(ctx context.Context) {
+	a.ctx = ctx
+}
+
+// Greet returns a greeting for the given name (keeping existing method)
+func (a *App) Greet(name string) string {
+	return fmt.Sprintf("Hello %s, It's show time!", name)
+}
+
+// RunPortapack executes the portapack CLI command with given arguments
+func (a *App) RunPortapack(args []string) (string, error) {
+	// Prepend "portapack" to the arguments slice
+	cmdArgs := append([]string{}, args...) // Create a new slice to avoid modifying the original 'args'
+
+	// Construct the command
+	cmd := exec.Command("portapack", cmdArgs...) // "portapack" is the command itself
+
+	// Capture stdout and stderr
+	var stdout, stderr strings.Builder
+	cmd.Stdout = &stdout
+	cmd.Stderr = &stderr
+
+	fmt.Printf("Executing command: portapack %s\n", strings.Join(cmdArgs, " "))
+
+	// Run the command
+	err := cmd.Run()
+
+	// Combine output for display
+	output := stdout.String()
+	if stderr.Len() > 0 {
+		output += "\nError:\n" + stderr.String()
+	}
+
+	if err != nil {
+		return output, fmt.Errorf("portapack command failed: %w - %s", err, output)
+	}
+
+	return output, nil
+}

package/desktop/frontend/README.md

@@ -0,0 +1,8 @@
+# Vue 3 + Vite
+
+This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs,
+check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+
+## Recommended IDE Setup
+
+- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)

package/desktop/frontend/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8"/>
+    <meta content="width=device-width, initial-scale=1.0" name="viewport"/>
+    <title>desktop</title>
+</head>
+<body>
+<div id="app"></div>
+<script src="./src/main.js" type="module"></script>
+</body>
+</html>
+