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

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

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

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

@@ -0,0 +1,15 @@
+# __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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,21 @@
+/// <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

@@ -0,0 +1,18 @@
+{
+	"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.10",
+		"esbuild": "^0.28.0",
+		"typescript": "^6.0.2"
+	}
+}

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

@@ -0,0 +1,17 @@
+{
+	"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

@@ -0,0 +1,14 @@
+# __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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,23 @@
+{
+	"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.9",
+		"@girs/gio-2.0": "^2.88.0-4.0.0-rc.9",
+		"@girs/gjs": "^4.0.0-rc.9",
+		"@girs/glib-2.0": "^2.88.0-4.0.0-rc.9",
+		"@girs/gtk-4.0": "^4.23.0-4.0.0-rc.9"
+	}
+}

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

@@ -0,0 +1,15 @@
+{
+	"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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,26 @@
+# __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

@@ -0,0 +1,22 @@
+{
+	"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.10",
+		"typescript": "^6.0.2"
+	}
+}

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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,23 @@
+{
+	"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

@@ -0,0 +1,15 @@
+{
+	"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

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

package/package.json

@@ -1,37 +1,55 @@
 {
   "name": "@ts-for-gir/cli",
-  "version": "4.0.0-beta.9",
+  "version": "4.0.0-rc.10",
   "description": "TypeScript type definition generator for GObject introspection GIR files",
-  "module": "lib/index.js",
-  "main": "lib/index.js",
+  "main": "src/index.ts",
+  "module": "src/index.ts",
   "type": "module",
   "bin": {
-    "ts-for-gir": "./lib/start.js"
+    "cli": "bin/ts-for-gir",
+    "ts-for-gir": "bin/ts-for-gir",
+    "ts-for-gir-dev": "bin/ts-for-gir-dev",
+    "ts-for-gir-gjs": "bin/ts-for-gir-gjs"
+  },
+  "gjsify": {
+    "bin": {
+      "ts-for-gir": "bin/ts-for-gir-gjs"
+    },
+    "shebang": true,
+    "esbuild": {
+      "outfile": "bin/ts-for-gir-gjs"
+    },
+    "excludeGlobals": [
+      "fetch",
+      "Headers",
+      "Request",
+      "Response",
+      "XMLHttpRequest",
+      "XMLHttpRequestUpload"
+    ]
   },
   "engines": {
     "node": ">=18"
   },
   "scripts": {
-    "start": "yarn node --max_old_space_size=9216 lib/start.js",
-    "start:dev": "yarn node --max_old_space_size=9216 --loader ts-node/esm src/start.ts",
-    "build": "yarn lint && yarn build:ts && yarn chmod",
-    "chmod": "chmod +x ./lib/start.js",
-    "build:ts": "tsc",
-    "clear": "yarn clear:build",
-    "clear:build": "rimraf ./lib",
-    "watch": "yarn build:ts --watch",
-    "lint": "eslint . --ext .ts,.tsx --fix"
+    "start": "node bin/ts-for-gir-dev",
+    "start:prod": "node bin/ts-for-gir",
+    "build": "node --experimental-specifier-resolution=node --experimental-strip-types --experimental-transform-types --no-warnings esbuild.ts && chmod +x bin/ts-for-gir-dev && chmod +x bin/ts-for-gir",
+    "build:gjs": "node scripts/build-gjs.mjs",
+    "build:templates": "node scripts/process-templates.mjs",
+    "prepack": "node scripts/process-templates.mjs",
+    "check:types": "tsc --noEmit",
+    "check": "yarn check:types"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/gjsify/ts-for-gir.git"
   },
-  "author": "Pascal Garber <pascal@artandcode.studio>",
+  "author": "Pascal Garber <pascal@mailfreun.de>",
   "files": [
     "src",
     "bin",
-    "lib",
-    "templates"
+    "dist-templates"
   ],
   "license": "Apache-2.0",
   "bugs": {
@@ -52,30 +70,35 @@
     "type definitions",
     "cli"
   ],
+  "exports": {
+    ".": "./src/index.ts"
+  },
   "devDependencies": {
-    "@types/inquirer": "^9.0.7",
-    "@types/node": "^20.14.11",
-    "@types/yargs": "^17.0.32",
-    "@typescript-eslint/eslint-plugin": "^7.16.1",
-    "@typescript-eslint/parser": "^7.16.1",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.2.1",
-    "rimraf": "^6.0.1",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.5.3"
+    "@gi.ts/parser": "^4.0.0-rc.10",
+    "@gjsify/cli": "^0.3.13",
+    "@ts-for-gir/generator-base": "^4.0.0-rc.10",
+    "@ts-for-gir/generator-html-doc": "^4.0.0-rc.10",
+    "@ts-for-gir/generator-json": "^4.0.0-rc.10",
+    "@ts-for-gir/generator-typescript": "^4.0.0-rc.10",
+    "@ts-for-gir/lib": "^4.0.0-rc.10",
+    "@ts-for-gir/reporter": "^4.0.0-rc.10",
+    "@ts-for-gir/tsconfig": "^4.0.0-rc.10",
+    "@types/ejs": "^3.1.5",
+    "@types/inquirer": "^9.0.9",
+    "@types/node": "^25.6.0",
+    "@types/yargs": "^17.0.35",
+    "esbuild": "^0.28.0",
+    "typescript": "^6.0.3"
   },
   "dependencies": {
-    "@gi.ts/parser": "^2.0.0",
-    "@ts-for-gir/generator-base": "^4.0.0-beta.9",
-    "@ts-for-gir/generator-html-doc": "^4.0.0-beta.9",
-    "@ts-for-gir/generator-typescript": "^4.0.0-beta.9",
-    "@ts-for-gir/lib": "^4.0.0-beta.9",
+    "@inquirer/prompts": "^8.4.2",
+    "@ts-for-gir/templates": "^4.0.0-rc.10",
     "colorette": "^2.0.20",
-    "cosmiconfig": "^9.0.0",
-    "glob": "^11.0.0",
-    "inquirer": "^9.3.5",
-    "prettier": "^3.3.3",
-    "yargs": "^17.7.2"
+    "cosmiconfig": "^9.0.1",
+    "ejs": "^5.0.2",
+    "glob": "^13.0.6",
+    "inquirer": "^13.4.2",
+    "typedoc": "^0.28.19",
+    "yargs": "^18.0.0"
   }
 }