@ts-for-gir/cli 4.0.0-beta.25 → 4.0.0-beta.27

package/src/commands/doc.ts

@@ -2,57 +2,69 @@
  * Everything you need for the `ts-for-gir generate` command is located here
  */
 
-import { Argv, BuilderCallback } from 'yargs'
-import { Logger, ERROR_NO_MODULES_FOUND } from '@ts-for-gir/lib'
-import { GeneratorType } from '@ts-for-gir/generator-base'
-import { GenerationHandler } from '../generation-handler.js'
-import { Config } from '../config.js'
-import { ModuleLoader } from '../module-loader.js'
+import { GeneratorType } from "@ts-for-gir/generator-base";
+import type { ConfigFlags } from "@ts-for-gir/lib";
+import {
+	configureConflictsReporter,
+	ERROR_NO_MODULES_FOUND,
+	type GirModule,
+	Logger,
+	NSRegistry,
+	TypeIdentifier,
+} from "@ts-for-gir/lib";
+import type { Argv, BuilderCallback } from "yargs";
+import { docOptions, getOptionsGeneration, load } from "../config.ts";
+import { GenerationHandler } from "../generation-handler.ts";
+import { ModuleLoader } from "../module-loader.ts";
+import type { DocCommandArgs } from "../types/index.ts";
 
-import type { ConfigFlags } from '@ts-for-gir/lib'
+const command = "doc [modules..]";
 
-const command = 'doc [modules..]'
+const description = "The HTML documentation generator is not yet implemented, but feel free to implement it 🤗";
 
-const description = 'The HTML documentation generator is not yet implemented, but feel free to implement it 🤗'
+const logger = new Logger(false, "DocCommand");
 
- 
-const builder: BuilderCallback<any, ConfigFlags> = (yargs: Argv<any>) => {
-    const optionNames = Object.keys(Config.docOptions)
-    for (const optionName of optionNames) {
-        yargs = yargs.option(optionName, Config.docOptions[optionName])
-    }
-    return yargs.example(examples) as Argv<ConfigFlags>
-}
+const builder: BuilderCallback<DocCommandArgs, ConfigFlags> = (yargs: Argv<DocCommandArgs>) => {
+	const optionNames = Object.keys(docOptions);
+	for (const optionName of optionNames) {
+		yargs = yargs.option(optionName, docOptions[optionName]);
+	}
+	return yargs.example(examples) as Argv<ConfigFlags>;
+};
 
- 
 const handler = async (args: ConfigFlags) => {
-    const config = await Config.load(args)
-
-    const generateConfig = Config.getOptionsGeneration(config)
-    const moduleLoader = new ModuleLoader(generateConfig)
-    const { keep } = await moduleLoader.getModulesResolved(
-        config.modules,
-        config.ignore || [],
-        config.ignoreVersionConflicts,
-    )
-    if (keep.length === 0) {
-        return Logger.error(ERROR_NO_MODULES_FOUND(config.girDirectories))
-    }
-    const tsForGir = new GenerationHandler(generateConfig, GeneratorType.HTML_DOC)
-    const registry = moduleLoader.dependencyManager
-
-    await tsForGir.start(
-        Array.from(keep).map((girModuleResolvedBy) => girModuleResolvedBy.module),
-        registry,
-    )
-}
-
-const examples: ReadonlyArray<[string, string?]> = []
+	const config = await load(args);
+
+	const generateConfig = getOptionsGeneration(config);
+	const registry = new NSRegistry(); // TODO: Use singleton
+
+	// Configure reporters BEFORE parsing to capture all problems
+	if (generateConfig.reporter) {
+		TypeIdentifier.configureReporter(generateConfig.reporter, generateConfig.reporterOutput);
+		configureConflictsReporter(generateConfig.reporter, generateConfig.reporterOutput);
+	}
+
+	const moduleLoader = new ModuleLoader(generateConfig, registry);
+	const { keep } = await moduleLoader.getModulesResolved(
+		config.modules,
+		config.ignore || [],
+		config.ignoreVersionConflicts,
+	);
+	if (keep.length === 0) {
+		logger.error(ERROR_NO_MODULES_FOUND(config.girDirectories));
+		return;
+	}
+	const tsForGir = new GenerationHandler(generateConfig, GeneratorType.HTML_DOC, registry);
+
+	await tsForGir.start(Array.from(keep).map((girModuleResolvedBy) => girModuleResolvedBy.module as GirModule));
+};
+
+const examples: ReadonlyArray<[string, string?]> = [];
 
 export const doc = {
-    command,
-    description,
-    builder,
-    handler,
-    examples,
-}
+	command,
+	description,
+	builder,
+	handler,
+	examples,
+};

