gitdog 0.1.0 → 0.1.1

package/README.md

@@ -10,14 +10,14 @@
 
 <p align="center">
   <a href="https://www.npmjs.com/package/gitdog"><img src="https://img.shields.io/npm/v/gitdog?logo=npm&amp;color=CB3837" alt="npm version"></a>
-  <a href="https://www.npmjs.com/package/gitdog"><img src="https://img.shields.io/npm/dm/gitdog?color=555" alt="npm downloads"></a>
   <a href="https://github.com/hyodotdev/gitdog-cli/actions/workflows/ci.yml"><img src="https://github.com/hyodotdev/gitdog-cli/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI"></a>
+  <a href="https://github.com/hyodotdev/gitdog-cli/actions/workflows/release.yml"><img src="https://github.com/hyodotdev/gitdog-cli/actions/workflows/release.yml/badge.svg" alt="npm release"></a>
   <a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%3E%3D22.14.0-3c873a?logo=nodedotjs&amp;logoColor=white" alt="Node.js 22.14 or later"></a>
   <a href="https://gitdog.dev"><img src="https://img.shields.io/badge/Gitdog-gitdog.dev-111" alt="Gitdog website"></a>
 </p>
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/hyodotdev/gitdog-cli/main/.github/assets/terminal.svg" alt="Gitdog terminal: connect a project, configure automation and review pending actions" width="800">
+  <img src="https://raw.githubusercontent.com/hyodotdev/gitdog-cli/main/.github/assets/terminal.svg?v=0.1.1" alt="Gitdog terminal: connect a project, configure automation and review pending actions" width="800">
 </p>
 
 Connect repositories, configure Gitdog's issue and discussion assistants, review

package/dist/api-keys.d.ts

@@ -11,5 +11,7 @@ export type ProjectKey = {
 };
 export declare function projectHttpUrl(apiUrl: string): string;
 export declare function readProjectKey(path: string): Promise<ProjectKey>;
+/** Refuse key paths that Git would track, so secrets are not committed. */
+export declare function assertUntrackedKeyPath(path: string): Promise<void>;
 export declare function saveProjectKey(path: string, key: ProjectKey): Promise<void>;
 export declare function callWithProjectKey<T>(apiUrl: string, keyFile: string | undefined, rawKey: string | undefined, kind: string, path: string, args: unknown, timeoutMs: number): Promise<T>;

package/dist/api-keys.js

@@ -1,7 +1,9 @@
-import { mkdir, open, readFile, rm } from "node:fs/promises";
-import { dirname, resolve } from "node:path";
+import { execFile } from "node:child_process";
+import { promisify } from "node:util";
+import { mkdir, open, readFile, realpath, rm } from "node:fs/promises";
+import { dirname, join, relative, resolve } from "node:path";
 import { asRecord } from "./ui.js";
-import { validateUrl } from "./storage.js";
+import { exists, validateUrl } from "./storage.js";
 export function projectHttpUrl(apiUrl) {
     return validateUrl(process.env.GITDOG_HTTP_URL ??
         apiUrl.replace(/\.convex\.cloud$/, ".convex.site"), "Project HTTP URL");
@@ -39,6 +41,48 @@ export async function readProjectKey(path) {
         expiresAt: key.expiresAt,
     };
 }
