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

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;
+}

package/dist-templates/types-locally/.ts-for-girrc.js

@@ -1,6 +0,0 @@
-export default {
-	modules: ["Adw-1", "Gtk-4.0"],
-	outdir: "./@types",
-	package: false,
-	ignoreVersionConflicts: true,
-};

package/dist-templates/types-locally/README.md

@@ -1,15 +0,0 @@
-# __PROJECT_NAME__
-
-GJS + TypeScript starter that generates GObject Introspection types **locally** into `./@types/`, without using the `@girs/*` NPM packages.
-
-## Setup
-
-```sh
-npm install
-npm run generate     # writes types into ./@types/
-npm run check:types  # tsc --noEmit
-npm run build        # bundles main.ts to dist/ via esbuild
-npm start            # runs dist/main.js with gjs
-```
-
-`@types/index.d.ts` is regenerated each time you run `npm run generate`. Add or remove modules in `.ts-for-girrc.js`.

package/dist-templates/types-locally/esbuild.ts

@@ -1,10 +0,0 @@
-import { build } from "esbuild";
-
-await build({
-	entryPoints: ["main.ts"],
-	outdir: "dist",
-	bundle: true,
-	target: "firefox128",
-	format: "esm",
-	external: ["gi://*", "resource://*", "gettext", "system", "cairo"],
-});

package/dist-templates/types-locally/main.ts

@@ -1,21 +0,0 @@
-/// <reference path="./@types/index.d.ts" />
-
-import Adw from "gi://Adw?version=1";
-import Gio from "gi://Gio?version=2.0";
-import Gtk from "gi://Gtk?version=4.0";
-
-const app = new Adw.Application({
-	applicationId: "com.example.__PROJECT_NAME__",
-	flags: Gio.ApplicationFlags.FLAGS_NONE,
-});
-
-app.connect("activate", (app: Adw.Application) => {
-	const label = new Gtk.Label({ label: "Hello from __PROJECT_NAME__" });
-	const window = new Gtk.ApplicationWindow({ application: app });
-	window.set_title("__PROJECT_NAME__");
-	window.set_default_size(320, 120);
-	window.set_child(label);
-	window.present();
-});
-
-app.run([imports.system.programInvocationName].concat(ARGV));

package/dist-templates/types-locally/package.json

@@ -1,18 +0,0 @@
-{
-	"name": "__PROJECT_NAME__",
-	"version": "0.1.0",
-	"type": "module",
-	"private": true,
-	"scripts": {
-		"generate": "ts-for-gir generate",
-		"check:types": "tsc --noEmit",
-		"build": "node --experimental-strip-types --experimental-transform-types --no-warnings esbuild.ts",
-		"start": "gjs -m dist/main.js",
-		"clear": "rm -rf dist @types"
-	},
-	"devDependencies": {
-		"@ts-for-gir/cli": "^4.0.0-rc.9",
-		"esbuild": "^0.28.0",
-		"typescript": "^6.0.2"
-	}
-}

package/dist-templates/types-locally/tsconfig.json

@@ -1,17 +0,0 @@
-{
-	"compilerOptions": {
-		"target": "ESNext",
-		"module": "ESNext",
-		"lib": ["ESNext"],
-		"moduleResolution": "bundler",
-		"skipLibCheck": false,
-		"types": [],
-		"strict": true,
-		"noImplicitAny": true,
-		"strictNullChecks": true,
-		"noImplicitThis": true,
-		"alwaysStrict": true
-	},
-	"include": ["main.ts", "@types/index.d.ts"],
-	"exclude": []
-}

package/dist-templates/types-npm/README.md