package/src/commands/generate.ts

@@ -2,90 +2,110 @@
  * Everything you need for the `ts-for-gir generate` command is located here
  */
 
-import { Argv, BuilderCallback } from 'yargs'
-import { ERROR_NO_MODULES_FOUND, Logger } from '@ts-for-gir/lib'
-import { GeneratorType } from '@ts-for-gir/generator-base'
-import { GenerationHandler } from '../generation-handler.js'
-import { Config } from '../config.js'
-import { ModuleLoader } from '../module-loader.js'
-import prettier from 'prettier'
-
-import type { ConfigFlags } from '@ts-for-gir/lib'
-import { Formatter } from '@ts-for-gir/lib'
-
-const command = 'generate [modules..]'
-
-const description = 'Generates Typescript type definition .d.ts files from GIR for GJS'
-
- 
-const builder: BuilderCallback<any, ConfigFlags> = (yargs: Argv<any>) => {
-    const optionNames = Object.keys(Config.generateOptions)
-    for (const optionName of optionNames) {
-        yargs = yargs.option(optionName, Config.generateOptions[optionName])
-    }
-    return yargs.example(examples) as Argv<ConfigFlags>
-}
-
- 
+import { GeneratorType } from "@ts-for-gir/generator-base";
+import type { ConfigFlags } from "@ts-for-gir/lib";
+import {
+	APP_NAME,
+	configureConflictsReporter,
+	ERROR_NO_MODULES_FOUND,
+	type GirModule,
+	Logger,
+	NSRegistry,
+	ReporterService,
+	TypeIdentifier,
+} from "@ts-for-gir/lib";
+import { generateOptions, getOptionsGeneration, load } from "../config.ts";
+import { TypeScriptFormatter } from "../formatters/typescript-formatter.ts";
+import { GenerationHandler } from "../generation-handler.ts";
+import { ModuleLoader } from "../module-loader.ts";
+import type { GenerateCommandArgs } from "../types/index.ts";
+import { createBuilder } from "./command-builder.ts";
+
+const command = "generate [modules..]";
+
+const description = "Generates Typescript type definition .d.ts files from GIR for GJS";
+
+const logger = new Logger(false, "GenerateCommand");
+
+const examples: ReadonlyArray<[string, string?]> = [
+	[
+		`${APP_NAME} generate`,
+		`Run '${APP_NAME} generate' in your gjs project to generate typings for your project, pass the gir modules you need for your project`,
+	],
+	[`${APP_NAME} generate Gtk*`, "You can also use wild cards"],
+	[`${APP_NAME} generate '*'`, "If you want to parse all of your locally installed gir modules run"],
+	[`${APP_NAME} generate --configName='.ts-for-gir.gtk4.rc.js`, "Use a special config file"],
+	[`${APP_NAME} generate --ignore=Gtk-4.0 xrandr-1.3`, "Generate .d.ts. files but not for Gtk-4.0 and xrandr-1.3"],
+];
+
+const builder = createBuilder<GenerateCommandArgs>(generateOptions, examples);
+
 const handler = async (args: ConfigFlags) => {
-    const config = await Config.load(args)
+	const config = await load(args);
 
-    const generateConfig = Config.getOptionsGeneration(config)
-    const moduleLoader = new ModuleLoader(generateConfig)
-    const { keep } = await moduleLoader.getModulesResolved(
-        config.modules,
-        config.ignore || [],
-        config.ignoreVersionConflicts,
-    )
+	const generateConfig = getOptionsGeneration(config);
+	const registry = new NSRegistry(); // TODO: Use singleton
 
-    if (keep.length === 0) {
-        return Logger.error(ERROR_NO_MODULES_FOUND(config.girDirectories))
-    }
+	// Register TypeScript formatter for .d.ts files
+	registry.registerFormatter("dts", new TypeScriptFormatter());
 
-    moduleLoader.parse(keep)
+	const moduleLoader = new ModuleLoader(generateConfig, registry);
 
-    const tsForGir = new GenerationHandler(generateConfig, GeneratorType.TYPES)
+	// Configure reporters BEFORE parsing to capture all problems
+	if (generateConfig.reporter) {
+		TypeIdentifier.configureReporter(generateConfig.reporter, generateConfig.reporterOutput);
+		configureConflictsReporter(generateConfig.reporter, generateConfig.reporterOutput);
+	}
 
-    const girModules = Array.from(keep).map((girModuleResolvedBy) => girModuleResolvedBy.module)
+	let tsForGir: GenerationHandler | null = null;
 
-    moduleLoader.dependencyManager.registerFormatter('dts', new TypeScriptFormatter())
-    await tsForGir.start(girModules, moduleLoader.dependencyManager)
-}
+	try {
+		const { keep } = await moduleLoader.getModulesResolved(
+			config.modules,
+			config.ignore || [],
+			config.ignoreVersionConflicts,
+		);
 
-const examples: ReadonlyArray<[string, string?]> = [
-    [
-        `${Config.appName} generate`,
-        `Run '${Config.appName} generate' in your gjs project to generate typings for your project, pass the gir modules you need for your project`,
-    ],
-    [`${Config.appName} generate Gtk*`, 'You can also use wild cards'],
-    [`${Config.appName} generate '*'`, 'If you want to parse all of your locally installed gir modules run'],
-    [`${Config.appName} generate --configName='.ts-for-gir.gtk4.rc.js`, 'Use a special config file'],
-    [
-        `${Config.appName} generate --ignore=Gtk-4.0 xrandr-1.3`,
-        'Generate .d.ts. files but not for Gtk-4.0 and xrandr-1.3',
-    ],
-]
-
-class TypeScriptFormatter extends Formatter {
-    format(input: string): Promise<string> {
-        try {
-            return prettier.format(input, {
-                singleQuote: true,
-                parser: 'typescript',
-                printWidth: 120,
-                tabWidth: 4,
-            })
-        } catch (error) {
-            Logger.warn('[TypeScriptFormatter] Failed to format with prettier, returning original input', error)
-            return Promise.resolve(input)
-        }
-    }
-}
+		if (keep.length === 0) {
+			logger.error(ERROR_NO_MODULES_FOUND(config.girDirectories));
+			return;
+		}
+
+		moduleLoader.parse(keep);
+
+		tsForGir = new GenerationHandler(generateConfig, GeneratorType.TYPES, registry);
+
+		const girModules = Array.from(keep).map((girModuleResolvedBy) => girModuleResolvedBy.module as GirModule);
+
+		await tsForGir.start(girModules);
+	} catch (error) {
+		// If reporter is enabled and tsForGir was created, make sure the report is generated
+		if (generateConfig.reporter && tsForGir) {
+			const service = ReporterService.getInstance();
+
+			// Log the error to the reporter
+			if (tsForGir.log) {
+				tsForGir.log.reportGenerationFailure(
+					"Main",
+					error instanceof Error ? error : new Error(String(error)),
+					"Generation failed",
+				);
+			}
+
+			// Generate and save the report
+			await service.printComprehensiveSummary();
+			await service.saveComprehensiveReport();
+		}
+
+		// Re-throw the error to maintain existing behavior
+		throw error;
+	}
+};
 
 export const generate = {
-    command,
-    description,
-    builder,
-    handler,
-    examples,
-}
+	command,
+	description,
+	builder,
+	handler,
+	examples,
+};

