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

package/src/commands/copy.ts

@@ -2,93 +2,88 @@
  * Everything you need for the `ts-for-gir copy` command is located here
  */
 
-import { Argv, BuilderCallback } from 'yargs'
-import { copyFile, mkdir } from 'fs/promises'
-import { basename, join } from 'path'
-import { ModuleLoader } from '../module-loader.js'
-import { Config } from '../config.js'
-import { Logger, ERROR_NO_MODULES_FOUND } from '@ts-for-gir/lib'
+import { copyFile, mkdir } from "node:fs/promises";
+import { basename, join } from "node:path";
+import type { ConfigFlags, GirModuleResolvedBy, UserConfig } from "@ts-for-gir/lib";
+import { APP_NAME, ERROR_NO_MODULES_FOUND, Logger, NSRegistry } from "@ts-for-gir/lib";
+import { copyOptions, getOptionsGeneration, load } from "../config.ts";
+import { ModuleLoader } from "../module-loader.ts";
+import type { CopyCommandArgs } from "../types/index.ts";
+import { createBuilder } from "./command-builder.ts";
 
-import type { ConfigFlags, UserConfig, GirModuleResolvedBy } from '@ts-for-gir/lib'
+const command = "copy [modules..]";
 
-const command = 'copy [modules..]'
+const description = "Scan for *.gir files and copy them to a new directory";
 
-const description = 'Scan for *.gir files and copy them to a new directory'
+const logger = new Logger(true, "CopyCommand");
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-const builder: BuilderCallback<any, ConfigFlags> = (yargs: Argv<any>) => {
-    const optionNames = Object.keys(Config.copyOptions)
-    for (const optionName of optionNames) {
-        yargs = yargs.option(optionName, Config.copyOptions[optionName])
-    }
-    return yargs.example(examples) as Argv<ConfigFlags>
-}
+const examples: ReadonlyArray<[string, string?]> = [
+	[`${APP_NAME} copy -o ./gir`, "Copy found *.gir files to ./gir"],
+	[
+		`${APP_NAME} copy -g /usr/share/gir-1.0 --ignore=Gtk-3.0 xrandr-1.3 -o ./gir`,
+		"Copy all found *.gir files in /usr/share/gir-1.0 excluding Gtk-3.0 and xrandr-1.3 to ./gir",
+	],
+];
+
+const builder = createBuilder<CopyCommandArgs>(copyOptions, examples);
 
 const copyGirFile = async (config: UserConfig, depModule: GirModuleResolvedBy) => {
-    if (!depModule.path) {
-        Logger.danger(`- ${depModule.packageName} not found`)
-        return
-    }
-    if (!config.outdir) {
-        Logger.error(`outdir not found`)
-        return
-    }
-    const filename = basename(depModule.path)
-    const dest = join(config.outdir, filename)
-    if (depModule.path === dest) {
-        Logger.yellow(`Skip ${depModule.path}`)
-        return
-    }
-    Logger.success(`Copy ${depModule.path}`)
-    await copyFile(depModule.path, dest)
-}
+	if (!depModule.path) {
+		logger.danger(`- ${depModule.packageName} not found`);
+		return;
+	}
+	if (!config.outdir) {
+		logger.error("outdir not found");
+		return;
+	}
+	const filename = basename(depModule.path);
+	const dest = join(config.outdir, filename);
+	if (depModule.path === dest) {
+		logger.yellow(`Skip ${depModule.path}`);
+		return;
+	}
+	logger.success(`Copy ${depModule.path}`);
+	await copyFile(depModule.path, dest);
+};
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 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 config = await load(args);
+	const generateConfig = getOptionsGeneration(config);
+	const registry = new NSRegistry();
+	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));
+	}
 
-    if (!config.outdir) {
-        Logger.error(`outdir not found`)
-        return
-    }
+	if (!config.outdir) {
+		logger.error("outdir not found");
+		return;
+	}
 
