misku-native-view-cli 0.1.0-ci.1.2

package/README.md

@@ -0,0 +1,195 @@
+# Misku Native Views
+
+Misku Native Views is a small Windows-first launcher that turns configured web URLs into lightweight desktop apps using Rust, Tauri 2, and Microsoft Edge WebView2.
+
+It is inspired by tools like Pake, but keeps the workflow simple: edit `apps.toml`, build portable executables, and optionally install Start Menu shortcuts.
+
+## Features
+
+- Multiple web apps from one `apps.toml` file.
+- One portable `.exe` copy per app id.
+- Isolated WebView2 profile directories per app.
+- Custom window and shortcut icons.
+- CLI command to add or update apps by URL.
+- Optional Start Menu shortcut installation.
+- Cargo target output outside the repo to avoid OneDrive lock/sync issues.
+
+## Requirements
+
+- Windows 11.
+- Rust stable with the MSVC toolchain.
+- Microsoft C++ Build Tools with Desktop development with C++.
+- Microsoft Edge WebView2 Evergreen Runtime.
+- Python + Pillow only if you want to convert `.webp`, `.png`, or `.jpg` files into `.ico` icons.
+
+## Configure Apps
+
+Apps live in `apps.toml`:
+
+```toml
+[[apps]]
+id = "tftacademy"
+name = "TFT Academy"
+url = "https://tftacademy.com/tierlist/comps/"
+icon = "icons/tftacademy.ico"
+width = 1280
+height = 860
+min_width = 900
+min_height = 640
+isolated_profile = true
+devtools = false
+resizable = true
+zoom_hotkeys_enabled = true
+```
+
+Supported fields:
+
+- `id`: short identifier used by the CLI and executable name.
+- `name`: window title.
+- `url`: `https://` or `http://` URL.
+- `icon`: optional `.ico` or `.png`, relative to `apps.toml`.
+- `width`, `height`: initial window size.
+- `min_width`, `min_height`: minimum window size.
+- `isolated_profile`: separates cookies, cache, and sessions per app.
+- `devtools`: enables DevTools for that app.
+- `user_agent`: optional custom user agent.
+- `resizable`: allows resizing the window.
+- `zoom_hotkeys_enabled`: enables native zoom shortcuts.
+
+## CLI
+
+Use the helper script during development:
+
+```powershell
+.\scripts\misku.ps1 --list
+.\scripts\misku.ps1 add https://chatgpt.com
+.\scripts\misku.ps1 add --id tftacademy --name "TFT Academy" https://tftacademy.com/tierlist/comps/
+.\scripts\misku.ps1 --app tftacademy
+```
+
+`add` creates a new profile when the app does not exist. If the generated `id`, explicit `--id`, or exact URL already exists, it updates the existing profile instead of creating a duplicate.
+
+For raw Cargo commands, use `scripts/dev.ps1` so Visual Studio Build Tools are loaded and Cargo output goes to `%LOCALAPPDATA%`:
+
+```powershell
+.\scripts\dev.ps1 check
+.\scripts\dev.ps1 run -p misku-native-views "--" --list
+```
+
+## Build Portable Apps
+
+Generate `portable/` with one executable per configured app:
+
+```powershell
+.\scripts\build-portable.ps1
+```
+
+Run an app directly:
+
+```powershell
+.\portable\tftacademy.exe
+```
+
+If a profile defines `icon`, the build script also creates a matching `.lnk` shortcut with that icon. The `.exe` keeps the base embedded app icon; use the generated shortcut for the per-app Explorer/Start Menu icon.
+
+## Package And Install With pnpm
+
+Build the CLI package and create a local pnpm-installable tarball:
+
+```powershell
+pnpm pack
+```
+
+`pnpm pack` runs `scripts/build-pnpm-package.ps1` first. The packed package includes the `misku-nv` wrapper, the prebuilt native executable, the default `apps.toml`, icons. The `misku-nv` wrapper prepares `%APPDATA%\Misku Native Views` on first use. End users do not need Rust, Cargo, or Visual Studio Build Tools to install the CLI package.
+
+Install the published package globally:
+
+```powershell
+pnpm install -g misku-native-view-cli
+```
+
+Or install the local tarball generated by `pnpm pack`:
+
+```powershell
+pnpm install -g .\misku-native-view-cli-0.1.0.tgz
+```
+
+Use the installed CLI:
+
+```powershell
+misku-nv https://github.com --name GitHub
+misku-nv --list
+misku-nv github
+```
+
+The URL shorthand creates or updates a profile and opens it immediately. Add `--no-open` if you only want to save the profile:
+
+```powershell
+misku-nv https://github.com --name GitHub --no-open
+```
+
+When installed through pnpm, `misku-nv` stores the default editable config in `%APPDATA%\Misku Native Views\apps.toml`. If you run it from a folder that already contains `apps.toml`, or pass `--config <path>`, that config is used instead.
+
+## GitHub CI/CD
+
+The repository includes two GitHub Actions workflows:
+
+- `CI`: runs on every push, pull request, and manual dispatch. It builds the Rust/Tauri executable on Windows, packs the pnpm package, installs the generated tarball globally with pnpm, and smoke-tests `misku-nv`.
+- `Publish package`: runs on pushes to `main` or `master`, tags matching `v*`, and manual dispatch. It builds and smoke-tests the package, publishes it to the npm registry, then downloads the published version with pnpm and smoke-tests `misku-nv`.
+
+To enable publishing, create a GitHub repository secret named `NPM_TOKEN` with an npm automation token that can publish `misku-native-view-cli`.
+
+Pushes to `main` or `master` publish an automatic version like `0.1.0-ci.<run>.<attempt>` with the `latest` dist-tag, so this command installs the newest pushed build:
+
+```powershell
+pnpm install -g misku-native-view-cli
+```
+
+Tags such as `v0.1.0` publish that exact stable version as `latest`.
+
+## Start Menu Shortcuts
+
+Install generated shortcuts for the current Windows user:
+
+```powershell
+.\scripts\install-start-menu.ps1
+```
+
+Remove them:
+
+```powershell
+.\scripts\install-start-menu.ps1 -Uninstall
+```
+
+## Icons
+
+Convert image files into multi-size Windows `.ico` files:
+
+```powershell
+.\scripts\convert-icon.ps1 .\downloads\logo.webp .\icons\myapp.ico
+```
+
+Use a solid padding background when needed:
+
+```powershell
+.\scripts\convert-icon.ps1 .\downloads\logo.webp .\icons\myapp.ico -Background "#FFFFFF"
+```
+
+Then reference the icon from `apps.toml`:
+
+```toml
+icon = "icons/myapp.ico"
+```
+
+## Publishing Notes
+
+The repository intentionally ignores generated and local-only files such as:
+
+- `target/`
+- `src-tauri/target/`
+- `portable/`
+- `screenshots/`
+- `.env` and `.env.*`
+- logs
+
+Do not commit private sessions, generated portable executables, local screenshots, or environment files.