package/src/commands/index.ts

@@ -1,4 +1,6 @@
-export * from './copy.js'
-export * from './doc.js'
-export * from './generate.js'
-export * from './list.js'
+export * from "./analyze.ts";
+export * from "./copy.ts";
+export * from "./doc.ts";
+export * from "./generate.ts";
+export * from "./json.ts";
+export * from "./list.ts";

package/src/commands/json.ts

@@ -0,0 +1,104 @@
+/**
+ * Everything you need for the `ts-for-gir json` command is located here
+ */
+
+import { GeneratorType } from "@ts-for-gir/generator-base";
+import type { ConfigFlags } from "@ts-for-gir/lib";
+import {
+	APP_NAME,
+	configureConflictsReporter,
+	ERROR_NO_MODULES_FOUND,
+	type GirModule,
+	Logger,
+	NSRegistry,
+	ReporterService,
+	TypeIdentifier,
+} from "@ts-for-gir/lib";
+import { generateOptions, getOptionsGeneration, load } from "../config.ts";
+import { GenerationHandler } from "../generation-handler.ts";
+import { ModuleLoader } from "../module-loader.ts";
+import type { GenerateCommandArgs } from "../types/index.ts";
+import { createBuilder } from "./command-builder.ts";
+
+const command = "json [modules..]";
+
+const description = "Generates JSON representation from GIR files for analysis and tooling";
+
+const logger = new Logger(false, "JsonCommand");
+
+const examples: ReadonlyArray<[string, string?]> = [
+	[`${APP_NAME} json`, `Run '${APP_NAME} json' in your gjs project to generate JSON files for your project`],
+	[`${APP_NAME} json Gtk*`, "You can also use wild cards"],
+	[`${APP_NAME} json '*'`, "If you want to parse all of your locally installed gir modules run"],
+	[`${APP_NAME} json --configName='.ts-for-gir.gtk4.rc.js`, "Use a special config file"],
+	[`${APP_NAME} json --ignore=Gtk-4.0 xrandr-1.3`, "Generate JSON files but not for Gtk-4.0 and xrandr-1.3"],
+];
+
+const builder = createBuilder<GenerateCommandArgs>(generateOptions, examples);
+
+const handler = async (args: ConfigFlags) => {
+	const config = await load(args);
+
+	const generateConfig = getOptionsGeneration(config);
+	const registry = new NSRegistry(); // TODO: Use singleton
+
+	const moduleLoader = new ModuleLoader(generateConfig, registry);
+
+	// Configure reporters BEFORE parsing to capture all problems
+	if (generateConfig.reporter) {
+		TypeIdentifier.configureReporter(generateConfig.reporter, generateConfig.reporterOutput);
+		configureConflictsReporter(generateConfig.reporter, generateConfig.reporterOutput);
+	}
+
+	let tsForGir: GenerationHandler | null = null;
+
+	try {
+		const { keep } = await moduleLoader.getModulesResolved(
+			config.modules,
+			config.ignore || [],
+			config.ignoreVersionConflicts,
+		);
+
+		if (keep.length === 0) {
+			logger.error(ERROR_NO_MODULES_FOUND(config.girDirectories));
+			return;
+		}
+
+		moduleLoader.parse(keep);
+
+		tsForGir = new GenerationHandler(generateConfig, GeneratorType.JSON, registry);
+
+		const girModules = Array.from(keep).map((girModuleResolvedBy) => girModuleResolvedBy.module as GirModule);
+
+		await tsForGir.start(girModules);
+	} catch (error) {
+		// If reporter is enabled and tsForGir was created, make sure the report is generated
+		if (generateConfig.reporter && tsForGir) {
+			const service = ReporterService.getInstance();
+
+			// Log the error to the reporter
+			if (tsForGir.log) {
+				tsForGir.log.reportGenerationFailure(
+					"Main",
+					error instanceof Error ? error : new Error(String(error)),
+					"JSON generation failed",
+				);
+			}
+
+			// Generate and save the report
+			await service.printComprehensiveSummary();
+			await service.saveComprehensiveReport();
+		}
+
+		// Re-throw the error to maintain existing behavior
+		throw error;
+	}
+};
+
+export const json = {
+	command,
+	description,
+	builder,
+	handler,
+	examples,
+};

