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

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");
 
-// 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>
-}
+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",
+	],
+];
 
-// 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}`)
-            }
-        }
-    }
-
-    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,
+};

package/src/config/config-loader.ts

@@ -0,0 +1,203 @@
+/**
+ * Config loader functionality for ts-for-gir
+ */
+
+import { dirname, resolve } from "node:path";
+import type { ConfigFlags, OptionsGeneration, UserConfig, UserConfigLoadResult } from "@ts-for-gir/lib";
+import { APP_NAME, isEqual } from "@ts-for-gir/lib";
+import { type Options as ConfigSearchOptions, cosmiconfig } from "cosmiconfig";
+import { setConfigFilePath } from "./config-writer.ts";
+import { options } from "./options.ts";
+
+/**
+ * The user can create a `.ts-for-girrc` file for his default configs,
+ * this method load this config file an returns the user configuration
+ * @param configName If the user uses a custom config file name
+ */
+export async function loadConfigFile(configName?: string): Promise<UserConfigLoadResult | null> {
+	const configSearchOptions: Partial<ConfigSearchOptions> = {
+		loaders: {
+			// ESM loader
+			".js": async (filepath) => {
+				const file = await import(filepath);
+
+				// Files with `exports.default = { ... }`
+				if (file?.default?.default) {
+					return file.default.default as Partial<UserConfig>;
+				}
+				// Files with `export default { ... }`
+				if (file?.default) {
+					return file.default as Partial<UserConfig>;
+				}
+				// Files with `export { ... }`
+				return file as Partial<UserConfig>;
+			},
+		},
+	};
+
+	if (configName) {
+		configSearchOptions.searchPlaces = [configName];
+	}
+
+	const configFile: UserConfigLoadResult | null = await cosmiconfig(APP_NAME, configSearchOptions).search();
+
+	if (configFile?.filepath) {
+		setConfigFilePath(configFile.filepath);
+	}
+
+	return configFile;
+}
+
+/**
+ * Convert UserConfig to OptionsGeneration
+ */
+export function getOptionsGeneration(config: UserConfig): OptionsGeneration {
+	const generateConfig: OptionsGeneration = {
+		...config,
+	};
+	return generateConfig;
+}
+
+/**
+ * Validate the configuration
+ */
+export function validate(config: UserConfig): UserConfig {
+	return config;
+}
+
+/**
+ * Merge a single config value from file config to user config
+ * @param userConfig The user config object to update
+ * @param configFileData The config file data to merge from
+ * @param key The config key to merge
+ * @param optionDefault The default value from options
+ * @param validator Optional validation function
+ */
+function mergeConfigValue<K extends keyof UserConfig>(
+	userConfig: UserConfig,
+	configFileData: Partial<UserConfig>,
+	key: K,
+	optionDefault: unknown,
+	validator?: (value: unknown) => boolean,
+): void {
+	const fileValue = configFileData[key];
+	const userValue = userConfig[key];
+
+	// Skip if no file value
+	if (fileValue === undefined) return;
+
+	// Apply validator if provided
+	if (validator && !validator(fileValue)) return;
+
+	// Check if user value is default
+	const isDefault =
+		userValue === optionDefault ||
+		(Array.isArray(userValue) && Array.isArray(optionDefault) && isEqual(userValue, optionDefault));
+
+	if (isDefault) {
+		(userConfig[key] as UserConfig[K]) = fileValue as UserConfig[K];
+	}
+}
+
+/**
+ * Loads the values of the config file and concatenate them with passed cli flags / arguments.
+ * The values from config file are preferred if the cli flag value is the default (and so not set / overwritten)
+ * @param cliOptions CLI options passed by the user
+ */
+export async function load(cliOptions: ConfigFlags): Promise<UserConfig> {
+	const configFile = await loadConfigFile(cliOptions.configName);
+	const configFileData = configFile?.config || {};
+
+	const userConfig: UserConfig = {
+		...cliOptions,
+	};
+
+	if (configFileData) {
+		// Boolean options
+		mergeConfigValue(userConfig, configFileData, "verbose", options.verbose.default, (v) => typeof v === "boolean");
+		mergeConfigValue(
+			userConfig,
+			configFileData,
+			"ignoreVersionConflicts",
+			options.ignoreVersionConflicts.default,
+			(v) => typeof v === "boolean",
+		);
+		mergeConfigValue(userConfig, configFileData, "print", options.print.default, (v) => typeof v === "boolean");
+		mergeConfigValue(
+			userConfig,
+			configFileData,
+			"noNamespace",
+			options.noNamespace.default,
+			(v) => typeof v === "boolean",
+		);
+		mergeConfigValue(
+			userConfig,
+			configFileData,
+			"noComments",
+			options.noComments.default,
+			(v) => typeof v === "boolean",
+		);
+		mergeConfigValue(userConfig, configFileData, "promisify", options.promisify.default, (v) => typeof v === "boolean");
+		mergeConfigValue(userConfig, configFileData, "workspace", options.workspace.default, (v) => typeof v === "boolean");
+		mergeConfigValue(
+			userConfig,
+			configFileData,
+			"onlyVersionPrefix",
+			options.onlyVersionPrefix.default,
+			(v) => typeof v === "boolean",
+		);
+		mergeConfigValue(
+			userConfig,
+			configFileData,
+			"noPrettyPrint",
+			options.noPrettyPrint.default,
+			(v) => typeof v === "boolean",
+		);
+		mergeConfigValue(
+			userConfig,
+			configFileData,
+			"noAdvancedVariants",
+			options.noAdvancedVariants.default,
+			(v) => typeof v === "boolean",
+		);
+		mergeConfigValue(userConfig, configFileData, "package", options.package.default, (v) => typeof v === "boolean");
+		mergeConfigValue(userConfig, configFileData, "reporter", options.reporter.default, (v) => typeof v === "boolean");
+
+		// String options
+		mergeConfigValue(userConfig, configFileData, "npmScope", options.npmScope.default);
+		mergeConfigValue(userConfig, configFileData, "reporterOutput", options.reporterOutput.default);
+
+		// Array options
+		mergeConfigValue(userConfig, configFileData, "girDirectories", options.girDirectories.default);
+		mergeConfigValue(userConfig, configFileData, "ignore", options.ignore.default);
+		mergeConfigValue(userConfig, configFileData, "modules", options.modules.default);
+
+		// Special handling for root
+		if (userConfig.root === options.root.default && (configFileData.root || configFile?.filepath)) {
+			// Use the config file path as the root path if no root path is set
+			userConfig.root =
+				configFileData.root || (configFile?.filepath ? dirname(configFile.filepath) : (options.root.default as string));
+		}
+
+		// Special handling for outdir
+		if (userConfig.outdir === options.outdir.default && configFileData.outdir) {
+			userConfig.outdir = userConfig.print ? null : configFileData.outdir;
+		}
+	}
+
+	// Make paths absolute
+	if (userConfig.outdir && !userConfig.outdir.startsWith("/")) {
+		userConfig.outdir = resolve(userConfig.root, userConfig.outdir);
+	}
+
+	if (userConfig.girDirectories) {
+		userConfig.girDirectories = userConfig.girDirectories.map((dir) => {
+			if (!dir.startsWith("/")) {
+				return resolve(userConfig.root, dir);
+			}
+			return dir;
+		});
+	}
+
+	return validate(userConfig);
+}