@@ -1,14 +0,0 @@
-# __PROJECT_NAME__
-
-GJS + TypeScript starter that consumes pre-generated GObject Introspection types from the [`@girs/*`](https://www.npmjs.com/org/girs) NPM packages.
-
-## Setup
-
-```sh
-npm install
-npm run check   # tsc --noEmit
-npm run build   # bundles main.ts to dist/ via esbuild
-npm start       # runs dist/main.js with gjs
-```
-
-To add another GIR module, install the matching `@girs/<name>-<version>` package and add it to `tsconfig.json`'s `types` array.

package/dist-templates/types-npm/esbuild.ts

@@ -1,10 +0,0 @@
-import { build } from "esbuild";
-
-await build({
-	entryPoints: ["main.ts"],
-	outdir: "dist",
-	bundle: true,
-	target: "firefox128",
-	format: "esm",
-	external: ["gi://*", "resource://*", "gettext", "system", "cairo"],
-});

package/dist-templates/types-npm/main.ts

@@ -1,19 +0,0 @@
-import Adw from "gi://Adw?version=1";
-import Gio from "gi://Gio?version=2.0";
-import Gtk from "gi://Gtk?version=4.0";
-
-const app = new Adw.Application({
-	applicationId: "com.example.__PROJECT_NAME__",
-	flags: Gio.ApplicationFlags.FLAGS_NONE,
-});
-
-app.connect("activate", (app: Adw.Application) => {
-	const label = new Gtk.Label({ label: "Hello from __PROJECT_NAME__" });
-	const window = new Gtk.ApplicationWindow({ application: app });
-	window.set_title("__PROJECT_NAME__");
-	window.set_default_size(320, 120);
-	window.set_child(label);
-	window.present();
-});
-
-app.run([imports.system.programInvocationName].concat(ARGV));

package/dist-templates/types-npm/package.json

@@ -1,23 +0,0 @@
-{
-	"name": "__PROJECT_NAME__",
-	"version": "0.1.0",
-	"type": "module",
-	"private": true,
-	"scripts": {
-		"check": "tsc --noEmit",
-		"build": "node --experimental-strip-types --experimental-transform-types --no-warnings esbuild.ts",
-		"start": "gjs -m dist/main.js",
-		"clear": "rm -rf dist"
-	},
-	"devDependencies": {
-		"esbuild": "^0.28.0",
-		"typescript": "^6.0.2"
-	},
-	"dependencies": {
-		"@girs/adw-1": "^1.10.0-4.0.0-rc.8",
-		"@girs/gio-2.0": "^2.88.0-4.0.0-rc.8",
-		"@girs/gjs": "^4.0.0-rc.8",
-		"@girs/glib-2.0": "^2.88.0-4.0.0-rc.8",
-		"@girs/gtk-4.0": "^4.23.0-4.0.0-rc.8"
-	}
-}

package/dist-templates/types-npm/tsconfig.json

@@ -1,15 +0,0 @@
-{
-	"compilerOptions": {
-		"lib": ["ESNext"],
-		"types": ["@girs/gjs", "@girs/adw-1"],
-		"target": "ESNext",
-		"module": "ESNext",
-		"moduleResolution": "bundler",
-		"strict": true,
-		"noImplicitAny": true,
-		"strictNullChecks": true,
-		"noImplicitThis": true,
-		"alwaysStrict": true
-	},
-	"files": ["main.ts"]
-}

package/dist-templates/types-workspace/.ts-for-girrc.js

@@ -1,12 +0,0 @@
-export default {
-	modules: ["Adw-1", "Gtk-4.0"],
-	outdir: "./@girs",
-	package: true,
-	// npm does not support the workspace: protocol. `caret` emits ^<version>
-	// which npm, yarn and pnpm all resolve to the local workspace when the ref
-	// matches, falling back to the registry otherwise — the most portable
-	// default for a generated monorepo. Falls back to "exact" on CLI versions
-	// that predate this option, which is also npm-compatible.
-	depVersionFormat: "caret",
-	ignoreVersionConflicts: true,
-};

package/dist-templates/types-workspace/README.md

@@ -1,26 +0,0 @@
-# __PROJECT_NAME__
-
-GJS + TypeScript starter that uses an **npm workspace** with the `@girs/*` types generated locally as workspace packages. Useful when you want pinned, hermetic types under version control without depending on the published `@girs/*` packages on NPM.
-
-## Setup
-
-```sh
-npm install
-npm run build:types   # generates @girs/* packages into ./@girs/
-npm install           # picks up the freshly generated @girs/* workspace packages
-npm run build:app
-npm start
-```
-
-Or shorthand: `npm run build` runs all three steps in order.
-
-The application lives in [`packages/app/`](./packages/app/). Its dependencies on `@girs/*` are written as `"*"` which works across all three package managers — npm, yarn, pnpm all resolve to the locally generated workspace packages in `./@girs/`.
-
-### About the dependency version format
-
-Two deliberate choices keep the template portable:
-
-1. **Generated `@girs/*` packages** reference each other via `^<version>` (not `workspace:^`). Controlled by `depVersionFormat: "caret"` in [`.ts-for-girrc.js`](./.ts-for-girrc.js). npm and yarn/pnpm all prefer the local workspace match; the registry serves as fallback for transitive GIR packages outside your `modules` set.
-2. **Sub-package deps** (`packages/app/package.json`) use `"*"`. Same reasoning — all managers resolve to the local workspace.
-
-If you run yarn or pnpm exclusively and want strict workspace-only resolution, switch both: add `workspace: true` and `depVersionFormat: "workspace"` in `.ts-for-girrc.js`, plus `"workspace:^"` specs in `packages/app/package.json`. npm does **not** support the `workspace:` protocol.

package/dist-templates/types-workspace/package.json

@@ -1,22 +0,0 @@
-{
-	"name": "__PROJECT_NAME__",
-	"version": "0.1.0",
-	"type": "module",
-	"private": true,
-	"workspaces": [
-		"packages/*",
-		"@girs/*"
-	],
-	"scripts": {
-		"build:types": "ts-for-gir generate --package --outdir=./@girs",
-		"build:app": "npm run --workspace=@__PROJECT_NAME__/app build",
-		"build": "npm run build:types && npm install && npm run build:app",
-		"check": "npm run --workspaces --if-present check",
-		"start": "npm run --workspace=@__PROJECT_NAME__/app start",
-		"clear": "rm -rf @girs packages/*/dist"
-	},
-	"devDependencies": {
-		"@ts-for-gir/cli": "^4.0.0-rc.9",
-		"typescript": "^6.0.2"
-	}
-}

package/dist-templates/types-workspace/packages/app/esbuild.ts

@@ -1,10 +0,0 @@
-import { build } from "esbuild";
-
-await build({
-	entryPoints: ["main.ts"],
-	outdir: "dist",
-	bundle: true,
-	target: "firefox128",
-	format: "esm",
-	external: ["gi://*", "resource://*", "gettext", "system", "cairo"],
-});

package/dist-templates/types-workspace/packages/app/main.ts

@@ -1,19 +0,0 @@
-import Adw from "gi://Adw?version=1";
-import Gio from "gi://Gio?version=2.0";
-import Gtk from "gi://Gtk?version=4.0";
-
-const app = new Adw.Application({
-	applicationId: "com.example.__PROJECT_NAME__",
-	flags: Gio.ApplicationFlags.FLAGS_NONE,
-});
-
-app.connect("activate", (app: Adw.Application) => {
-	const label = new Gtk.Label({ label: "Hello from __PROJECT_NAME__" });
-	const window = new Gtk.ApplicationWindow({ application: app });
-	window.set_title("__PROJECT_NAME__");
-	window.set_default_size(320, 120);
-	window.set_child(label);
-	window.present();
-});
-
-app.run([imports.system.programInvocationName].concat(ARGV));

package/dist-templates/types-workspace/packages/app/package.json

@@ -1,23 +0,0 @@
-{
-	"name": "@__PROJECT_NAME__/app",
-	"version": "0.1.0",
-	"type": "module",
-	"private": true,
-	"scripts": {
-		"check": "tsc --noEmit",
-		"build": "node --experimental-strip-types --experimental-transform-types --no-warnings esbuild.ts",
-		"start": "gjs -m dist/main.js",
-		"clear": "rm -rf dist"
-	},
-	"devDependencies": {
-		"esbuild": "^0.28.0",
-		"typescript": "^6.0.2"
-	},
-	"dependencies": {
-		"@girs/adw-1": "*",
-		"@girs/gio-2.0": "*",
-		"@girs/gjs": "*",
-		"@girs/glib-2.0": "*",
-		"@girs/gtk-4.0": "*"
-	}
-}

package/dist-templates/types-workspace/packages/app/tsconfig.json

@@ -1,15 +0,0 @@
-{
-	"compilerOptions": {
-		"lib": ["ESNext"],
-		"types": ["@girs/gjs", "@girs/adw-1"],
-		"target": "ESNext",
-		"module": "ESNext",
-		"moduleResolution": "bundler",
-		"strict": true,
-		"noImplicitAny": true,
-		"strictNullChecks": true,
-		"noImplicitThis": true,
-		"alwaysStrict": true
-	},
-	"files": ["main.ts"]
-}

package/dist-templates/types-workspace/tsconfig.json

@@ -1,11 +0,0 @@
-{
-	"compilerOptions": {
-		"lib": ["ESNext"],
-		"target": "ESNext",
-		"module": "ESNext",
-		"moduleResolution": "bundler",
-		"strict": true,
-		"noEmit": true
-	},
-	"references": [{ "path": "./packages/app" }]
-}