@ts-for-gir/generator-typescript 4.0.0-beta.3 → 4.0.0-beta.30

package/README.md

@@ -16,5 +16,22 @@
   <img src="https://raw.githubusercontent.com/gjsify/ts-for-gir/main/.github/feeling.gif" />
 </p>
 
-# Generator base
-TypeScript type definition generator for ts-for-gir.
+# TypeScript Generator
+
+TypeScript-specific generator for `ts-for-gir`. This package implements the actual generation of TypeScript declaration files (.d.ts) from the processed GIR data. It transforms the intermediate representation of GObject types into TypeScript type definitions.
+
+## Features
+
+- Generation of TypeScript declaration files (.d.ts) from GIR data
+- Support for generating NPM packages with proper package.json configuration
+- Template-based code generation using EJS templates
+- Complete handling of complex type transformations:
+  - Classes, interfaces, and records
+  - Functions, methods, and constructors 
+  - Properties, fields, and constants
+  - Enums and callbacks
+  - Signals and their event handlers
+- Generation of proper JSDoc comments from GIR documentation
+- Support for GJS-specific module formats and ambient type declarations
+
+This package is responsible for the final output of the `ts-for-gir` toolchain, producing TypeScript definition files that can be used in GJS projects.

package/package.json

@@ -1,36 +1,26 @@
 {
   "name": "@ts-for-gir/generator-typescript",
-  "version": "4.0.0-beta.3",
+  "version": "4.0.0-beta.30",
   "description": "TypeScript type definition generator for ts-for-gir",
-  "module": "lib/index.js",
-  "main": "lib/index.js",
+  "main": "src/index.ts",
+  "module": "src/index.ts",
   "type": "module",
   "engines": {
     "node": ">=18"
   },
   "exports": {
-    ".": {
-      "types": "./lib/index.d.ts",
-      "import": "./lib/index.js"
-    }
+    ".": "./src/index.ts"
   },
   "scripts": {
-    "build": "yarn lint && yarn build:ts",
-    "build:ts": "tsc",
-    "clear": "yarn clear:build",
-    "clear:build": "rimraf ./lib",
-    "watch": "yarn build:ts --watch",
-    "lint": "eslint . --ext .ts,.tsx --fix"
+    "check": "tsc --noEmit"
   },
   "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": [
-    "lib",
-    "templates",
-    "packages.xml"
+    "src"
   ],
   "license": "Apache-2.0",
   "bugs": {
@@ -42,20 +32,15 @@
   ],
   "devDependencies": {
     "@types/ejs": "^3.1.5",
-    "@types/node": "^20.12.7",
+    "@types/node": "^24.2.1",
     "@types/xml2js": "^0.4.14",
-    "@typescript-eslint/eslint-plugin": "^7.7.0",
-    "@typescript-eslint/parser": "^7.7.0",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.3",
-    "prettier": "^3.2.5",
-    "rimraf": "^5.0.5",
-    "typescript": "^5.4.5"
+    "typescript": "^5.9.2"
   },
   "dependencies": {
-    "@ts-for-gir/generator-base": "^4.0.0-beta.3",
-    "@ts-for-gir/lib": "^4.0.0-beta.3",
+    "@gi.ts/parser": "^4.0.0-beta.30",
+    "@ts-for-gir/generator-base": "^4.0.0-beta.30",
+    "@ts-for-gir/lib": "^4.0.0-beta.30",
+    "@ts-for-gir/templates": "^4.0.0-beta.30",
     "ejs": "^3.1.10",
     "xml2js": "^0.6.2"
   }

package/src/index.ts

@@ -0,0 +1,4 @@
+export { ModuleGenerator, ModuleGeneratorFormat } from "./module-generator.ts";
+export { NpmPackage } from "./npm-package.ts";
+export { TemplateProcessor } from "./template-processor.ts";
+export { TypeDefinitionGenerator } from "./type-definition-generator.ts";

package/src/module-generator-example.ts

@@ -0,0 +1,68 @@
+/**
+ * Example usage of the refactored ModuleGenerator
+ *
+ * This demonstrates how the unified ModuleGenerator now incorporates
+ * functionality from DtsGenerator and DtsModuleGenerator
+ */
+
+import type { GirModule, NSRegistry, OptionsGeneration } from "@ts-for-gir/lib";
+import { ModuleGenerator } from "./module-generator.ts";
+
+// Example: Using ModuleGenerator with different output formats
+async function generateTypeDefinitions(girModule: GirModule, config: OptionsGeneration, registry: NSRegistry) {
+	// Create a ModuleGenerator instance
+	const generator = new ModuleGenerator(girModule, config, registry);
+
+	// 1. Generate as string array (default behavior)
+	const arrayOutput = await generator.generateModule(girModule);
+	console.log("String array output:", arrayOutput);
+
+	// 2. Generate as single string (DtsGenerator compatibility)
+	const stringOutput = await generator.generateModuleString(girModule);
+	console.log("String output:", stringOutput);
+
+	// 3. Generate as module declaration (DtsModuleGenerator compatibility)
+	const moduleDeclaration = await generator.generateModuleDeclaration(girModule);
+	console.log("Module declaration output:", moduleDeclaration);
+
+	// 4. Generate namespace as string
+	const namespaceString = await generator.generateNamespaceAsString(girModule);
+	console.log("Namespace string output:", namespaceString);
+
+	// 5. The AdvancedVariants feature is automatically applied
+	// when generating GLib or GObject modules (unless disabled with noAdvancedVariants option)
+	if (girModule.namespace === "GLib" && !config.noAdvancedVariants) {
+		console.log("GLib module will include advanced variant type definitions");
+	}
+	if (girModule.namespace === "GObject") {
+		console.log("GObject module will include registerClass overrides");
+	}
+}
+
+// Example: Migrating from DtsGenerator
+function migrateFromDtsGenerator(girModule: GirModule, config: OptionsGeneration, registry: NSRegistry) {
+	// Before (using DtsGenerator):
+	// const generator = new DtsGenerator(girModule, config);
+	// const output = await generator.generateNamespace(girModule);
+
+	// After (using ModuleGenerator):
+	const generator = new ModuleGenerator(girModule, config, registry);
+	const output = generator.generateNamespaceAsString(girModule);
+
+	return output;
+}
+
+// Example: Migrating from DtsModuleGenerator
+function migrateFromDtsModuleGenerator(girModule: GirModule, config: OptionsGeneration, registry: NSRegistry) {
+	// Before (using DtsModuleGenerator):
+	// const generator = new DtsModuleGenerator(girModule, config);
+	// const output = await generator.generateNamespace(girModule);
+
+	// After (using ModuleGenerator):
+	const generator = new ModuleGenerator(girModule, config, registry);
+	const output = generator.generateModuleDeclaration(girModule);
+
+	return output;
+}
+
+export { generateTypeDefinitions, migrateFromDtsGenerator, migrateFromDtsModuleGenerator };