@ts-for-gir/cli 4.0.0-rc.9 → 4.0.1

package/src/commands/self-update.ts

@@ -0,0 +1,142 @@
+/**
+ * Everything you need for the `ts-for-gir self-update` command is located here
+ */
+
+import { chmodSync, existsSync, renameSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+
+import { APP_NAME, APP_VERSION } from "@ts-for-gir/lib";
+
+import type { SelfUpdateCommandArgs } from "../types/index.ts";
+
+const REPO = "gjsify/ts-for-gir";
+const GITHUB_API = "https://api.github.com";
+const GJS_ASSET_NAME = "ts-for-gir-gjs";
+
+function getCurrentBinaryPath(): string | null {
+	const p = process.argv[1] ?? null;
+	if (!p) return null;
+	// Refuse to update in dev mode (source file or node_modules path)
+	if (p.endsWith(".ts") || p.includes("node_modules")) return null;
+	return p;
+}
+
+async function fetchJson(url: string): Promise<unknown> {
+	const headers: Record<string, string> = {
+		Accept: "application/vnd.github.v3+json",
+		"User-Agent": `ts-for-gir/${APP_VERSION}`,
+	};
+	const token = process.env.GITHUB_TOKEN;
+	if (token) headers.Authorization = `token ${token}`;
+
+	const response = await fetch(url, { headers });
+	if (!response.ok) {
+		throw new Error(`HTTP ${response.status} from ${url}`);
+	}
+	return response.json();
+}
+
+async function downloadBinary(url: string, destPath: string): Promise<void> {
+	const response = await fetch(url, {
+		headers: { "User-Agent": `ts-for-gir/${APP_VERSION}` },
+	});
+	if (!response.ok) {
+		throw new Error(`HTTP ${response.status} downloading binary`);
+	}
+	const buffer = await response.arrayBuffer();
+	const tmpPath = join(tmpdir(), `ts-for-gir-update-${Date.now()}`);
+	writeFileSync(tmpPath, Buffer.from(buffer));
+	chmodSync(tmpPath, 0o755);
+	renameSync(tmpPath, destPath); // atomic on POSIX
+}
+
+const command = "self-update";
+const description = "Update ts-for-gir to the latest version from GitHub releases";
+const examples: ReadonlyArray<[string, string?]> = [
+	[`${APP_NAME} self-update`, "Check for updates and install the latest version"],
+	[`${APP_NAME} self-update --check`, "Only check for a newer version, do not install"],
+	[`${APP_NAME} self-update --force`, "Force reinstall even if already on the latest version"],
+];
+
+const builder = (yargs: import("yargs").Argv) =>
+	yargs
+		.option("check", {
+			description: "Only check for a newer version, do not install",
+			type: "boolean",
+			default: false,
+		})
+		.option("force", {
+			description: "Force reinstall even if already on the latest version",
+			type: "boolean",
+			default: false,
+		})
+		.example(examples as [string, string?][]);
+
+const handler = async (args: SelfUpdateCommandArgs): Promise<void> => {
+	console.log(`Checking for updates... (current: v${APP_VERSION})`);
+
+	let release: Record<string, unknown>;
+	try {
+		release = (await fetchJson(`${GITHUB_API}/repos/${REPO}/releases/latest`)) as Record<string, unknown>;
+	} catch (err) {
+		const msg = err instanceof Error ? err.message : String(err);
+		process.stderr.write(`Failed to fetch release information: ${msg}\n`);
+		process.exitCode = 1;
+		return;
+	}
+
+	const latestVersion = (release.tag_name as string).replace(/^v/, "");
+
+	if (latestVersion === APP_VERSION && !args.force) {
+		console.log(`Already up to date (v${APP_VERSION})`);
+		return;
+	}
+
+	if (args.check) {
+		console.log(`New version available: v${latestVersion} (current: v${APP_VERSION})`);
+		console.log(`Run \`${APP_NAME} self-update\` to install it.`);
+		return;
+	}
+
+	console.log(`Updating to v${latestVersion}...`);
+
+	const assets = release.assets as Array<Record<string, string>>;
+	const asset = assets.find((a) => a.name === GJS_ASSET_NAME);
+	if (!asset) {
+		process.stderr.write(
+			`No GJS binary found in release ${release.tag_name}.\n` +
+				"self-update requires the GJS bundle to be installed via install.js.\n" +
+				"For npm installations use: npm update -g @ts-for-gir/cli\n",
+		);
+		process.exitCode = 1;
+		return;
+	}
+
+	const currentPath = getCurrentBinaryPath();
+	if (!currentPath || !existsSync(currentPath)) {
+		process.stderr.write(
+			"Cannot determine current binary path for update.\n" +
+				"self-update only works when running the installed GJS binary.\n",
+		);
+		process.exitCode = 1;
+		return;
+	}
+
+	try {
+		await downloadBinary(asset.browser_download_url, currentPath);
+		console.log(`Successfully updated to v${latestVersion}`);
+	} catch (err) {
+		const msg = err instanceof Error ? err.message : String(err);
+		process.stderr.write(`Update failed: ${msg}\n`);
+		process.exitCode = 1;
+	}
+};
+
+export const selfUpdate = {
+	command,
+	description,
+	builder,
+	handler,
+	examples,
+};

package/src/config/config-loader.ts

@@ -3,6 +3,7 @@
  */
 
 import { dirname, resolve } from "node:path";
+import { pathToFileURL } from "node:url";
 import type { ConfigFlags, OptionsGeneration, UserConfig, UserConfigLoadResult } from "@ts-for-gir/lib";
 import { APP_NAME, isEqual } from "@ts-for-gir/lib";
 import { type Options as ConfigSearchOptions, cosmiconfig } from "cosmiconfig";
@@ -18,9 +19,12 @@ import { docOptions, options } from "./options.ts";
 export async function loadConfigFile(configName?: string): Promise<UserConfigLoadResult | null> {
 	const configSearchOptions: Partial<ConfigSearchOptions> = {
 		loaders: {
-			// ESM loader
+			// ESM loader. cosmiconfig hands us an absolute filesystem path; Node's import()
+			// tolerates that as a non-spec extension, but spec-compliant runtimes (GJS /
+			// SpiderMonkey) reject it with "Module not found: <abs-path>". Convert to a
+			// file:// URL so the loader works in both runtimes.
 			".js": async (filepath) => {
-				const file = await import(filepath);
+				const file = await import(pathToFileURL(filepath).href);
 
 				// Files with `exports.default = { ... }`
 				if (file?.default?.default) {

package/src/config/defaults.ts

@@ -53,6 +53,20 @@ function getDefaultGirDirectories(): string[] {
 		"/usr/lib/x86_64-linux-gnu/mutter-*",
 	];
 
+	// Flatpak: `--filesystem=host` exposes the host's filesystem under
+	// /run/host. The GNOME runtime ships GIR typelibs but not the XML, so
+	// inside the sandbox we must read from /run/host/usr/share/gir-1.0.
+	// Detected via FLATPAK_ID (set for every Flatpak-launched process) or
+	// the .flatpak-info marker file (always present in the sandbox).
+	if (process.env.FLATPAK_ID || existsSync("/.flatpak-info")) {
+		girDirectories.unshift(
+			"/run/host/usr/local/share/gir-1.0",
+			"/run/host/usr/share/gir-1.0",
+			"/run/host/usr/share/*/gir-1.0",
+			"/run/host/usr/lib/x86_64-linux-gnu/mutter-*",
+		);
+	}
+
 	// NixOS and other distributions does not have a /usr/local/share directory.
 	// Instead, the nix store paths with Gir files are set as XDG_DATA_DIRS.
 	// See https://github.com/NixOS/nixpkgs/blob/96e18717904dfedcd884541e5a92bf9ff632cf39/pkgs/development/libraries/gobject-introspection/setup-hook.sh#L7-L10

package/src/config/options.ts

@@ -257,8 +257,8 @@ export const createOptions = {
 	template: {
 		type: "string" as const,
 		alias: "t",
-		description: "Template to scaffold (types-locally, types-npm, types-workspace)",
-		choices: ["types-locally", "types-npm", "types-workspace"] as const,
+		description: "Template to scaffold (types-locally, types-npm, types-workspace, types-gjsify)",
+		choices: ["types-locally", "types-npm", "types-workspace", "types-gjsify"] as const,
 	},
 	install: {
 		type: "boolean" as const,

package/src/start.ts

@@ -2,18 +2,30 @@ import { APP_NAME, APP_USAGE, APP_VERSION } from "@ts-for-gir/lib";
 import yargs, { type CommandModule } from "yargs";
 import { hideBin } from "yargs/helpers";
 
-import { analyze, copy, create, doc, generate, json, list } from "./commands/index.ts";
+import { analyze, copy, create, doc, generate, json, list, selfUpdate } from "./commands/index.ts";
 
 try {
-	await yargs(hideBin(process.argv))
+	const cli = yargs(hideBin(process.argv));
+	await cli
 		.scriptName(APP_NAME)
 		.strict()
 		.usage(APP_USAGE)
 		.version(APP_VERSION)
+		// Use the full terminal width for help. yargs's default caps at 80
+		// (`Math.min(80, process.stdout.columns)`); we explicitly opt into
+		// the real terminal width so long option/description lines wrap at
+		// the actual terminal edge instead of an arbitrary 80-col limit.
+		// Under GJS, `process.stdout.columns` is backed by
+		// `@gjsify/terminal-native` (ioctl TIOCGWINSZ) when the typelib is
+		// on `GI_TYPELIB_PATH` — the install.js launcher imports those env
+		// vars from the gjsify global install when present.
+		.wrap(cli.terminalWidth())
 		// Disable yargs's internal `process.exit` and route both success
-		// and failure through `parseAsync` + `process.exitCode` so async
-		// command handlers complete and stdout drains before the runtime
-		// (Node or the gjsify Node-compat loader on GJS) tears down.
+		// and failure through `parseAsync` + an explicit `process.exit` so
+		// async command handlers complete and stdout drains before the
+		// runtime (Node or the gjsify Node-compat loader on GJS, which
+		// keeps a GLib main loop alive that would otherwise prevent the
+		// process from exiting after main() returns) tears down.
 		.exitProcess(false)
 		.fail(false)
 		// TODO: Fix this
@@ -24,11 +36,13 @@ try {
 		.command(list as unknown as CommandModule)
 		.command(copy as unknown as CommandModule)
 		.command(doc as unknown as CommandModule)
+		.command(selfUpdate as unknown as CommandModule)
 		.demandCommand(1)
 		.help()
 		.parseAsync();
+	process.exit(0);
 } catch (err) {
 	const message = err instanceof Error ? err.message : String(err);
 	process.stderr.write(`${message}\n`);
-	process.exitCode = 1;
+	process.exit(1);
 }

package/src/types/command-args.ts

@@ -94,7 +94,7 @@ export interface DocCommandArgs extends GenerateCommandArgs {
 /**
  * Available scaffolding template identifiers for the create command.
  */
-export type CreateTemplateId = "types-locally" | "types-npm" | "types-workspace";
+export type CreateTemplateId = "types-locally" | "types-npm" | "types-workspace" | "types-gjsify";
 
 /**
  * Arguments for the create command
@@ -145,3 +145,10 @@ export interface AnalyzeCommandArgs {
 	/** Switch on/off the verbose mode */
 	verbose?: boolean;
 }
+
+export interface SelfUpdateCommandArgs {
+	/** Only check for a newer version, do not install */
+	check: boolean;
+	/** Force reinstall even if already on the latest version */
+	force: boolean;
+}