package/src/commands/list.ts

@@ -2,101 +2,92 @@
  * Everything you need for the `ts-for-gir list` command is located here
  */
 
-import { Argv, BuilderCallback } from 'yargs'
-import { ModuleLoader } from '../module-loader.js'
-import { Config } from '../config.js'
-import { Logger, ERROR_NO_MODULES_FOUND, ResolveType } from '@ts-for-gir/lib'
+import type { ConfigFlags } from "@ts-for-gir/lib";
+import { APP_NAME, ERROR_NO_MODULES_FOUND, Logger, NSRegistry, ResolveType } from "@ts-for-gir/lib";
+import { getOptionsGeneration, listOptions, load } from "../config.ts";
+import { ModuleLoader } from "../module-loader.ts";
+import type { ListCommandArgs } from "../types/index.ts";
+import { createBuilder } from "./command-builder.ts";
 
-import type { ConfigFlags } from '@ts-for-gir/lib'
+const command = "list [modules..]";
 
-const command = 'list [modules..]'
+const description = "Lists all available GIR modules";
 
-const description = 'Lists all available GIR modules'
+const logger = new Logger(false, "ListCommand");
 
- 
-const builder: BuilderCallback<any, ConfigFlags> = (yargs: Argv<any>) => {
-    const optionNames = Object.keys(Config.listOptions)
-    for (const optionName of optionNames) {
-        yargs = yargs.option(optionName, Config.listOptions[optionName])
-    }
-    return yargs.example(examples) as Argv<ConfigFlags>
-}
+const examples: ReadonlyArray<[string, string?]> = [
+	[`${APP_NAME} list -g ./vala-girs/gir-1.0`, "Lists all available GIR modules in ./vala-girs/gir-1.0"],
+	[
+		`${APP_NAME} list --ignore=Gtk-3.0 xrandr-1.3`,
+		"Lists all available GIR modules in /usr/share/gir-1.0 but not Gtk-3.0 and xrandr-1.3",
+	],
+];
 