-    await mkdir(config.outdir, { recursive: true }).catch((err) => {
-        Logger.error(`Failed to copy gir files to ${config.outdir}: ${err}`)
-    })
+	await mkdir(config.outdir, { recursive: true }).catch((err) => {
+		logger.error(`Failed to copy gir files to ${config.outdir}: ${err}`);
+	});
 
-    for (const module of moduleGroups) {
-        for (const mod of module.modules) {
-            await copyGirFile(config, mod)
-        }
-    }
+	for (const module of moduleGroups) {
+		for (const mod of module.modules) {
+			await copyGirFile(config, mod);
+		}
+	}
 
-    if (failed.length > 0) {
-        Logger.danger('\nDependencies not found:')
-        for (const fail of failed) {
-            Logger.white(`- ${fail}`)
-        }
-    }
-}
-
-const examples: ReadonlyArray<[string, string?]> = [
-    [`${Config.appName} copy -o ./gir`, `Copy found *.gir files to ./gir`],
-    [
-        `${Config.appName} copy -g /usr/share/gir-1.0 --ignore=Gtk-3.0 xrandr-1.3 -o ./gir`,
-        'Copy all found *.gir files in /usr/share/gir-1.0 excluding Gtk-3.0 and xrandr-1.3 to ./gir',
-    ],
-]
+	if (failed.length > 0) {
+		logger.danger("\nDependencies not found:");
+		for (const fail of failed) {
+			logger.white(`- ${fail}`);
+		}
+	}
+};
 
 export const copy = {
-    command,
-    description,
-    builder,
-    handler,
-    examples,
-}
+	command,
+	description,
+	builder,
+	handler,
+	examples,
+};

package/src/commands/doc.ts