package/src/config/config-writer.ts

@@ -0,0 +1,52 @@
+/**
+ * Config writer functionality for ts-for-gir
+ */
+
+import { writeFile } from "node:fs/promises";
+import { extname, join } from "node:path";
+import type { UserConfig } from "@ts-for-gir/lib";
+import { ERROR_CONFIG_EXTENSION_UNSUPPORTED, Logger, merge } from "@ts-for-gir/lib";
+import { loadConfigFile } from "./config-loader.ts";
+import { defaults } from "./defaults.ts";
+
+const logger = new Logger(false, "ConfigWriter");
+
+export let configFilePath = join(process.cwd(), defaults.configName);
+
+/**
+ * Update the config file path when a config is loaded
+ */
+export function setConfigFilePath(path: string): void {
+	configFilePath = path;
+}
+
+/**
+ * Overwrites values in the user config file
+ * @param configsToAdd Configuration values to add/update
+ * @param configName Optional custom config file name
+ */
+export async function addToConfig(configsToAdd: Partial<UserConfig>, configName?: string): Promise<void> {
+	const userConfig = await loadConfigFile(configName);
+	const path = userConfig?.filepath || configFilePath;
+	const configToStore = {};
+	merge(configToStore, userConfig?.config || {}, configsToAdd);
+
+	const fileExtension = extname(path);
+	let writeConfigString = "";
+
+	switch (fileExtension) {
+		case ".js":
+			writeConfigString = `export default ${JSON.stringify(configToStore, null, 4)}`;
+			break;
+		case ".json":
+			writeConfigString = `${JSON.stringify(configToStore, null, 4)}`;
+			break;
+		default:
+			logger.error(ERROR_CONFIG_EXTENSION_UNSUPPORTED);
+			break;
+	}
+
+	if (writeConfigString && path) {
+		return writeFile(path, writeConfigString);
+	}
+}