+/** Refuse key paths that Git would track, so secrets are not committed. */
+export async function assertUntrackedKeyPath(path) {
+    let directory = dirname(path);
+    while (!(await exists(directory))) {
+        const parent = dirname(directory);
+        if (parent === directory)
+            return;
+        directory = parent;
+    }
+    const canonicalDirectory = await realpath(directory);
+    const canonicalPath = join(canonicalDirectory, relative(directory, path));
+    try {
+        const { stdout } = await promisify(execFile)("git", ["rev-parse", "--is-inside-work-tree"], {
+            cwd: canonicalDirectory,
+            env: { ...process.env, LC_ALL: "C" },
+            timeout: 5000,
+        });
+        if (stdout.trim() === "false")
+            return;
+        if (stdout.trim() !== "true")
+            throw new Error("Unexpected Git work tree result");
+    }
+    catch (error) {
+        const gitError = error;
+        if (gitError.code === 128 &&
+            /fatal: not a git repository/i.test(gitError.stderr ?? ""))
+            return;
+        throw new Error("Could not verify the key path with Git. Fix Git configuration or choose the default private key location.");
+    }
+    try {
+        await promisify(execFile)("git", ["check-ignore", "-q", "--", canonicalPath], {
+            cwd: canonicalDirectory,
+            env: { ...process.env, LC_ALL: "C" },
+            timeout: 5000,
+        });
+    }
+    catch (error) {
+        if (error.code === 1)
+            throw new Error("The key file would be inside a Git repository and not ignored. Choose a path outside the repository or add it to .gitignore.");
+        throw new Error("Could not verify Git ignore rules for the key path. No key was issued.");
+    }
+}
 export async function saveProjectKey(path, key) {
     await mkdir(dirname(path), { recursive: true, mode: 0o700 });
     const handle = await open(path, "wx", 0o600);

package/dist/commands.js

@@ -7,7 +7,7 @@ import { login, logout, openBrowser } from "./auth.js";
 import { API_CATALOG, publicOperation } from "./catalog.js";
 import { BOOLEAN_SETTINGS, STYLE_SETTINGS, ProjectContext, limitParser, } from "./projects.js";
 import { DEFAULT_API_URL, DEFAULT_SITE_URL, SessionStore, validateUrl, configDirectory, exists, } from "./storage.js";
-import { readProjectKey, saveProjectKey, projectHttpUrl } from "./api-keys.js";
+import { assertUntrackedKeyPath, readProjectKey, saveProjectKey, projectHttpUrl, } from "./api-keys.js";
 import { Ui, VERSION, asRecord, integer } from "./ui.js";
 const text = (value) => typeof value === "string" ? value : undefined;
 const number = (value) => typeof value === "number" ? value : undefined;
@@ -164,6 +164,8 @@ export function createProgram(dependencies = {}) {
         const out = text(opts.out);
         if (out && (await exists(resolve(out))))
             throw new Error("The output file already exists. Choose a new private path.");
+        if (out)
+            await assertUntrackedKeyPath(resolve(out));
         const name = text(opts.name) ?? "CLI key";
         const scopes = flag(opts.write) ? ["read", "write"] : ["read"];
         const issued = await api.call("action", "apiKeys/action:create", {

package/dist/projects.js

@@ -1,5 +1,6 @@
 import { execFile } from "node:child_process";
 import { promisify } from "node:util";
+import { homedir } from "node:os";
 import { dirname, join, resolve } from "node:path";
 import { exists, readJson, writeJson } from "./storage.js";
 import { asRecord, integer } from "./ui.js";
@@ -83,13 +84,18 @@ export function validateProjectConfig(value) {
 export async function findConfig(explicit, cwd = process.cwd()) {
     if (explicit)
         return resolve(cwd, explicit);
+    // Stop at the repository root or home so a file planted in a shared parent
+    // directory cannot choose the project.
     let directory = resolve(cwd);
+    const home = resolve(homedir());
     while (true) {
         const path = join(directory, "gitdog.json");
         if (await exists(path))
             return path;
         const parent = dirname(directory);
-        if (parent === directory)
+        if (parent === directory ||
+            directory === home ||
+            (await exists(join(directory, ".git"))))
             return undefined;
         directory = parent;
     }

package/dist/storage.js

@@ -1,4 +1,4 @@
-import { chmod, mkdir, open, readFile, rename, rm, stat, } from "node:fs/promises";
+import { chmod, mkdir, open, readFile, rename, rmdir, rm, stat, } from "node:fs/promises";
 import { homedir } from "node:os";
 import { dirname, join } from "node:path";
 import { randomUUID } from "node:crypto";
@@ -102,13 +102,24 @@ export class SessionStore {
         while (!handle) {
             signal?.throwIfAborted();
             if (Date.now() >= deadline)
-                throw new Error(`Authentication lock timed out. Check that another Gitdog process is not running; stale lock: ${path}.`);
+                throw new Error(`Authentication lock timed out. Check that another Gitdog process is not running; stale lock: ${path} (recovery gate: ${path}.recovery).`);
             try {
-                handle = await open(path, "wx", 0o600);
+                const created = await open(path, "wx", 0o600);
+                try {
+                    await created.writeFile(String(process.pid));
+                }
+                catch (error) {
+                    await created.close();
+                    await rm(path, { force: true });
+                    throw error;
+                }
+                handle = created;
             }
             catch (error) {
                 if (error.code !== "EEXIST")
                     throw error;
+                if (await removeAbandonedLock(path))
+                    continue;
                 if (Date.now() >= deadline)
                     throw new Error(`Another Gitdog process is updating authentication. Retry later; if it crashed, remove ${path}.`);
                 await new Promise((resolve) => setTimeout(resolve, Math.min(100, Math.max(1, deadline - Date.now()))));
@@ -124,6 +135,42 @@ export class SessionStore {
         }
     }
 }
+/** Remove a lock whose recorded owner process no longer exists. */
+async function removeAbandonedLock(path) {
+    const recovery = `${path}.recovery`;
+    try {
+        await mkdir(recovery, { mode: 0o700 });
+    }
+    catch {
+        return false;
+    }
+    try {
+        // Re-read under the recovery mutex: another waiter may have replaced the
+        // dead owner's lock with a live lock before this cleaner acquired the gate.
+        const content = (await readFile(path, "utf8")).trim();
+        if (!/^[1-9]\d*$/.test(content))
+            return false;
+        const owner = Number(content);
+        if (!Number.isSafeInteger(owner) || owner === process.pid)
+            return false;
+        try {
+            process.kill(owner, 0);
+            return false;
+        }
+        catch (error) {
+            if (error.code !== "ESRCH")
+                return false;
+        }
+        await rm(path);
+        return true;
+    }
+    catch {
+        return false;
+    }
+    finally {
+        await rmdir(recovery);
+    }
+}
 export function tokenExpiresSoon(token) {
     try {
         const payload = asRecord(JSON.parse(Buffer.from(token.split(".")[1], "base64url").toString("utf8")));

package/dist/ui.d.ts

@@ -1,7 +1,9 @@
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.1.1";
 export declare const DOG: string;
 export declare function redactSecrets(value: string): string;
 export declare function clean(value: string): string;
+/** Escape characters JSON.stringify leaves raw; the JSON value is unchanged. */
+export declare function safeJson(value: unknown): string;
 export declare class Ui {
     readonly json: boolean;
     constructor(json?: boolean);

package/dist/ui.js

@@ -1,20 +1,46 @@
 import { createInterface } from "node:readline/promises";
 import { stripVTControlCharacters } from "node:util";
-export const VERSION = "0.1.0";
+export const VERSION = "0.1.1";
 export const DOG = String.raw `
-    / \__
-   (    @\___
-   /         O
-  /   (_____/
- /_____/   U
+  ▗██▄▄                      ▄▄██▖
+  ██▀▜██▙▄  ▙▄            ▄▟██▛▀██
+ ▐█▌   ▀███▄▐██▄        ▄███▀   ▜█▌
+ ▐█▌     ███████▙      ▝▀▀▀     ▐█▌
+ ██▌   ▄█████████▌              ▐█▌
+ ▐█▌ ▄████████████              ▐█▌
+ ▐█▙▟████████████▌              ▜█▘
+  ▀▝▀▘     ▀▀███▛
+
+         ▄█▙▖          ▄█▙▖
+         ▜██▌    ▄▄    ▜██▘
+             ▄███▛▜███▄
+           ▗███▌    ▐███▖
+           █████▄  ▄█████
+  ▗▄       ▝▜██▛▀  ▀▜██▛▘       ▄▖
+  ▐██▄▖                      ▗▄██▌
+  ▟█████▙▄▖              ▗▄▄█████▙
+ ▐█▛███████████▄▄▄▄▄▄███████████▜█▌
+  ▀ ▝██████████████████████████▘ ▀
+     ▝▜██████████████████████▛▘
+       ▝▜██████████████████▀▘
+          ▀▀▜█▜██████▛█▛▀▘
+                ▀▀▀▀
 `;
 export function redactSecrets(value) {
     return value
         .replace(/\beyJ[\w-]+\.[\w-]+\.[\w-]+\b/g, "[redacted token]")
         .replace(/\bgdk_[a-f0-9]{64}\b/g, "[redacted API key]");
 }
+// C1 controls and bidirectional overrides can drive or spoof terminals.
+const UNSAFE_UNICODE = /[\u0080-\u009f\u202a-\u202e\u2066-\u2069]/g;
 export function clean(value) {
-    return redactSecrets(stripVTControlCharacters(value).replace(/[\x00-\x08\x0b-\x1f\x7f]/g, ""));
+    return redactSecrets(stripVTControlCharacters(value)
+        .replace(/[\x00-\x08\x0b-\x1f\x7f]/g, "")
+        .replace(UNSAFE_UNICODE, ""));
+}
+/** Escape characters JSON.stringify leaves raw; the JSON value is unchanged. */
+export function safeJson(value) {
+    return redactSecrets(JSON.stringify(value ?? null, null, 2)).replace(UNSAFE_UNICODE, (character) => `\\u${character.charCodeAt(0).toString(16).padStart(4, "0")}`);
 }
 export class Ui {
     json;
@@ -31,7 +57,7 @@ export class Ui {
     banner() {
         if (this.json || process.env.GITDOG_NO_BANNER === "1")
             return;
-        process.stdout.write(this.color(DOG) + this.color(`  G I T D O G  /  ${VERSION}\n`, 1));
+        process.stdout.write(this.color(DOG, 1) + this.color(`  G I T D O G  /  ${VERSION}\n`, 1));
         process.stdout.write("  Your repositories. A very good assistant.\n\n");
     }
     info(message) {
@@ -40,7 +66,7 @@ export class Ui {
     }
     output(value) {
         if (this.json) {
-            process.stdout.write(`${redactSecrets(JSON.stringify(value ?? null, null, 2))}\n`);
+            process.stdout.write(`${safeJson(value)}\n`);
             return;
         }
         if (typeof value === "string") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitdog",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Manage Gitdog projects, GitHub automation and API keys from your terminal",
   "type": "module",
   "bin": {