package/bin/misku.js

@@ -0,0 +1,289 @@
+#!/usr/bin/env node
+
+const { spawn, spawnSync } = require("node:child_process");
+const fs = require("node:fs");
+const os = require("node:os");
+const path = require("node:path");
+
+const packageRoot = path.resolve(__dirname, "..");
+const portableDir = path.join(packageRoot, "portable");
+const nativeExe = path.join(portableDir, "misku-native-views.exe");
+const packageConfig = path.join(portableDir, "apps.toml");
+const packageIcons = path.join(portableDir, "icons");
+
+function fail(message) {
+  console.error(`misku-nv: ${message}`);
+  process.exit(1);
+}
+
+function printHelp() {
+  console.log(`Misku Native Views CLI
+
+Uso:
+  misku-nv <url> [--name <nombre>] [--id <id>] [--icon <ruta>] [--no-open]
+  misku-nv <id>
+  misku-nv --list
+  misku-nv add [opciones] <url> [url...]
+
+Ejemplos:
+  misku-nv https://github.com --name GitHub
+  misku-nv github
+  misku-nv --list
+
+Opciones rapidas:
+  -n, --name <nombre>  Nombre visible de la app.
+  -i, --id <id>        Id del perfil. Si ya existe, se actualiza.
+  --icon <ruta>        Icono .ico o .png relativo a apps.toml.
+  --no-open            Crea o actualiza el perfil sin abrirlo.
+  -c, --config <ruta>  Archivo apps.toml alternativo.`);
+}
+
+function getExplicitConfigArgs(args) {
+  for (let index = 0; index < args.length; index += 1) {
+    const arg = args[index];
+
+    if (arg === "--config" || arg === "-c") {
+      const value = args[index + 1];
+      return value ? ["--config", value] : null;
+    }
+
+    if (arg.startsWith("--config=")) {
+      return ["--config", arg.slice("--config=".length)];
+    }
+  }
+
+  return null;
+}
+
+function hasExplicitConfig(args) {
+  return getExplicitConfigArgs(args) !== null;
+}
+
+function getUserConfigDir() {
+  const appData = process.env.APPDATA || path.join(os.homedir(), "AppData", "Roaming");
+  return path.join(appData, "Misku Native Views");
+}
+
+function copyDirectoryIfMissing(source, destination) {
+  if (!fs.existsSync(source) || fs.existsSync(destination)) {
+    return;
+  }
+
+  fs.mkdirSync(path.dirname(destination), { recursive: true });
+  fs.cpSync(source, destination, {
+    recursive: true,
+    errorOnExist: false,
+    force: false
+  });
+}
+
+function ensureUserConfig() {
+  const userConfigDir = getUserConfigDir();
+  const userConfig = path.join(userConfigDir, "apps.toml");
+  fs.mkdirSync(userConfigDir, { recursive: true });
+
+  if (!fs.existsSync(userConfig)) {
+    if (!fs.existsSync(packageConfig)) {
+      fail(`no encontre la configuracion incluida en ${packageConfig}`);
+    }
+    fs.copyFileSync(packageConfig, userConfig);
+  }
+
+  copyDirectoryIfMissing(packageIcons, path.join(userConfigDir, "icons"));
+
+  return userConfig;
+}
+
+function withDefaultConfig(args, rawArgs) {
+  if (hasExplicitConfig(args)) {
+    return args;
+  }
+
+  const explicitConfigArgs = getExplicitConfigArgs(rawArgs);
+  if (explicitConfigArgs) {
+    return [...explicitConfigArgs, ...args];
+  }
+
+  const cwdConfig = path.join(process.cwd(), "apps.toml");
+  if (fs.existsSync(cwdConfig)) {
+    return args;
+  }
+
+  return ["--config", ensureUserConfig(), ...args];
+}
+
+function looksLikeUrl(value) {
+  return /^https?:\/\//i.test(value)
+    || /^localhost(?::\d+)?(?:\/|$)/i.test(value)
+    || /^[^\s.]+\.[^\s]+/.test(value);
+}
+
+function pushOptionWithValue(target, args, index, canonicalName) {
+  const value = args[index + 1];
+  if (!value) {
+    fail(`falta el valor despues de ${args[index]}`);
+  }
+  target.push(canonicalName || args[index], value);
+  return index + 1;
+}
+
+function parseFriendlyUrlCommand(rawArgs) {
+  let url = null;
+  let openAfterAdd = true;
+  const addArgs = [];
+
+  for (let index = 0; index < rawArgs.length; index += 1) {
+    const arg = rawArgs[index];
+
+    if (arg === "--no-open") {
+      openAfterAdd = false;
+      continue;
+    }
+
+    if (arg === "--open") {
+      openAfterAdd = true;
+      continue;
+    }
+
+    if (arg === "--name" || arg === "-n") {
+      index = pushOptionWithValue(addArgs, rawArgs, index, arg);
+      continue;
+    }
+
+    if (arg === "--id" || arg === "-i") {
+      index = pushOptionWithValue(addArgs, rawArgs, index, arg);
+      continue;
+    }
+
+    if (arg === "--icon") {
+      index = pushOptionWithValue(addArgs, rawArgs, index, arg);
+      continue;
+    }
+
+    if (arg === "--config" || arg === "-c") {
+      index = pushOptionWithValue(addArgs, rawArgs, index, arg);
+      continue;
+    }
+
+    if (arg.startsWith("--name=")) {
+      addArgs.push("--name", arg.slice("--name=".length));
+      continue;
+    }
+
+    if (arg.startsWith("--id=")) {
+      addArgs.push("--id", arg.slice("--id=".length));
+      continue;
+    }
+
+    if (arg.startsWith("--icon=")) {
+      addArgs.push("--icon", arg.slice("--icon=".length));
+      continue;
+    }
+
+    if (arg.startsWith("--config=")) {
+      addArgs.push("--config", arg.slice("--config=".length));
+      continue;
+    }
+
+    if (!arg.startsWith("-") && !url && looksLikeUrl(arg)) {
+      url = arg;
+      addArgs.push(arg);
+      continue;
+    }
+
+    return null;
+  }
+
+  if (!url) {
+    return null;
+  }
+
+  return { addArgs, openAfterAdd };
+}
+
+function runNative(args, options = {}) {
+  const result = spawnSync(nativeExe, args, {
+    cwd: process.cwd(),
+    encoding: "utf8",
+    stdio: options.capture ? "pipe" : "inherit",
+    windowsHide: false
+  });
+
+  if (result.error) {
+    fail(result.error.message);
+  }
+
+  if (result.signal) {
+    fail(`proceso terminado por ${result.signal}`);
+  }
+
+  return result;
+}
+
+function openNative(args) {
+  const child = spawn(nativeExe, args, {
+    cwd: process.cwd(),
+    detached: true,
+    stdio: "ignore",
+    windowsHide: false
+  });
+
+  child.unref();
+}
+
+function parseUpsertedId(output) {
+  const match = output.match(/^(?:creado|actualizado):\s+([^\s]+)\s+->/m);
+  return match ? match[1] : null;
+}
+
+if (process.platform !== "win32") {
+  fail("esta version empaquetada solo soporta Windows.");
+}
+
+if (!fs.existsSync(nativeExe)) {
+  fail(`no encontre el binario nativo en ${nativeExe}. Ejecuta "pnpm run build:package" antes de empaquetar.`);
+}
+
+const rawArgs = process.argv.slice(2);
+
+if (rawArgs.length === 0 || (rawArgs.length === 1 && (rawArgs[0] === "--help" || rawArgs[0] === "-h"))) {
+  printHelp();
+  process.exit(0);
+}
+
+const friendlyCommand = parseFriendlyUrlCommand(rawArgs);
+if (friendlyCommand) {
+  const addArgs = withDefaultConfig(["add", ...friendlyCommand.addArgs], rawArgs);
+  const addResult = runNative(addArgs, { capture: friendlyCommand.openAfterAdd });
+
+  if (friendlyCommand.openAfterAdd) {
+    if (addResult.stdout) {
+      process.stdout.write(addResult.stdout);
+    }
+    if (addResult.stderr) {
+      process.stderr.write(addResult.stderr);
+    }
+  }
+
+  if (addResult.status !== 0) {
+    process.exit(addResult.status ?? 1);
+  }
+
+  if (!friendlyCommand.openAfterAdd) {
+    process.exit(0);
+  }
+
+  const appId = parseUpsertedId(addResult.stdout || "");
+  if (!appId) {
+    fail("no pude detectar el id del perfil creado.");
+  }
+
+  openNative(withDefaultConfig(["--app", appId], rawArgs));
+  process.exit(0);
+}
+
+const args = withDefaultConfig(rawArgs, rawArgs);
+const result = runNative(args);
+process.exit(result.status ?? 1);
+
+

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "misku-native-view-cli",
+  "version": "0.1.0-ci.1.2",
+  "description": "Installable CLI for launching websites as native Windows WebView apps",
+  "license": "UNLICENSED",
+  "type": "commonjs",
+  "os": [
+    "win32"
+  ],
+  "cpu": [
+    "x64"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "bin": {
+    "misku-nv": "./bin/misku.js",
+    "misku": "./bin/misku.js",
+    "misku-native-views": "./bin/misku.js"
+  },
+  "files": [
+    "bin/",
+    "portable/misku-native-views.exe",
+    "portable/apps.toml",
+    "portable/icons/",
+    "README.md"
+  ],
+  "keywords": [
+    "tauri",
+    "webview",
+    "windows",
+    "cli",
+    "desktop"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "scripts": {}
+}

package/portable/apps.toml

@@ -0,0 +1,27 @@
+[[apps]]
+id = "tftacademy"
+name = "TFT Academy"
+url = "https://tftacademy.com/tierlist/comps/"
+icon = "icons/tftacademy.ico"
+width = 1280
+height = 860
+min_width = 900
+min_height = 640
+isolated_profile = true
+devtools = true
+resizable = true
+zoom_hotkeys_enabled = true
+
+[[apps]]
+id = "x"
+name = "X"
+url = "https://x.com/home"
+icon = "icons/twitter.ico"
+width = 1280
+height = 860
+min_width = 900
+min_height = 420
+isolated_profile = true
+devtools = false
+resizable = true
+zoom_hotkeys_enabled = false