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

package/src/commands/generate.ts

@@ -15,9 +15,9 @@ import { Formatter } from '@ts-for-gir/lib'
 
 const command = 'generate [modules..]'
 
-const description = 'Generates .d.ts files from GIR for GJS'
+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) {
@@ -26,11 +26,11 @@ const builder: BuilderCallback<any, ConfigFlags> = (yargs: Argv<any>) => {
     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.getGenerateConfig(config)
+    const generateConfig = Config.getOptionsGeneration(config)
     const moduleLoader = new ModuleLoader(generateConfig)
     const { keep } = await moduleLoader.getModulesResolved(
         config.modules,
@@ -42,6 +42,8 @@ const handler = async (args: ConfigFlags) => {
         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)
@@ -57,8 +59,6 @@ const examples: ReadonlyArray<[string, string?]> = [
     ],
     [`${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 '*' -e gjs`, 'Generate .d.ts. files only for gjs'],
-    [`${Config.appName} generate '*' -e node`, 'Generate .d.ts. files only for node'],
     [`${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`,
@@ -76,11 +76,8 @@ class TypeScriptFormatter extends Formatter {
                 tabWidth: 4,
             })
         } catch (error) {
+            Logger.warn('[TypeScriptFormatter] Failed to format with prettier, returning original input', error)
             return Promise.resolve(input)
-            // TODO: Don't return invalid TypeScript, useful for debugging for now.
-            // console.error('Failed to format output...')
-            // console.error(input)
-            // throw error
         }
     }
 }

package/src/commands/index.ts

@@ -1,3 +1,4 @@
+export * from './copy.js'
 export * from './doc.js'
 export * from './generate.js'
 export * from './list.js'

package/src/commands/list.ts

@@ -13,7 +13,7 @@ const command = 'list [modules..]'
 
 const description = 'Lists all available GIR modules'
 
-// 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) {
@@ -22,10 +22,10 @@ const builder: BuilderCallback<any, ConfigFlags> = (yargs: Argv<any>) => {
     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.getGenerateConfig(config)
+    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)
@@ -43,10 +43,16 @@ const handler = async (args: ConfigFlags) => {
         (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}`)
         }
     }
 
@@ -55,6 +61,7 @@ const handler = async (args: ConfigFlags) => {
         for (const moduleGroup of depModules) {
             for (const depModule of moduleGroup.modules) {
                 Logger.white(`- ${depModule.packageName}`)
+                Logger.gray(`- ${depModule.path}`)
             }
         }
     }
@@ -65,6 +72,7 @@ const handler = async (args: ConfigFlags) => {
             Logger.white(`- ${moduleGroup.namespace}`)
             for (const conflictModule of moduleGroup.modules) {
                 Logger.white(`  - ${conflictModule.packageName}`)
+                Logger.gray(`  - ${conflictModule.path}`)
             }
         }
     }

package/src/config.ts

@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+ 
 /**
  * Default values, parse the config file and handle CLI flags
  */
@@ -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,
@@ -227,7 +261,7 @@ export class Config {
             loaders: {
                 // ESM loader
                 '.js': async (filepath) => {
-                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                     
                     const file = await import(filepath)
 
                     // Files with `exports.default = { ... }`
@@ -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)
     }