- 
-const handler = async (args: ConfigFlags) => {
-    const config = await Config.load(args)
-    const generateConfig = Config.getOptionsGeneration(config)
-    const moduleLoader = new ModuleLoader(generateConfig)
-    const { grouped, failed } = await moduleLoader.getModules(config.modules, config.ignore)
-    const moduleGroups = Object.values(grouped)
-    if (Object.keys(grouped).length === 0) {
-        return Logger.error(ERROR_NO_MODULES_FOUND(config.girDirectories))
-    }
-
-    const conflictModules = moduleGroups.filter((moduleGroup) => moduleGroup.hasConflict)
-
-    const byHandModules = moduleGroups.filter(
-        (moduleGroup) => moduleGroup.modules[0].resolvedBy === ResolveType.BY_HAND,
-    )
-
-    const depModules = moduleGroups.filter(
-        (moduleGroup) => moduleGroup.modules[0].resolvedBy === ResolveType.DEPENDENCE,
-    )
-
-    Logger.info('\nSearch for gir files in:')
-    for (const dir of config.girDirectories) {
-        Logger.white(`- ${dir}`)
-    }
-
-    Logger.info('\nSelected Modules:')
-    for (const moduleGroup of byHandModules) {
-        for (const depModule of moduleGroup.modules) {
-            Logger.white(`- ${depModule.packageName}`)
-            Logger.gray(`  - ${depModule.path}`)
-        }
-    }
-
-    if (depModules.length > 0) {
-        Logger.yellow('\nDependencies:')
-        for (const moduleGroup of depModules) {
-            for (const depModule of moduleGroup.modules) {
-                Logger.white(`- ${depModule.packageName}`)
-                Logger.gray(`- ${depModule.path}`)
-            }
-        }
-    }
-
-    if (conflictModules.length > 0) {
-        Logger.danger('\nConflicts:')
-        for (const moduleGroup of conflictModules) {
-            Logger.white(`- ${moduleGroup.namespace}`)
-            for (const conflictModule of moduleGroup.modules) {
-                Logger.white(`  - ${conflictModule.packageName}`)
-                Logger.gray(`  - ${conflictModule.path}`)
-            }
-        }
-    }
-
-    if (failed.length > 0) {
-        Logger.danger('\nDependencies not found:')
-        for (const fail of failed) {
-            Logger.white(`- ${fail}`)
-        }
-    }
-}
+const builder = createBuilder<ListCommandArgs>(listOptions, examples);
 
