@ts-for-gir/cli/src/module-loader/file-finder.ts

TypeScript type definition generator for GObject introspection GIR files

/**
 * Handles finding GIR files in the filesystem
 */

import { basename, join } from "node:path";
import type { Dependency, DependencyManager } from "@ts-for-gir/lib";
import { splitModuleName } from "@ts-for-gir/lib";
import { glob } from "glob";

export class FileFinder {
	constructor(
		private readonly girDirectories: string[],
		private readonly dependencyManager: DependencyManager,
	) {}

	/**
	 * Find modules with the possibility to use wild cards for module names. E.g. `Gtk*` or `'*'`
	 * @param globPackageNames Module names with potential wildcards
	 * @param ignore Modules to ignore
	 */
	async findGirFiles(globPackageNames: string[], ignore: string[] = []): Promise<Set<string>> {
		const foundFiles = new Set<string>();

		for (let i = 0; i < globPackageNames.length; i++) {
			if (!globPackageNames[i]) {
				continue;
			}

			// Handle all patterns uniformly (including wildcards like "*" and "Gtk*")
			const filename = `${globPackageNames[i]}.gir`;
			const pattern = this.girDirectories.map((girDirectory) => join(girDirectory, filename));
			const ignoreGirs = this.girDirectories.flatMap((girDirectory) =>
				ignore.map((ignored) => {
					// Remove */ prefix if present (e.g., "*/Gtk-4.0" -> "Gtk-4.0")
					const cleanIgnored = ignored.startsWith("*/") ? ignored.slice(2) : ignored;
					return join(girDirectory, `${cleanIgnored}.gir`);
				}),
			);
			const files = await glob(pattern, { ignore: ignoreGirs });

			for (const file of files) {
				foundFiles.add(file);
			}
		}

		return foundFiles;
	}

	/**
	 * Convert GIR file paths to Dependency objects
	 * @param girFiles Set of GIR file paths
	 */
	async girFilePathToDependencies(girFiles: Set<string>): Promise<Dependency[]> {
		const dependencies: Dependency[] = [];

		for (const girFile of girFiles) {
			const packageName = basename(girFile, ".gir");
			const { namespace, version } = splitModuleName(packageName);
			const dep = await this.dependencyManager.get(namespace, version);
			dependencies.push(dep);
		}

		return dependencies;
	}
}