gcf-board 0.2.0 → 0.2.1

package/README.md

@@ -17,7 +17,15 @@ gcf-board                # http://127.0.0.1:4317
 gcf-board --port 4400
 ```
 
-It prints `http://127.0.0.1:4317/?t=<token>`: open that URL once. It sets a cookie, and the plain address works after that. Add a project by its folder (one that has `gcf/`) under **Projects**.
+It opens the board in your browser (the URL with the token, `http://127.0.0.1:4317/?t=<token>`, is printed too; `--no-open` skips the browser). Started again while it runs, it just opens the running board. Add a project by its folder (one that has `gcf/`) under **Projects**.
+
+**Desktop shortcut**: run once
+
+```bash
+gcf-board shortcut                 # or: gcf-board shortcut --port 4400
+```
+
+It puts **GCF Board** on the desktop (Windows: a shortcut whose server console starts minimized; macOS: `GCF Board.command`; Linux: an application entry). Double-click it: the board starts and opens, or opens if it already runs. Run the command again after moving Node.js.
 
 ## What it does
 

package/dist/server/desktop.js

@@ -0,0 +1,67 @@
+// The board without a console: open it in the browser, and a desktop shortcut that starts it.
+import { chmodSync, mkdirSync, writeFileSync } from 'node:fs';
+import { spawn, spawnSync } from 'node:child_process';
+import os from 'node:os';
+import path from 'node:path';
+const NAME = 'GCF Board';
+/** Open a URL in the default browser; best effort, the URL is printed anyway. */
+export function openInBrowser(url) {
+    const [cmd, args] = process.platform === 'win32'
+        ? ['cmd', ['/c', 'start', '""', url]]
+        : process.platform === 'darwin'
+            ? ['open', [url]]
+            : ['xdg-open', [url]];
+    try {
+        spawn(cmd, args, { detached: true, stdio: 'ignore', windowsHide: true }).unref();
+    }
+    catch {
+        // No browser to open: the operator opens the printed URL.
+    }
+}
+/** A PowerShell single-quoted string: a quote inside is doubled. */
+const psQuote = (s) => `'${s.replaceAll("'", "''")}'`;
+export function shortcutPlan(platform, node, main, port) {
+    const args = ['--port', String(port)];
+    if (platform === 'win32')
+        return {
+            // A .lnk is a binary file: WScript.Shell writes it. Minimized: the server's console stays out
+            // of the way.
+            powershell: [
+                `$d = [Environment]::GetFolderPath('Desktop')`,
+                `$s = (New-Object -ComObject WScript.Shell).CreateShortcut((Join-Path $d '${NAME}.lnk'))`,
+                `$s.TargetPath = ${psQuote(node)}`,
+                `$s.Arguments = ${psQuote(`"${main}" ${args.join(' ')}`)}`,
+                `$s.WindowStyle = 7`,
+                `$s.Description = 'Start the GCF board and open it in the browser'`,
+                `$s.Save()`,
+                `Join-Path $d '${NAME}.lnk'`,
+            ].join('; '),
+        };
+    const command = `"${node}" "${main}" ${args.join(' ')}`;
+    if (platform === 'darwin')
+        return {
+            file: path.join(os.homedir(), 'Desktop', `${NAME}.command`),
+            text: `#!/bin/sh\nexec ${command}\n`,
+        };
+    return {
+        file: path.join(os.homedir(), '.local', 'share', 'applications', 'gcf-board.desktop'),
+        text: `[Desktop Entry]\nType=Application\nName=${NAME}\nExec=${command}\nTerminal=false\n` +
+            'Categories=Development;\n',
+    };
+}
+/** Write the shortcut for this machine; returns where it is. */
+export function createShortcut(main, port) {
+    const plan = shortcutPlan(process.platform, process.execPath, main, port);
+    if ('powershell' in plan) {
+        const r = spawnSync('powershell', ['-NoProfile', '-Command', plan.powershell], {
+            encoding: 'utf8',
+        });
+        if (r.status !== 0)
+            throw new Error(`the shortcut was not made: ${r.stderr.trim()}`);
+        return r.stdout.trim();
+    }
+    mkdirSync(path.dirname(plan.file), { recursive: true });
+    writeFileSync(plan.file, plan.text);
+    chmodSync(plan.file, 0o755);
+    return plan.file;
+}

package/dist/server/main.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
-// `gcf-board [--port <n>]`: the board on http://127.0.0.1:<port>, 4317 by default. It prints the
-// URL with this machine's token; open that one, the plain address answers 401.
+// `gcf-board [--port <n>] [--no-open]`: the board on http://127.0.0.1:<port>, 4317 by default,
+// opened in the browser with this machine's token. A board already on the port is opened, not
+// started twice. `gcf-board shortcut [--port <n>]` puts a desktop shortcut that does the same.
 import { existsSync } from 'node:fs';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
@@ -8,6 +9,7 @@ import { parseArgs } from 'node:util';
 import { boardToken } from './auth.js';
 import { aiFactoryEntry } from './cli.js';
 import { createApp } from './app.js';
+import { createShortcut, openInBrowser } from './desktop.js';
 const HERE = path.dirname(fileURLToPath(import.meta.url));
 /**
  * The built page: `dist/web` beside `server/` when run from the source (the source `web/` is
@@ -20,14 +22,37 @@ function webDir() {
         : path.resolve(HERE, '..', 'web');
 }
 async function main() {
-    const { values } = parseArgs({ options: { port: { type: 'string', default: '4317' } } });
+    const { values, positionals } = parseArgs({
+        allowPositionals: true,
+        options: {
+            port: { type: 'string', default: '4317' },
+            'no-open': { type: 'boolean', default: false },
+        },
+    });
     const port = Number(values.port);
     if (!Number.isInteger(port) || port < 1 || port > 65535)
         throw new Error('--port is a number from 1 to 65535');
+    if (positionals[0] === 'shortcut') {
+        console.log(`gcf-board: shortcut ${createShortcut(fileURLToPath(import.meta.url), port)}`);
+        return;
+    }
+    if (positionals.length)
+        throw new Error(`unknown command: ${positionals.join(' ')}`);
     const token = await boardToken();
+    const url = `http://127.0.0.1:${port}/?t=${token}`;
+    const open = () => !values['no-open'] && openInBrowser(url);
     const app = createApp({ entry: aiFactoryEntry(), token, port, web: webDir() });
+    app.on('error', (e) => {
+        if (e.code !== 'EADDRINUSE')
+            throw e;
+        // A second start, from the shortcut most likely: the board runs already, show it.
+        console.log(`gcf-board: already running on port ${port}, opening it`);
+        open();
+        setTimeout(() => process.exit(0), 500);
+    });
     app.listen(port, '127.0.0.1', () => {
-        console.log(`gcf-board: http://127.0.0.1:${port}/?t=${token}`);
+        console.log(`gcf-board: ${url}`);
+        open();
     });
 }
 main().catch((e) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gcf-board",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "A local web board for GCF game projects: shows `gcf board --json` and runs the same ai-factory gcf commands an operator runs in a console",
   "type": "module",
   "license": "MIT",