@@ -1,58 +1,55 @@
 /**
- * Everything you need for the `ts-for-gir generate` command is located here
+ * Everything you need for the `ts-for-gir doc` 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 { HtmlDocGenerator } from "@ts-for-gir/generator-html-doc";
+import { APP_NAME, type ConfigFlags, NSRegistry } from "@ts-for-gir/lib";
+import { docOptions, getOptionsGeneration, load } from "../config.ts";
+import { TypeScriptFormatter } from "../formatters/typescript-formatter.ts";
+import type { DocCommandArgs } from "../types/index.ts";
+import { createBuilder } from "./command-builder.ts";
+import { runGenerationCommand } from "./run-generation-command.ts";
 
-import type { ConfigFlags } from '@ts-for-gir/lib'
+const command = "doc [modules..]";
 
-const command = 'doc [modules..]'
+const description = "Generates HTML documentation from GIR files using TypeDoc";
 
-const description = 'The HTML documentation generator is not yet implemented, but feel free to implement it 🤗'
+const examples: ReadonlyArray<[string, string?]> = [
+	[`${APP_NAME} doc Gtk-4.0 --outdir ./docs`, "Generate HTML documentation for Gtk-4.0"],
+	[`${APP_NAME} doc '*' --outdir ./docs`, "Generate documentation for all locally installed GIR modules"],
+	[
+		`${APP_NAME} doc --merge --jsonDir ./json-output --outdir ./docs`,
+		"Generate HTML from pre-generated JSON files (low memory)",
+	],
+];
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-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 = createBuilder<DocCommandArgs>(docOptions, examples);
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 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 = getOptionsGeneration(await load(args));
+	if (config.merge) {
+		if (!config.jsonDir) {
+			throw new Error("--jsonDir is required when using --merge mode");
+		}
+		const generator = new HtmlDocGenerator(config, new NSRegistry());
+		await generator.generateFromJson(config.jsonDir);
+		return;
+	}
+
+	await runGenerationCommand(args, {
+		generatorType: GeneratorType.HTML_DOC,
+		loggerName: "DocCommand",
+		configureRegistry: (registry) => {
+			registry.registerFormatter("dts", new TypeScriptFormatter());
+		},
+	});
+};
 
 export const doc = {
-    command,
-    description,
-    builder,
-    handler,
-    examples,
-}
+	command,
+	description,
+	builder,
+	handler,
+	examples,
+};

package/src/commands/generate.ts

@@ -2,89 +2,45 @@
  * 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 { GeneratorType } from "@ts-for-gir/generator-base";
+import { APP_NAME, type ConfigFlags } from "@ts-for-gir/lib";
+import { generateOptions } from "../config.ts";
+import { TypeScriptFormatter } from "../formatters/typescript-formatter.ts";
+import type { GenerateCommandArgs } from "../types/index.ts";
+import { createBuilder } from "./command-builder.ts";
+import { runGenerationCommand } from "./run-generation-command.ts";
 
-import type { ConfigFlags } from '@ts-for-gir/lib'
-import { Formatter } from '@ts-for-gir/lib'
+const command = "generate [modules..]";
 
-const command = 'generate [modules..]'
-
-const description = 'Generates Typescript type definition .d.ts files from GIR for GJS'
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-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>
-}
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-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))
-    }
-
-    moduleLoader.parse(keep)
-
-    const tsForGir = new GenerationHandler(generateConfig, GeneratorType.TYPES)
-
-    const girModules = Array.from(keep).map((girModuleResolvedBy) => girModuleResolvedBy.module)
-
-    moduleLoader.dependencyManager.registerFormatter('dts', new TypeScriptFormatter())
-    await tsForGir.start(girModules, moduleLoader.dependencyManager)
-}
+const description = "Generates Typescript type definition .d.ts files from GIR for GJS";
 
 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',
-    ],
-]
+	[
+		`${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);
 
-class TypeScriptFormatter extends Formatter {
-    format(input: string): Promise<string> {
-        try {
-            return prettier.format(input, {
-                singleQuote: true,
-                parser: 'typescript',
-                printWidth: 120,
-                tabWidth: 4,
-            })
-        } catch (error) {
-            return Promise.resolve(input)
-        }
-    }
-}
+const handler = async (args: ConfigFlags) => {
+	await runGenerationCommand(args, {
+		generatorType: GeneratorType.TYPES,
+		loggerName: "GenerateCommand",
+		configureRegistry: (registry) => {
+			registry.registerFormatter("dts", new TypeScriptFormatter());
+		},
+	});
+};
 
 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,43 @@
+/**
+ * Everything you need for the `ts-for-gir json` command is located here
+ */
+
+import { GeneratorType } from "@ts-for-gir/generator-base";
+import { APP_NAME, type ConfigFlags } from "@ts-for-gir/lib";
+import { generateOptions } from "../config.ts";
+import { TypeScriptFormatter } from "../formatters/typescript-formatter.ts";
+import type { GenerateCommandArgs } from "../types/index.ts";
+import { createBuilder } from "./command-builder.ts";
+import { runGenerationCommand } from "./run-generation-command.ts";
+
+const command = "json [modules..]";
+
+const description = "Generates JSON representation from GIR files for analysis and tooling";
+
+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) => {
+	await runGenerationCommand(args, {
+		generatorType: GeneratorType.JSON,
+		loggerName: "JsonCommand",
+		configureRegistry: (registry) => {
+			registry.registerFormatter("dts", new TypeScriptFormatter());
+		},
+	});
+};
+
+export const json = {
+	command,
+	description,
+	builder,
+	handler,
+	examples,
+};

package/src/commands/list.ts

@@ -2,101 +2,82 @@
  * 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 } 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(true, "ListCommand");
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-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>
-}
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-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}`)
-            }
-        }
-    }
+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",
+	],
+];
 
-    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();
+	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 allModules = moduleGroups.filter((moduleGroup) => !moduleGroup.hasConflict);
+
+	logger.info("\nSearch for gir files in:");
+	for (const dir of config.girDirectories) {
+		logger.white(`- ${dir}`);
+	}
+
+	// Show all available modules
+	logger.info("\nAvailable Modules:");
+	for (const moduleGroup of allModules) {
+		for (const module of moduleGroup.modules) {
+			logger.white(`- ${module.packageName}`);
+			logger.gray(`  - ${module.path}`);
+		}
+	}
+
+	// Only show sections if there is actual content
+	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,
+};