package/src/config/defaults.ts

@@ -0,0 +1,61 @@
+/**
+ * Default configuration values for ts-for-gir CLI
+ */
+
+import { existsSync } from "node:fs";
+import { join } from "node:path";
+
+/**
+ * Default CLI flag and argument values
+ */
+export const defaults = {
+	print: false,
+	configName: ".ts-for-girrc.js",
+	root: process.cwd(),
+	outdir: "./@types",
+	girDirectories: getDefaultGirDirectories(),
+	modules: ["*"],
+	ignore: [],
+	verbose: false,
+	ignoreVersionConflicts: false,
+	noNamespace: false,
+	noComments: false,
+	promisify: true,
+	npmScope: "@girs",
+	workspace: false,
+	onlyVersionPrefix: false,
+	noPrettyPrint: false,
+	noAdvancedVariants: false,
+	package: false,
+	reporter: false,
+	reporterOutput: "ts-for-gir-report.json",
+};
+
+/**
+ * Get default GIR directories based on the system configuration
+ */
+function getDefaultGirDirectories(): string[] {
+	const girDirectories = [
+		"/usr/local/share/gir-1.0",
+		"/usr/share/gir-1.0",
+		"/usr/share/*/gir-1.0",
+		"/usr/share/gnome-shell",
+		"/usr/share/gnome-shell/gir-1.0",
+		"/usr/lib64/mutter-*",
+		"/usr/lib/mutter-*",
+		"/usr/lib/x86_64-linux-gnu/mutter-*",
+	];
+
+	// NixOS and other distributions does not have a /usr/local/share directory.
+	// Instead, the nix store paths with Gir files are set as XDG_DATA_DIRS.
+	// See https://github.com/NixOS/nixpkgs/blob/96e18717904dfedcd884541e5a92bf9ff632cf39/pkgs/development/libraries/gobject-introspection/setup-hook.sh#L7-L10
+	const dataDirs = process.env.XDG_DATA_DIRS?.split(":") || [];
+	for (let dataDir of dataDirs) {
+		dataDir = join(dataDir, "gir-1.0");
+		if (!girDirectories.includes(dataDir) && existsSync(dataDir)) {
+			girDirectories.push(dataDir);
+		}
+	}
+
+	return girDirectories;
+}

package/src/config/index.ts

@@ -0,0 +1,8 @@
+/**
+ * Config module exports
+ */
+
+export { getOptionsGeneration, load, validate } from "./config-loader.ts";
+export { addToConfig, configFilePath } from "./config-writer.ts";
+export { defaults } from "./defaults.ts";
+export { analyzeOptions, copyOptions, docOptions, generateOptions, listOptions, options } from "./options.ts";