-const examples: ReadonlyArray<[string, string?]> = [
-    [`${Config.appName} list -g ./vala-girs/gir-1.0`, `Lists all available GIR modules in ./vala-girs/gir-1.0`],
-    [
-        `${Config.appName} list --ignore=Gtk-3.0 xrandr-1.3`,
-        'Lists all available GIR modules in /usr/share/gir-1.0 but not Gtk-3.0 and xrandr-1.3',
-    ],
-]
+const handler = async (args: ConfigFlags) => {
+	const config = await load(args);
+	const generateConfig = getOptionsGeneration(config);
+	const registry = new NSRegistry(); // TODO: Use singleton
+	const moduleLoader = new ModuleLoader(generateConfig, registry);
+	const { grouped, failed } = await moduleLoader.getModules(config.modules, config.ignore);
+	const moduleGroups = Object.values(grouped);
+	if (Object.keys(grouped).length === 0) {
+		return logger.error(ERROR_NO_MODULES_FOUND(config.girDirectories));
+	}
+
+	const conflictModules = moduleGroups.filter((moduleGroup) => moduleGroup.hasConflict);
+
+	const byHandModules = moduleGroups.filter((moduleGroup) => moduleGroup.modules[0].resolvedBy === ResolveType.BY_HAND);
+
+	const depModules = moduleGroups.filter((moduleGroup) => moduleGroup.modules[0].resolvedBy === ResolveType.DEPENDENCE);
+
+	logger.info("\nSearch for gir files in:");
+	for (const dir of config.girDirectories) {
+		logger.white(`- ${dir}`);
+	}
+
+	logger.info("\nSelected Modules:");
+	for (const moduleGroup of byHandModules) {
+		for (const depModule of moduleGroup.modules) {
+			logger.white(`- ${depModule.packageName}`);
+			logger.gray(`  - ${depModule.path}`);
+		}
+	}
+
+	if (depModules.length > 0) {
+		logger.yellow("\nDependencies:");
+		for (const moduleGroup of depModules) {
+			for (const depModule of moduleGroup.modules) {
+				logger.white(`- ${depModule.packageName}`);
+				logger.gray(`- ${depModule.path}`);
+			}
+		}
+	}
+
+	if (conflictModules.length > 0) {
+		logger.danger("\nConflicts:");
+		for (const moduleGroup of conflictModules) {
+			logger.white(`- ${moduleGroup.namespace}`);
+			for (const conflictModule of moduleGroup.modules) {
+				logger.white(`  - ${conflictModule.packageName}`);
+				logger.gray(`  - ${conflictModule.path}`);
+			}
+		}
+	}
+
+	if (failed.length > 0) {
+		logger.danger("\nDependencies not found:");
+		for (const fail of failed) {
+			logger.white(`- ${fail}`);
+		}
+	}
+};
 
 export const list = {
-    command,
-    description,
-    builder,
-    handler,
-    examples,
-}
+	command,
+	description,
+	builder,
+	handler,
+	examples,
+};