@ts-for-gir/cli 4.0.0-beta.1 → 4.0.0-beta.11

package/src/config.ts

@@ -6,9 +6,10 @@ import { Options } from 'yargs'
 import { cosmiconfig, Options as ConfigSearchOptions } from 'cosmiconfig'
 import { join, extname, dirname, resolve } from 'path'
 import { writeFile } from 'fs/promises'
+import { existsSync } from 'fs'
 import { merge, isEqual, Logger, APP_NAME, APP_USAGE, ERROR_CONFIG_EXTENSION_UNSUPPORTED } from '@ts-for-gir/lib'
 
-import type { UserConfig, ConfigFlags, UserConfigLoadResult, GenerateConfig } from '@ts-for-gir/lib'
+import type { UserConfig, ConfigFlags, UserConfigLoadResult, OptionsGeneration } from '@ts-for-gir/lib'
 
 export class Config {
     static appName = APP_NAME
@@ -30,11 +31,16 @@ export class Config {
         ignoreVersionConflicts: false,
         noNamespace: false,
         noComments: false,
-        noDebugComments: false,
-        fixConflicts: true,
         promisify: true,
         npmScope: '@girs',
-        packageYarn: false,
+        workspace: false,
+        onlyVersionPrefix: false,
+        noPrettyPrint: false,
+        // Disabled by default because advanced variants are complicated,
+        // it does impact performance (especially on older typescript versions)
+        // and we'd need to test it works with the updated bindings
+        noAdvancedVariants: true,
+        package: false,
     }
 
     static configFilePath = join(process.cwd(), Config.defaults.configName)
@@ -87,7 +93,7 @@ export class Config {
         },
         ignoreVersionConflicts: {
             type: 'boolean',
-            description: 'Do not ask for package versions if multiple versions are found',
+            description: 'Skip prompts for library version selection when multiple versions are detected',
             default: Config.defaults.ignoreVersionConflicts,
             normalize: true,
         },
@@ -100,7 +106,7 @@ export class Config {
         },
         configName: {
             type: 'string',
-            description: 'Name of the config if you want to use a different name',
+            description: 'Specify a custom name for the configuration file',
             default: Config.defaults.configName,
             normalize: true,
         },
@@ -118,18 +124,6 @@ export class Config {
             default: Config.defaults.noComments,
             normalize: true,
         },
-        noDebugComments: {
-            type: 'boolean',
-            description: 'Do not generate debugging inline comments',
-            default: Config.defaults.noDebugComments,
-            normalize: true,
-        },
-        fixConflicts: {
-            type: 'boolean',
-            description: 'Fix Inheritance and implementation type conflicts',
-            default: Config.defaults.fixConflicts,
-            normalize: true,
-        },
         promisify: {
             type: 'boolean',
             description: 'Generate promisified functions for async/finish calls',
@@ -142,10 +136,36 @@ export class Config {
             default: Config.defaults.npmScope,
             normalize: true,
         },
-        packageYarn: {
+        workspace: {
+            type: 'boolean',
+            description:
+                'Uses the workspace protocol for the generated packages which can be used with package managers like Yarn and PNPM',
+            default: Config.defaults.workspace,
+            normalize: true,
+        },
+        onlyVersionPrefix: {
+            type: 'boolean',
+            description:
+                'Only use the version prefix for the ambient module exports. This is useful if, for whatever reason, you want to use different library versions of the same library in your project.',
+            default: Config.defaults.onlyVersionPrefix,
+            normalize: true,
+        },
+        noPrettyPrint: {
             type: 'boolean',
-            description: 'Adds Yarn workspace support to the NPM packages',
-            default: Config.defaults.packageYarn,
+            description: 'Do not prettify the generated types',
+            default: Config.defaults.noPrettyPrint,
+            normalize: true,
+        },
+        noAdvancedVariants: {
+            type: 'boolean',
+            description: 'Disable GLib.Variant class with string parsing',
+            default: Config.defaults.noAdvancedVariants,
+            normalize: true,
+        },
+        package: {
+            type: 'boolean',
+            description: 'Generate the typescript types with package.json support',
+            default: Config.defaults.package,
             normalize: true,
         },
     }
@@ -165,16 +185,29 @@ export class Config {
         configName: this.options.configName,
         noNamespace: this.options.noNamespace,
         noComments: this.options.noComments,
-        noDebugComments: this.options.noDebugComments,
-        fixConflicts: this.options.fixConflicts,
         promisify: this.options.promisify,
         npmScope: this.options.npmScope,
-        packageYarn: this.options.packageYarn,
+        workspace: this.options.workspace,
+        onlyVersionPrefix: this.options.onlyVersionPrefix,
+        noPrettyPrint: this.options.noPrettyPrint,
+        noAdvancedVariants: this.options.noAdvancedVariants,
+        package: this.options.package,
     }
 
     static listOptions = {
         modules: this.options.modules,
         girDirectories: Config.options.girDirectories,
+        root: this.options.root,
+        ignore: Config.options.ignore,
+        configName: Config.options.configName,
+        verbose: Config.options.verbose,
+    }
+
+    static copyOptions = {
+        modules: this.options.modules,
+        girDirectories: Config.options.girDirectories,
+        root: this.options.root,
+        outdir: Config.options.outdir,
         ignore: Config.options.ignore,
         configName: Config.options.configName,
         verbose: Config.options.verbose,
@@ -183,6 +216,7 @@ export class Config {
     static docOptions = {
         modules: this.options.modules,
         girDirectories: Config.options.girDirectories,
+        root: this.options.root,
         outdir: Config.options.outdir,
         ignore: Config.options.ignore,
         verbose: Config.options.verbose,
@@ -254,21 +288,9 @@ export class Config {
         return configFile
     }
 
-    public static getGenerateConfig(config: UserConfig): GenerateConfig {
-        const generateConfig: GenerateConfig = {
-            girDirectories: config.girDirectories,
-            root: config.root,
-            outdir: config.outdir,
-            verbose: config.verbose,
-            noNamespace: config.noNamespace,
-            noComments: config.noComments,
-            noDebugComments: config.noDebugComments,
-            fixConflicts: config.fixConflicts,
-            promisify: config.promisify,
-            npmScope: config.npmScope,
-            packageYarn: config.packageYarn,
-            noPrettyPrint: false,
-            noAdvancedVariants: true,
+    public static getOptionsGeneration(config: UserConfig): OptionsGeneration {
+        const generateConfig: OptionsGeneration = {
+            ...config,
         }
         return generateConfig
     }
@@ -287,21 +309,7 @@ export class Config {
         const configFileData = configFile?.config || {}
 
         const config: UserConfig = {
-            verbose: options.verbose,
-            ignoreVersionConflicts: options.ignoreVersionConflicts,
-            print: options.print,
-            root: options.root,
-            outdir: options.outdir,
-            girDirectories: options.girDirectories,
-            ignore: options.ignore,
-            modules: options.modules,
-            noNamespace: options.noNamespace,
-            noComments: options.noComments,
-            noDebugComments: options.noDebugComments,
-            fixConflicts: options.fixConflicts,
-            promisify: options.promisify,
-            npmScope: options.npmScope,
-            packageYarn: options.packageYarn,
+            ...options,
         }
 
         if (configFileData) {
@@ -363,20 +371,6 @@ export class Config {
             ) {
                 config.noComments = configFileData.noComments
             }
-            // noDebugComments
-            if (
-                config.noDebugComments === Config.options.noDebugComments.default &&
-                typeof configFileData.noDebugComments === 'boolean'
-            ) {
-                config.noDebugComments = configFileData.noDebugComments
-            }
-            // fixConflicts
-            if (
-                config.fixConflicts === Config.options.fixConflicts.default &&
-                typeof configFileData.fixConflicts === 'boolean'
-            ) {
-                config.fixConflicts = configFileData.fixConflicts
-            }
             // promisify
             if (
                 config.promisify === Config.options.promisify.default &&
@@ -388,12 +382,37 @@ export class Config {
             if (config.npmScope === Config.options.npmScope.default && configFileData.npmScope) {
                 config.npmScope = configFileData.npmScope
             }
-            // packageYarn
+            // workspace
+            if (
+                config.workspace === Config.options.workspace.default &&
+                typeof configFileData.workspace === 'boolean'
+            ) {
+                config.workspace = configFileData.workspace
+            }
+            // onlyVersionPrefix
             if (
-                config.packageYarn === Config.options.packageYarn.default &&
-                typeof configFileData.packageYarn === 'boolean'
+                config.onlyVersionPrefix === Config.options.onlyVersionPrefix.default &&
+                typeof configFileData.onlyVersionPrefix === 'boolean'
             ) {
-                config.packageYarn = configFileData.packageYarn
+                config.onlyVersionPrefix = configFileData.onlyVersionPrefix
+            }
+            // noPrettyPrint
+            if (
+                config.noPrettyPrint === Config.options.noPrettyPrint.default &&
+                typeof configFileData.noPrettyPrint === 'boolean'
+            ) {
+                config.noPrettyPrint = configFileData.noPrettyPrint
+            }
+            // noAdvancedVariants
+            if (
+                config.noAdvancedVariants === Config.options.noAdvancedVariants.default &&
+                typeof configFileData.noAdvancedVariants === 'boolean'
+            ) {
+                config.noAdvancedVariants = configFileData.noAdvancedVariants
+            }
+            // package
+            if (config.package === Config.options.package.default && typeof configFileData.package === 'boolean') {
+                config.package = configFileData.package
             }
         }
 
@@ -420,14 +439,12 @@ 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-10',
-        '/usr/lib64/mutter-11',
-        '/usr/lib64/mutter-12',
-        '/usr/lib/x86_64-linux-gnu/mutter-10',
-        '/usr/lib/x86_64-linux-gnu/mutter-11',
-        '/usr/lib/x86_64-linux-gnu/mutter-12',
+        '/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.
@@ -435,7 +452,7 @@ function getDefaultGirDirectories(): string[] {
     const dataDirs = process.env['XDG_DATA_DIRS']?.split(':') || []
     for (let dataDir of dataDirs) {
         dataDir = join(dataDir, 'gir-1.0')
-        if (!girDirectories.includes(dataDir)) {
+        if (!girDirectories.includes(dataDir) && existsSync(dataDir)) {
             girDirectories.push(dataDir)
         }
     }

package/src/generation-handler.ts

@@ -10,16 +10,16 @@ import {
 } from '@ts-for-gir/lib'
 import { GeneratorType, Generator } from '@ts-for-gir/generator-base'
 import { TypeDefinitionGenerator } from '@ts-for-gir/generator-typescript'
-// import { HtmlDocGenerator } from '@ts-for-gir/generator-html-doc'
+import { HtmlDocGenerator } from '@ts-for-gir/generator-html-doc'
 
-import type { GenerateConfig, NSRegistry } from '@ts-for-gir/lib'
+import type { OptionsGeneration, NSRegistry } from '@ts-for-gir/lib'
 
 export class GenerationHandler {
     log: Logger
     generator: Generator
 
     constructor(
-        private readonly config: GenerateConfig,
+        private readonly config: OptionsGeneration,
         type: GeneratorType,
     ) {
         this.log = new Logger(config.verbose, 'GenerationHandler')
@@ -28,9 +28,9 @@ export class GenerationHandler {
             case GeneratorType.TYPES:
                 this.generator = new TypeDefinitionGenerator(config)
                 break
-            // case GeneratorType.HTML_DOC:
-            //     this.generator = new HtmlDocGenerator(config)
-            //     break
+            case GeneratorType.HTML_DOC:
+                this.generator = new HtmlDocGenerator(config)
+                break
             default:
                 throw new Error('Unknown Generator')
         }
@@ -61,12 +61,10 @@ export class GenerationHandler {
 
         for (const girModule of girModules) {
             this.log.log(` - ${girModule.packageName} ...`)
-            girModule.start(girModules)
-
             await this.generator.generate(registry, girModule)
         }
 
-        await this.generator.finish(registry)
+        await this.generator.finish(registry, girModules)
 
         this.log.success(GENERATING_TYPES_DONE)
     }

package/src/module-loader.ts

@@ -3,11 +3,9 @@
  */
 
 import inquirer, { ListQuestion, Answers } from 'inquirer'
-import glob from 'tiny-glob'
-import { basename } from 'path'
-import { readFile } from 'fs/promises'
+import { glob } from 'glob'
+import { basename, join } from 'path'
 import { bold } from 'colorette'
-import { parser } from '@gi.ts/parser'
 import {
     DependencyManager,
     ResolveType,
@@ -22,7 +20,7 @@ import { Config } from './config.js'
 
 import type {
     GirModulesGroupedMap,
-    GenerateConfig,
+    OptionsGeneration,
     GirModuleResolvedBy,
     GirModulesGrouped,
     DependencyMap,
@@ -35,7 +33,7 @@ export class ModuleLoader {
     dependencyManager: DependencyManager
     /** Transitive module dependencies */
     modDependencyMap: DependencyMap = {}
-    constructor(protected readonly config: GenerateConfig) {
+    constructor(protected readonly config: OptionsGeneration) {
         this.log = new Logger(config.verbose, 'ModuleLoader')
         this.dependencyManager = DependencyManager.getInstance(config)
     }
@@ -176,7 +174,7 @@ export class ModuleLoader {
      * @param girModulesGroupedMap
      * @param packageName
      */
-    protected findPackageNamesDependOnPackage(
+    protected findGirFilesDependOnPackage(
         girModulesGroupedMap: GirModulesGroupedMap,
         packageName: string,
     ): GirModuleResolvedBy[] {
@@ -201,13 +199,13 @@ export class ModuleLoader {
      * @param girModulesGroupedMap
      * @param packageName
      */
-    protected findPackageNamesDependOnPackages(
+    protected findGirFilesDependOnPackages(
         girModulesGroupedMap: GirModulesGroupedMap,
         packageNames: string[],
     ): GirModuleResolvedBy[] {
         let girModules: GirModuleResolvedBy[] = []
         for (const packageName of packageNames) {
-            girModules = girModules.concat(this.findPackageNamesDependOnPackage(girModulesGroupedMap, packageName))
+            girModules = [...girModules, ...this.findGirFilesDependOnPackage(girModulesGroupedMap, packageName)]
         }
         return girModules
     }
@@ -270,10 +268,7 @@ export class ModuleLoader {
                 while (goBack) {
                     versionAnswer = await this.askForVersionsPrompt(girModulesGrouped)
                     // Check modules that depend on the unchosen modules
-                    wouldIgnoreDeps = this.findPackageNamesDependOnPackages(
-                        girModulesGroupedMap,
-                        versionAnswer.unselected,
-                    )
+                    wouldIgnoreDeps = this.findGirFilesDependOnPackages(girModulesGroupedMap, versionAnswer.unselected)
                     // Do not check dependencies that have already been ignored
                     wouldIgnoreDeps = wouldIgnoreDeps.filter((dep) => !ignore.includes(dep.packageName))
                     ignoreDepsAnswer = await this.askIgnoreDepsPrompt(wouldIgnoreDeps)
@@ -356,7 +351,7 @@ export class ModuleLoader {
      * @param girModule
      */
     protected extendDependencyMapByGirModule(girModule: GirModule): void {
-        this.modDependencyMap[girModule.packageName] = girModule.dependencies
+        this.modDependencyMap[girModule.packageName] = girModule.dependencies!
     }
 
     /**
@@ -364,11 +359,11 @@ export class ModuleLoader {
      * is required so that all dependencies can be found internally when generating the dependency imports for the module .d.ts file
      * @param girModules
      */
-    protected setTraverseDependenciesForModules(girModules: GirModuleResolvedBy[]): void {
+    protected async initGirModules(girModules: GirModuleResolvedBy[]): Promise<void> {
         for (const girModule of girModules) {
             const result: { [name: string]: Dependency } = {}
             this.traverseDependencies(girModule.packageName, result)
-            girModule.module.transitiveDependencies = Object.values(result)
+            await girModule.module.initTransitiveDependencies(Object.values(result))
         }
     }
 
@@ -383,10 +378,8 @@ export class ModuleLoader {
             return null
         }
 
-        this.log.log(`Parsing ${dependency.path}...`)
-        const fileContents = await readFile(dependency.path, 'utf8')
-        const result = parser.parseGir(fileContents)
-        const girModule = GirModule.load(result, this.config, this.dependencyManager)
+        this.log.log(`Loading ${dependency.packageName}...`)
+        const girModule = await GirModule.load(dependency, this.config, this.dependencyManager)
         // Figure out transitive module dependencies
         this.extendDependencyMapByGirModule(girModule)
         return girModule
@@ -451,6 +444,7 @@ export class ModuleLoader {
                         packageName: girModule.packageName,
                         module: girModule,
                         resolvedBy,
+                        path: dependency.path,
                     }
                     girModules.push(addModule)
                     newModuleFound = true
@@ -466,21 +460,13 @@ export class ModuleLoader {
         }
 
         // Figure out transitive module dependencies
-        this.setTraverseDependenciesForModules(girModules)
+        await this.initGirModules(girModules)
 
         // Load girModules for dependencies
         for (const girModule of girModules) {
             // Load dependencies
             const transitiveDependencies = girModule.module.transitiveDependencies
             if (transitiveDependencies.length > 0) {
-                for (const transitiveDependency of transitiveDependencies) {
-                    if (ignoreDependencies.includes(transitiveDependency.packageName)) {
-                        this.log.warn(
-                            `Load dependency "${transitiveDependency.packageName}" which is in the ignore list, if this should really be ignored also ignore "${girModule.packageName}"`,
-                        )
-                    }
-                }
-
                 await this.loadGirModules(
                     transitiveDependencies,
                     ignoreDependencies,
@@ -490,6 +476,7 @@ export class ModuleLoader {
                 )
             }
         }
+
         return {
             loaded: girModules,
             failed: failedGirModules,
@@ -501,60 +488,53 @@ export class ModuleLoader {
      * @param modules
      * @param ignore
      */
-    protected async findPackageNames(modules: string[], ignore: string[] = []): Promise<Set<string>> {
-        const foundModules = new Set<string>()
-
-        for (let i = 0; i < modules.length; i++) {
-            if (modules[i]) {
-                const filename = `${modules[i]}.gir`
-                let files: string[] = []
-                for (const girDirectory of this.config.girDirectories) {
-                    try {
-                        files = files.concat(await glob(filename, { cwd: girDirectory }))
-                    } catch (error) {
-                        this.log.warn(`Error on finding "${filename}" in "${girDirectory}"`, error)
-                    }
-                }
+    protected async findGirFiles(globPackageNames: string[], ignore: string[] = []): Promise<Set<string>> {
+        const foundFiles = new Set<string>()
 
-                let globModules = files.map((file) => basename(file, '.gir'))
-                // Filter out the ignored modules
-                globModules = globModules.filter((mod) => {
-                    const isIgnored = ignore.includes(mod)
-                    if (isIgnored) {
-                        this.log.warn(`Ignore ${mod}`)
-                    }
-                    return !isIgnored
-                })
-                globModules.forEach((mod) => foundModules.add(mod))
+        for (let i = 0; i < globPackageNames.length; i++) {
+            if (!globPackageNames[i]) {
+                continue
             }
+            const filename = `${globPackageNames[i]}.gir`
+            const pattern = this.config.girDirectories.map((girDirectory) => join(girDirectory, filename))
+            const ignoreGirs = ignore.map((girDirectory) => girDirectory + '.gir')
+            const files = await glob(pattern, { ignore: ignoreGirs })
+            files.forEach((file) => foundFiles.add(file))
         }
-        return foundModules
+
+        return foundFiles
     }
 
-    protected packageNamesToDependencies(packageNames: Set<string>): Dependency[] {
-        return Array.from(packageNames).map((packageName) => {
+    protected 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)
-            return this.dependencyManager.get(namespace, version)
-        })
+            const dep = await this.dependencyManager.get(namespace, version)
+            dependencies.push(dep)
+        }
+
+        return dependencies
     }
 
     /**
-     * Loads all found `packageNames` and sorts out those that the user does not want to use including their dependencies
+     * Loads all found `packageNames`
      * @param girDirectories
      * @param packageNames
+     * @param doNotAskForVersionOnConflict Set this to false if you want to get a prompt for each version conflict
      */
     public async getModulesResolved(
         packageNames: string[],
         ignore: string[] = [],
         doNotAskForVersionOnConflict = true,
     ): Promise<{ keep: GirModuleResolvedBy[]; grouped: GirModulesGroupedMap; ignore: string[]; failed: Set<string> }> {
-        const foundPackageNames = await this.findPackageNames([...packageNames], ignore)
+        const girFiles = await this.findGirFiles([...packageNames], ignore)
         // Always require these because GJS does...
-        const GLib = this.dependencyManager.get('GLib', '2.0')
-        const Gio = this.dependencyManager.get('Gio', '2.0')
-        const GObject = this.dependencyManager.get('GObject', '2.0')
+        const GLib = await this.dependencyManager.get('GLib', '2.0')
+        const Gio = await this.dependencyManager.get('Gio', '2.0')
+        const GObject = await this.dependencyManager.get('GObject', '2.0')
 
-        const dependencies = this.packageNamesToDependencies(foundPackageNames)
+        const dependencies = await this.girFilePathToDependencies(girFiles)
 
         const { loaded, failed } = await this.loadGirModules(
             [
@@ -582,7 +562,7 @@ export class ModuleLoader {
     }
 
     /**
-     * Find modules with the possibility to use wild cards for module names. E.g. `Gtk*` or `'*'`
+     * Find modules
      * @param girDirectories
      * @param modules
      */
@@ -590,10 +570,17 @@ export class ModuleLoader {
         modules: string[],
         ignore: string[] = [],
     ): Promise<{ grouped: GirModulesGroupedMap; loaded: GirModuleResolvedBy[]; failed: string[] }> {
-        const foundPackageNames = await this.findPackageNames(modules, ignore)
-        const dependencies = this.packageNamesToDependencies(foundPackageNames)
+        const girFiles = await this.findGirFiles(modules, ignore)
+        const dependencies = await this.girFilePathToDependencies(girFiles)
         const { loaded, failed } = await this.loadGirModules(dependencies, ignore)
         const grouped = this.groupGirFiles(loaded)
         return { grouped, loaded, failed: Array.from(failed) }
     }
+
+    /** Start parsing the gir modules */
+    public parse(girModules: GirModuleResolvedBy[]): void {
+        for (const girModule of girModules) {
+            girModule.module.parse()
+        }
+    }
 }

package/src/start.ts

@@ -2,7 +2,7 @@
 import yargs from 'yargs'
 import { hideBin } from 'yargs/helpers'
 
-import { generate, list, doc } from './commands/index.js'
+import { generate, list, doc, copy } from './commands/index.js'
 import { Config } from './config.js'
 
 void yargs(hideBin(process.argv))
@@ -11,6 +11,7 @@ void yargs(hideBin(process.argv))
     .usage(Config.usage)
     .command(generate.command, generate.description, generate.builder, generate.handler)
     .command(list.command, list.description, list.builder, list.handler)
+    .command(copy.command, copy.description, copy.builder, copy.handler)
     .command(doc.command, doc.description, doc.builder, doc.handler)
     .demandCommand(1)
     .help().argv