@ts-for-gir/cli 3.0.0-beta.8 → 3.0.0

package/src/config.ts

@@ -5,18 +5,21 @@
 import inquirer from 'inquirer'
 import { Options } from 'yargs'
 import { cosmiconfig, Options as ConfigSearchOptions } from 'cosmiconfig'
-import Path from 'path'
-import OS from 'os'
-import { merge, isEqual, readTsJsConfig } from './utils.js'
-import type { Environment, UserConfig, ConfigFlags, UserConfigLoadResult, GenerateConfig } from './types/index.js'
-import { promises as fs } from 'fs'
-import { Logger } from './logger.js'
-import { APP_NAME, APP_USAGE } from './constants.js'
+import { join, extname, dirname, resolve } from 'path'
+import { writeFile } from 'fs/promises'
 import {
-    WARN_USE_NAMESPACE_ON_TYPES,
-    WARN_USE_NAMESPACE_ON_ESM,
+    merge,
+    isEqual,
+    Logger,
+    APP_NAME,
+    APP_USAGE,
     ERROR_CONFIG_EXTENSION_UNSUPPORTED,
-} from './messages.js'
+    WARN_USE_ESM_FOR_ALIAS,
+    WARN_USE_GJS_FOR_ALIAS,
+} from '@ts-for-gir/lib'
+import { readTsJsConfig } from './utils.js'
+
+import type { Environment, UserConfig, ConfigFlags, UserConfigLoadResult, GenerateConfig } from '@ts-for-gir/lib'
 
 export class Config {
     static appName = APP_NAME
@@ -27,28 +30,30 @@ export class Config {
      * Default cli flag and argument values
      */
     static defaults = {
-        environments: ['gjs', 'node'],
-        pretty: false,
+        environments: ['gjs'],
         print: false,
         configName: '.ts-for-girrc.js',
+        root: process.cwd(),
         outdir: './@types',
-        girDirectories: OS.platform() === 'darwin' ? ['/usr/local/share/gir-1.0'] : ['/usr/share/gir-1.0'],
+        girDirectories: getDefaultGirDirectories(),
         modules: ['*'],
         ignore: [],
         verbose: false,
         ignoreVersionConflicts: false,
-        useNamespace: false,
+        noNamespace: false,
         buildType: 'lib',
-        moduleType: 'commonjs',
+        moduleType: 'esm',
         noComments: false,
         noDebugComments: false,
-        noCheck: false,
         fixConflicts: true,
         noDOMLib: false,
-        gnomeShellTypes: false,
+        generateAlias: false,
+        promisify: true,
+        npmScope: '@girs',
+        package: false,
     }
 
-    static configFilePath = Path.join(process.cwd(), Config.defaults.configName)
+    static configFilePath = join(process.cwd(), Config.defaults.configName)
 
     /**
      * CLI options used in commands/generate.ts and commands/list.ts
@@ -68,6 +73,12 @@ export class Config {
             default: Config.defaults.girDirectories,
             normalize: true,
         },
+        root: {
+            type: 'string',
+            description: 'Root directory of your project',
+            default: Config.defaults.root,
+            normalize: true,
+        },
         outdir: {
             type: 'string',
             alias: 'o',
@@ -105,16 +116,10 @@ export class Config {
             type: 'string',
             alias: 't',
             description: 'Specify what module code is generated.',
-            choices: ['esm', 'commonjs'],
+            choices: ['esm', 'commonjs', 'cjs'],
             default: Config.defaults.moduleType,
             normalize: true,
         },
-        pretty: {
-            type: 'boolean',
-            description: 'Prettifies the generated .d.ts files',
-            default: Config.defaults.pretty,
-            normalize: true,
-        },
         verbose: {
             type: 'boolean',
             alias: 'v',
@@ -141,11 +146,11 @@ export class Config {
             default: Config.defaults.configName,
             normalize: true,
         },
-        useNamespace: {
+        noNamespace: {
             type: 'boolean',
             alias: 'd',
-            description: 'Export all symbols for each module as a namespace',
-            default: Config.defaults.useNamespace,
+            description: 'Do not export all symbols for each module as a namespace',
+            default: Config.defaults.noNamespace,
             normalize: true,
         },
         noComments: {
@@ -161,12 +166,6 @@ export class Config {
             default: Config.defaults.noDebugComments,
             normalize: true,
         },
-        noCheck: {
-            type: 'boolean',
-            description: 'Disable typescript semantic checks using @ts-nocheck',
-            default: Config.defaults.noCheck,
-            normalize: true,
-        },
         fixConflicts: {
             type: 'boolean',
             description: 'Fix Inheritance and implementation type conflicts',
@@ -179,10 +178,29 @@ export class Config {
             default: Config.defaults.noDOMLib,
             normalize: true,
         },
-        gnomeShellTypes: {
+        generateAlias: {
+            type: 'boolean',
+            alias: 'a',
+            description: 'Generate an alias tsconfig file to support GJS ESM module imports',
+            default: Config.defaults.generateAlias,
+            normalize: true,
+        },
+        promisify: {
             type: 'boolean',
-            description: 'Generate types for GNOME Shell',
-            default: Config.defaults.gnomeShellTypes,
+            description: 'Generate promisified functions for async/finish calls',
+            default: Config.defaults.promisify,
+            normalize: true,
+        },
+        npmScope: {
+            type: 'string',
+            description: 'Scope of the generated NPM packages',
+            default: Config.defaults.npmScope,
+            normalize: true,
+        },
+        package: {
+            type: 'boolean',
+            description: 'Generates an NPM compatible packages for each GIR module',
+            default: Config.defaults.package,
             normalize: true,
         },
     }
@@ -193,23 +211,25 @@ export class Config {
     static generateOptions = {
         modules: this.options.modules,
         girDirectories: this.options.girDirectories,
+        root: this.options.root,
         outdir: this.options.outdir,
         environments: this.options.environments,
         ignore: this.options.ignore,
         buildType: this.options.buildType,
         moduleType: this.options.moduleType,
-        pretty: this.options.pretty,
         verbose: this.options.verbose,
         ignoreVersionConflicts: this.options.ignoreVersionConflicts,
         print: this.options.print,
         configName: this.options.configName,
-        useNamespace: this.options.useNamespace,
+        noNamespace: this.options.noNamespace,
         noComments: this.options.noComments,
         noDebugComments: this.options.noDebugComments,
-        noCheck: this.options.noCheck,
         noDOMLib: this.options.noDOMLib,
         fixConflicts: this.options.fixConflicts,
-        gnomeShellTypes: this.options.gnomeShellTypes,
+        generateAlias: this.options.generateAlias,
+        promisify: this.options.promisify,
+        npmScope: this.options.npmScope,
+        package: this.options.package,
     }
 
     static listOptions = {
@@ -220,16 +240,27 @@ export class Config {
         verbose: Config.options.verbose,
     }
 
+    static docOptions = {
+        modules: this.options.modules,
+        girDirectories: Config.options.girDirectories,
+        outdir: Config.options.outdir,
+        environments: Config.options.environments,
+        ignore: Config.options.ignore,
+        verbose: Config.options.verbose,
+        ignoreVersionConflicts: Config.options.ignoreVersionConflicts,
+        configName: Config.options.configName,
+    }
+
     /**
-     * Overwrites values in the user config
+     * Overwrites values in the user config file
      * @param configsToAdd
      */
-    public static async addToConfig(configsToAdd: Partial<UserConfig>): Promise<void> {
-        const userConfig = await this.loadConfigFile()
+    public static async addToConfig(configsToAdd: Partial<UserConfig>, configName?: string): Promise<void> {
+        const userConfig = await this.loadConfigFile(configName)
         const path = userConfig?.filepath || this.configFilePath
         const configToStore = {}
         merge(configToStore, userConfig?.config || {}, configsToAdd)
-        const fileExtension = Path.extname(path)
+        const fileExtension = extname(path)
         let writeConfigString = ''
         switch (fileExtension) {
             case '.js':
@@ -243,7 +274,7 @@ export class Config {
                 break
         }
         if (writeConfigString && path) {
-            return fs.writeFile(path, writeConfigString)
+            return writeFile(path, writeConfigString)
         }
     }
 
@@ -276,29 +307,32 @@ export class Config {
         if (configName) {
             configSearchOptions.searchPlaces = [configName]
         }
-        const userConfig: UserConfigLoadResult | null = await cosmiconfig(Config.appName, configSearchOptions).search()
-        if (userConfig?.filepath) {
-            Config.configFilePath = userConfig?.filepath
+        const configFile: UserConfigLoadResult | null = await cosmiconfig(Config.appName, configSearchOptions).search()
+        if (configFile?.filepath) {
+            Config.configFilePath = configFile.filepath
         }
-        return userConfig
+
+        return configFile
     }
 
     public static getGenerateConfig(config: UserConfig, environment: Environment = 'gjs'): GenerateConfig {
         const generateConfig: GenerateConfig = {
             environment: environment,
             girDirectories: config.girDirectories,
+            root: config.root,
             outdir: config.outdir,
-            pretty: config.pretty,
             verbose: config.verbose,
             buildType: config.buildType,
             moduleType: config.moduleType,
-            useNamespace: config.useNamespace,
+            noNamespace: config.noNamespace,
             noComments: config.noComments,
             noDebugComments: config.noDebugComments,
-            noCheck: config.noCheck,
             fixConflicts: config.fixConflicts,
             noDOMLib: config.noDOMLib,
-            gnomeShellTypes: config.gnomeShellTypes,
+            generateAlias: config.generateAlias,
+            promisify: config.promisify,
+            npmScope: config.npmScope,
+            package: config.package,
         }
         return generateConfig
     }
@@ -309,7 +343,7 @@ export class Config {
             ? false // NoLib makes typescript to ignore the lib property
             : Array.isArray(tsCompilerOptions.lib)
             ? tsCompilerOptions.lib.some((lib) => lib.toLowerCase().startsWith('dom'))
-            : true // Typescript icludes DOM lib by default
+            : true // Typescript includes DOM lib by default
 
         if (config.environments.includes('gjs') && tsConfigHasDOMLib && !config.noDOMLib) {
             const answer = (
@@ -331,17 +365,14 @@ export class Config {
     }
 
     public static async validate(config: UserConfig): Promise<UserConfig> {
-        if (config.buildType === 'types') {
-            if (config.useNamespace !== true) {
-                Logger.warn(WARN_USE_NAMESPACE_ON_TYPES)
-                config.useNamespace = true
+        if (config.generateAlias) {
+            if (!config.environments.includes('gjs')) {
+                Logger.warn(WARN_USE_GJS_FOR_ALIAS)
+                config.environments.push('gjs')
             }
-        }
-
-        if (config.moduleType === 'esm') {
-            if (config.useNamespace !== true) {
-                Logger.warn(WARN_USE_NAMESPACE_ON_ESM)
-                config.useNamespace = true
+            if (config.moduleType !== 'esm') {
+                Logger.warn(WARN_USE_ESM_FOR_ALIAS)
+                config.moduleType = 'esm'
             }
         }
 
@@ -356,7 +387,8 @@ export class Config {
      * @param options
      */
     public static async load(options: ConfigFlags): Promise<UserConfig> {
-        const configFile = (await this.loadConfigFile(options.configName))?.config || {}
+        const configFile = await this.loadConfigFile(options.configName)
+        const configFileData = configFile?.config || {}
 
         const config: UserConfig = {
             environments: options.environments,
@@ -364,117 +396,181 @@ export class Config {
             moduleType: options.moduleType,
             verbose: options.verbose,
             ignoreVersionConflicts: options.ignoreVersionConflicts,
-            pretty: options.pretty,
             print: options.print,
+            root: options.root,
             outdir: options.outdir,
             girDirectories: options.girDirectories,
             ignore: options.ignore,
             modules: options.modules,
-            useNamespace: options.useNamespace,
+            noNamespace: options.noNamespace,
             noComments: options.noComments,
             noDebugComments: options.noDebugComments,
-            noCheck: options.noCheck,
             fixConflicts: options.fixConflicts,
             noDOMLib: options.noDOMLib,
-            gnomeShellTypes: options.gnomeShellTypes,
+            generateAlias: options.generateAlias,
+            promisify: options.promisify,
+            npmScope: options.npmScope,
+            package: options.package,
         }
 
-        if (configFile) {
+        if (configFileData) {
             // environments
-            if (isEqual(config.environments, Config.defaults.environments) && configFile.environments) {
-                config.environments = configFile.environments
+            if (isEqual(config.environments, Config.defaults.environments) && configFileData.environments) {
+                config.environments = configFileData.environments
             }
             // buildType
-            if (config.buildType === Config.options.buildType.default && configFile.buildType) {
-                config.buildType = configFile.buildType
+            if (config.buildType === Config.options.buildType.default && configFileData.buildType) {
+                config.buildType = configFileData.buildType
             }
             // moduleType
-            if (config.moduleType === Config.options.moduleType.default && configFile.moduleType) {
-                config.moduleType = configFile.moduleType
+            if (config.moduleType === Config.options.moduleType.default && configFileData.moduleType) {
+                config.moduleType = configFileData.moduleType
             }
             // verbose
-            if (config.verbose === Config.options.verbose.default && typeof configFile.verbose === 'boolean') {
-                config.verbose = configFile.verbose
+            if (config.verbose === Config.options.verbose.default && typeof configFileData.verbose === 'boolean') {
+                config.verbose = configFileData.verbose
             }
             // ignoreVersionConflicts
             if (
                 config.ignoreVersionConflicts === Config.options.ignoreVersionConflicts.default &&
-                typeof configFile.ignoreVersionConflicts === 'boolean'
+                typeof configFileData.ignoreVersionConflicts === 'boolean'
             ) {
-                config.ignoreVersionConflicts = configFile.ignoreVersionConflicts
-            }
-            // pretty
-            if (config.pretty === Config.options.pretty.default && typeof configFile.pretty === 'boolean') {
-                config.pretty = configFile.pretty
+                config.ignoreVersionConflicts = configFileData.ignoreVersionConflicts
             }
             // print
-            if (config.print === Config.options.print.default && typeof configFile.print === 'boolean') {
-                config.print = configFile.print
+            if (config.print === Config.options.print.default && typeof configFileData.print === 'boolean') {
+                config.print = configFileData.print
+            }
+            // root
+            if (config.root === Config.options.root.default && (configFileData.root || configFile?.filepath)) {
+                // Use the config file path as the root path if no root path is set
+                config.root =
+                    configFileData.root ||
+                    (configFile?.filepath ? dirname(configFile.filepath) : (Config.options.root.default as string))
             }
             // outdir
-            if (config.outdir === Config.options.outdir.default && configFile.outdir) {
-                config.outdir = config.print ? null : configFile.outdir
+            if (config.outdir === Config.options.outdir.default && configFileData.outdir) {
+                config.outdir = config.print ? null : configFileData.outdir
             }
             // girDirectories
-            if (config.girDirectories === Config.options.girDirectories.default && configFile.girDirectories) {
-                config.girDirectories = configFile.girDirectories
+            if (config.girDirectories === Config.options.girDirectories.default && configFileData.girDirectories) {
+                config.girDirectories = configFileData.girDirectories
             }
             // ignore
             if (
                 (!config.ignore || config.ignore.length <= 0 || isEqual(config.ignore, Config.defaults.ignore)) &&
-                configFile.ignore
+                configFileData.ignore
             ) {
-                config.ignore = configFile.ignore
+                config.ignore = configFileData.ignore
             }
             // modules
             if (
                 (config.modules.length <= 0 || isEqual(config.modules, Config.defaults.modules)) &&
-                configFile.modules
+                configFileData.modules
             ) {
-                config.modules = configFile.modules
+                config.modules = configFileData.modules
             }
-            // useNamespace
+            // noNamespace
             if (
-                config.useNamespace === Config.options.useNamespace.default &&
-                typeof configFile.useNamespace === 'boolean'
+                config.noNamespace === Config.options.noNamespace.default &&
+                typeof configFileData.noNamespace === 'boolean'
             ) {
-                config.useNamespace = configFile.useNamespace
+                config.noNamespace = configFileData.noNamespace
             }
             // noComments
-            if (config.noComments === Config.options.noComments.default && typeof configFile.noComments === 'boolean') {
-                config.noComments = configFile.noComments
+            if (
+                config.noComments === Config.options.noComments.default &&
+                typeof configFileData.noComments === 'boolean'
+            ) {
+                config.noComments = configFileData.noComments
             }
             // noDebugComments
             if (
                 config.noDebugComments === Config.options.noDebugComments.default &&
-                typeof configFile.noDebugComments === 'boolean'
+                typeof configFileData.noDebugComments === 'boolean'
             ) {
-                config.noDebugComments = configFile.noDebugComments
-            }
-            // noCheck
-            if (config.noCheck === Config.options.noCheck.default && typeof configFile.noCheck === 'boolean') {
-                config.noCheck = configFile.noCheck
+                config.noDebugComments = configFileData.noDebugComments
             }
             // fixConflicts
             if (
                 config.fixConflicts === Config.options.fixConflicts.default &&
-                typeof configFile.fixConflicts === 'boolean'
+                typeof configFileData.fixConflicts === 'boolean'
             ) {
-                config.fixConflicts = configFile.fixConflicts
+                config.fixConflicts = configFileData.fixConflicts
             }
             // noDOMLib
-            if (config.noDOMLib === Config.options.noDOMLib.default && typeof configFile.noDOMLib === 'boolean') {
-                config.noDOMLib = configFile.noDOMLib
+            if (config.noDOMLib === Config.options.noDOMLib.default && typeof configFileData.noDOMLib === 'boolean') {
+                config.noDOMLib = configFileData.noDOMLib
+            }
+            // generateAlias
+            if (
+                config.generateAlias === Config.options.generateAlias.default &&
+                typeof configFileData.generateAlias === 'boolean'
+            ) {
+                config.generateAlias = configFileData.generateAlias
             }
-            // gnomeShellTypes
+            // promisify
             if (
-                config.gnomeShellTypes === Config.options.gnomeShellTypes.default &&
-                typeof configFile.gnomeShellTypes === 'boolean'
+                config.promisify === Config.options.promisify.default &&
+                typeof configFileData.promisify === 'boolean'
             ) {
-                config.gnomeShellTypes = configFile.gnomeShellTypes
+                config.promisify = configFileData.promisify
             }
+            // npmScope
+            if (config.npmScope === Config.options.npmScope.default && configFileData.npmScope) {
+                config.npmScope = configFileData.npmScope
+            }
+            // package
+            if (config.package === Config.options.package.default && typeof configFileData.package === 'boolean') {
+                config.package = configFileData.package
+            }
+        }
+
+        if ((config.moduleType as string) === 'commonjs') {
+            config.moduleType = 'cjs'
+        }
+
+        // If outdir is not absolute, make it absolute to the root path
+        if (config.outdir && !config.outdir?.startsWith('/')) {
+            config.outdir = resolve(config.root, config.outdir)
+        }
+
+        // Same for girDirectories
+        if (config.girDirectories) {
+            config.girDirectories = config.girDirectories.map((dir) => {
+                if (!dir.startsWith('/')) {
+                    return resolve(config.root, dir)
+                }
+                return dir
+            })
         }
 
         return await this.validate(config)
     }
 }
+
+function getDefaultGirDirectories(): string[] {
+    const girDirectories = [
+        '/usr/local/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',
+    ]
+    // 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)) {
+            girDirectories.push(dataDir)
+        }
+    }
+    return girDirectories
+}

package/src/generation-handler.ts

@@ -1,18 +1,18 @@
-import fs from 'fs'
-import { GirModule } from './gir-module.js'
-import { Generator } from './generator.js'
-import TypeDefinitionGenerator from './type-definition-generator.js'
-import HTMLDocGenerator from './html-doc-generator.js'
-import { Logger } from './logger.js'
-import { getEnvironmentDir } from './utils.js'
-import { InheritanceTable, GenerateConfig, GirModulesGrouped, GeneratorType } from './types/index.js'
+import { mkdir } from 'fs/promises'
 import {
+    GirModule,
+    Logger,
     START_MODULE,
     FILE_PARSING_DONE,
     TSDATA_PARSING_DONE,
     GENERATING_TYPES_DONE,
     ERROR_NO_MODULE_SPECIFIED,
-} from './messages.js'
+} 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 type { InheritanceTable, GenerateConfig, GirModulesGrouped } from '@ts-for-gir/lib'
 
 export class GenerationHandler {
     log: Logger
@@ -25,7 +25,7 @@ export class GenerationHandler {
                 this.generator = new TypeDefinitionGenerator(config)
                 break
             case GeneratorType.HTML_DOC:
-                this.generator = new HTMLDocGenerator(config)
+                this.generator = new HtmlDocGenerator(config)
                 break
             default:
                 throw new Error('Unknown Generator')
@@ -65,11 +65,10 @@ export class GenerationHandler {
 
         for (const girModule of girModules) {
             if (this.config.outdir) {
-                const outputDir = getEnvironmentDir(this.config.environment, this.config.outdir)
-                fs.mkdirSync(outputDir, { recursive: true })
+                await mkdir(this.config.outdir, { recursive: true })
             }
             this.log.log(` - ${girModule.packageName} ...`)
-            girModule.start()
+            girModule.start(girModules)
         }
 
         await this.generator.start(girModules, girModulesGrouped, inheritanceTable)

package/src/index.ts

@@ -1,17 +1,5 @@
-export * from './types/index.js'
-export * from './injection/index.js'
 export * from './commands/index.js'
 export * from './config.js'
-export * from './conflict-resolver.js'
-export * from './constants.js'
 export * from './generation-handler.js'
-export * from './gir-factory.js'
-export * from './gir-module.js'
-export * from './logger.js'
-export * from './messages.js'
 export * from './module-loader.js'
-export * from './symtable.js'
-export * from './template-processor.js'
-export * from './transformation.js'
 export * from './utils.js'
-export { default as templateProcessor } from './template-processor.js'