@ts-for-gir/cli 3.0.0-beta.2

package/lib/config.js

@@ -0,0 +1,385 @@
+import { cosmiconfig } from 'cosmiconfig';
+import Path from 'path';
+import OS from 'os';
+import { merge, isEqual } from './utils.js';
+import { promises as fs } from 'fs';
+import { Logger } from './logger.js';
+import { APP_NAME, APP_USAGE } from './constants.js';
+import { WARN_USE_NAMESPACE_ON_TYPES, WARN_USE_NAMESPACE_ON_ESM, ERROR_CONFIG_EXTENSION_UNSUPPORTED, } from './messages.js';
+export class Config {
+    static appName = APP_NAME;
+    static usage = APP_USAGE;
+    /**
+     * Default cli flag and argument values
+     */
+    static defaults = {
+        environments: ['gjs', 'node'],
+        pretty: false,
+        print: false,
+        configName: '.ts-for-girrc.js',
+        outdir: './@types',
+        girDirectories: OS.platform() === 'darwin' ? ['/usr/local/share/gir-1.0'] : ['/usr/share/gir-1.0'],
+        modules: ['*'],
+        ignore: [],
+        verbose: true,
+        ignoreVersionConflicts: false,
+        useNamespace: false,
+        buildType: 'lib',
+        moduleType: 'commonjs',
+        noComments: false,
+        noDebugComments: false,
+        noCheck: false,
+        fixConflicts: true,
+    };
+    static configFilePath = Path.join(process.cwd(), Config.defaults.configName);
+    /**
+     * CLI options used in commands/generate.ts and commands/list.ts
+     */
+    static options = {
+        modules: {
+            description: "GIR modules to load, e.g. 'Gio-2.0'. Accepts multiple modules",
+            array: true,
+            default: Config.defaults.modules,
+            normalize: true,
+        },
+        girDirectories: {
+            type: 'string',
+            alias: 'g',
+            description: 'GIR directories',
+            array: true,
+            default: Config.defaults.girDirectories,
+            normalize: true,
+        },
+        outdir: {
+            type: 'string',
+            alias: 'o',
+            description: 'Directory to output to',
+            default: Config.defaults.outdir,
+            normalize: true,
+        },
+        environments: {
+            type: 'string',
+            alias: 'e',
+            description: 'Javascript environment',
+            array: true,
+            choices: ['gjs', 'node'],
+            default: Config.defaults.environments,
+            normalize: true,
+        },
+        ignore: {
+            type: 'string',
+            alias: 'i',
+            description: 'Modules that should be ignored',
+            array: true,
+            default: Config.defaults.ignore,
+            normalize: true,
+        },
+        buildType: {
+            type: 'string',
+            alias: 'b',
+            description: 'Definitions generation type',
+            array: false,
+            choices: ['lib', 'types'],
+            default: Config.defaults.buildType,
+            normalize: true,
+        },
+        moduleType: {
+            type: 'string',
+            alias: 't',
+            description: 'Specify what module code is generated.',
+            choices: ['esm', 'commonjs'],
+            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',
+            description: 'Switch on/off the verbose mode',
+            default: Config.defaults.verbose,
+            normalize: true,
+        },
+        ignoreVersionConflicts: {
+            type: 'boolean',
+            description: 'Do not ask for package versions if multiple versions are found',
+            default: Config.defaults.ignoreVersionConflicts,
+            normalize: true,
+        },
+        print: {
+            type: 'boolean',
+            alias: 'p',
+            description: 'Print the output to console and create no files',
+            default: Config.defaults.print,
+            normalize: true,
+        },
+        configName: {
+            type: 'string',
+            description: 'Name of the config if you want to use a different name',
+            default: Config.defaults.configName,
+            normalize: true,
+        },
+        useNamespace: {
+            type: 'boolean',
+            alias: 'd',
+            description: 'Export all symbols for each module as a namespace',
+            default: Config.defaults.useNamespace,
+            normalize: true,
+        },
+        noComments: {
+            type: 'boolean',
+            alias: 'n',
+            description: 'Do not generate documentation comments',
+            default: Config.defaults.noComments,
+            normalize: true,
+        },
+        noDebugComments: {
+            type: 'boolean',
+            alias: 'nd',
+            description: 'Do not generate debugging inline comments',
+            default: Config.defaults.noDebugComments,
+            normalize: true,
+        },
+        noCheck: {
+            type: 'boolean',
+            alias: 'nc',
+            description: 'Disable typescript semantic checks using @ts-nocheck',
+            default: Config.defaults.noCheck,
+            normalize: true,
+        },
+        fixConflicts: {
+            type: 'boolean',
+            alias: 'fc',
+            description: 'Fix Inheritance and implementation type conflicts',
+            default: Config.defaults.fixConflicts,
+            normalize: true,
+        },
+    };
+    /**
+     * CLI flags used in commands/generate.ts
+     */
+    static generateOptions = {
+        modules: this.options.modules,
+        girDirectories: this.options.girDirectories,
+        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,
+        noComments: this.options.noComments,
+        noDebugComments: this.options.noDebugComments,
+        noCheck: this.options.noCheck,
+        fixConflicts: this.options.fixConflicts,
+    };
+    static listOptions = {
+        modules: this.options.modules,
+        girDirectories: Config.options.girDirectories,
+        ignore: Config.options.ignore,
+        configName: Config.options.configName,
+        verbose: Config.options.verbose,
+    };
+    /**
+     * Overwrites values in the user config
+     * @param configsToAdd
+     */
+    static async addToConfig(configsToAdd) {
+        const userConfig = await this.loadConfigFile();
+        const path = userConfig?.filepath || this.configFilePath;
+        const configToStore = {};
+        merge(configToStore, userConfig?.config || {}, configsToAdd);
+        const fileExtension = Path.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 fs.writeFile(path, writeConfigString);
+        }
+    }
+    /**
+     * 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
+     */
+    static async loadConfigFile(configName) {
+        const configSearchOptions = {
+            loaders: {
+                // ESM loader
+                '.js': async (filepath) => {
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    const file = await import(filepath);
+                    // Files with `exports.default = { ... }`
+                    if (file?.default?.default) {
+                        return file.default.default;
+                    }
+                    // Files with `export default { ... }`
+                    if (file?.default) {
+                        return file.default;
+                    }
+                    // Files with `export { ... }`
+                    return file;
+                },
+            },
+        };
+        if (configName) {
+            configSearchOptions.searchPlaces = [configName];
+        }
+        const userConfig = await cosmiconfig(Config.appName, configSearchOptions).search();
+        if (userConfig?.filepath) {
+            Config.configFilePath = userConfig?.filepath;
+        }
+        return userConfig;
+    }
+    static getGenerateConfig(config, environment = 'gjs') {
+        const generateConfig = {
+            environment: environment,
+            girDirectories: config.girDirectories,
+            outdir: config.outdir,
+            pretty: config.pretty,
+            verbose: config.verbose,
+            buildType: config.buildType,
+            moduleType: config.moduleType,
+            useNamespace: config.useNamespace,
+            noComments: config.noComments,
+            noDebugComments: config.noDebugComments,
+            noCheck: config.noCheck,
+            fixConflicts: config.fixConflicts,
+        };
+        return generateConfig;
+    }
+    static validate(options) {
+        if (options.buildType === 'types') {
+            if (options.useNamespace !== true) {
+                Logger.warn(WARN_USE_NAMESPACE_ON_TYPES);
+                options.useNamespace = true;
+            }
+        }
+        if (options.moduleType === 'esm') {
+            if (options.useNamespace !== true) {
+                Logger.warn(WARN_USE_NAMESPACE_ON_ESM);
+                options.useNamespace = true;
+            }
+        }
+        return options;
+    }
+    /**
+     * 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 options
+     * @param modules
+     */
+    static async load(options) {
+        const configFile = await this.loadConfigFile(options.configName);
+        const config = {
+            environments: options.environments,
+            buildType: options.buildType,
+            moduleType: options.moduleType,
+            verbose: options.verbose,
+            ignoreVersionConflicts: options.ignoreVersionConflicts,
+            pretty: options.pretty,
+            print: options.print,
+            outdir: options.outdir,
+            girDirectories: options.girDirectories,
+            ignore: options.ignore,
+            modules: options.modules,
+            useNamespace: options.useNamespace,
+            noComments: options.noComments,
+            noDebugComments: options.noDebugComments,
+            noCheck: options.noCheck,
+            fixConflicts: options.fixConflicts,
+        };
+        if (configFile) {
+            // environments
+            if (isEqual(config.environments, Config.defaults.environments) && configFile.config.environments) {
+                config.environments = configFile.config.environments;
+            }
+            // buildType
+            if (config.buildType === Config.options.buildType.default && configFile.config.buildType) {
+                config.buildType = configFile.config.buildType;
+            }
+            // moduleType
+            if (config.moduleType === Config.options.moduleType.default && configFile.config.moduleType) {
+                config.moduleType = configFile.config.moduleType;
+            }
+            // verbose
+            if (config.verbose === Config.options.verbose.default && typeof configFile.config.verbose === 'boolean') {
+                config.verbose = configFile.config.verbose;
+            }
+            // ignoreVersionConflicts
+            if (config.ignoreVersionConflicts === Config.options.ignoreVersionConflicts.default &&
+                typeof configFile.config.ignoreVersionConflicts === 'boolean') {
+                config.ignoreVersionConflicts = configFile.config.ignoreVersionConflicts;
+            }
+            // pretty
+            if (config.pretty === Config.options.pretty.default && typeof configFile.config.pretty === 'boolean') {
+                config.pretty = configFile.config.pretty;
+            }
+            // print
+            if (config.print === Config.options.print.default && typeof configFile.config.print === 'boolean') {
+                config.print = configFile.config.print;
+            }
+            // outdir
+            if (config.outdir === Config.options.outdir.default && configFile.config.outdir) {
+                config.outdir = config.print ? null : configFile.config.outdir;
+            }
+            // girDirectories
+            if (config.girDirectories === Config.options.girDirectories.default && configFile.config.girDirectories) {
+                config.girDirectories = configFile.config.girDirectories;
+            }
+            // ignore
+            if ((!config.ignore || config.ignore.length <= 0 || isEqual(config.ignore, Config.defaults.ignore)) &&
+                configFile.config.ignore) {
+                config.ignore = configFile.config.ignore;
+            }
+            // modules
+            if ((config.modules.length <= 0 || isEqual(config.modules, Config.defaults.modules)) &&
+                configFile.config.modules) {
+                config.modules = configFile.config.modules;
+            }
+            // useNamespace
+            if (config.useNamespace === Config.options.useNamespace.default &&
+                typeof configFile.config.useNamespace === 'boolean') {
+                config.useNamespace = configFile.config.useNamespace;
+            }
+            // noComments
+            if (config.noComments === Config.options.noComments.default &&
+                typeof configFile.config.noComments === 'boolean') {
+                config.noComments = configFile.config.noComments;
+            }
+            // noDebugComments
+            if (config.noDebugComments === Config.options.noDebugComments.default &&
+                typeof configFile.config.noDebugComments === 'boolean') {
+                config.noDebugComments = configFile.config.noDebugComments;
+            }
+            // noCheck
+            if (config.noCheck === Config.options.noCheck.default && typeof configFile.config.noCheck === 'boolean') {
+                config.noCheck = configFile.config.noCheck;
+            }
+            // fixConflicts
+            if (config.fixConflicts === Config.options.fixConflicts.default &&
+                typeof configFile.config.fixConflicts === 'boolean') {
+                config.fixConflicts = configFile.config.fixConflicts;
+            }
+        }
+        return this.validate(config);
+    }
+}
+//# sourceMappingURL=config.js.map

package/lib/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAkC,MAAM,aAAa,CAAA;AACzE,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAE3C,OAAO,EAAE,QAAQ,IAAI,EAAE,EAAE,MAAM,IAAI,CAAA;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACpD,OAAO,EACH,2BAA2B,EAC3B,yBAAyB,EACzB,kCAAkC,GACrC,MAAM,eAAe,CAAA;AAEtB,MAAM,OAAO,MAAM;IACf,MAAM,CAAC,OAAO,GAAG,QAAQ,CAAA;IAEzB,MAAM,CAAC,KAAK,GAAG,SAAS,CAAA;IAExB;;OAEG;IACH,MAAM,CAAC,QAAQ,GAAG;QACd,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;QAC7B,MAAM,EAAE,KAAK;QACb,KAAK,EAAE,KAAK;QACZ,UAAU,EAAE,kBAAkB;QAC9B,MAAM,EAAE,UAAU;QAClB,cAAc,EAAE,EAAE,CAAC,QAAQ,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC;QAClG,OAAO,EAAE,CAAC,GAAG,CAAC;QACd,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,YAAY,EAAE,KAAK;QACnB,SAAS,EAAE,KAAK;QAChB,UAAU,EAAE,UAAU;QACtB,UAAU,EAAE,KAAK;QACjB,eAAe,EAAE,KAAK;QACtB,OAAO,EAAE,KAAK;QACd,YAAY,EAAE,IAAI;KACrB,CAAA;IAED,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;IAE5E;;OAEG;IACH,MAAM,CAAC,OAAO,GAAG;QACb,OAAO,EAAE;YACL,WAAW,EAAE,+DAA+D;YAC5E,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO;YAChC,SAAS,EAAE,IAAI;SACP;QACZ,cAAc,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,WAAW,EAAE,iBAAiB;YAC9B,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,cAAc;YACvC,SAAS,EAAE,IAAI;SACP;QACZ,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,WAAW,EAAE,wBAAwB;YACrC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM;YAC/B,SAAS,EAAE,IAAI;SACP;QACZ,YAAY,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,WAAW,EAAE,wBAAwB;YACrC,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;YACxB,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,YAAY;YACrC,SAAS,EAAE,IAAI;SACP;QACZ,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,WAAW,EAAE,gCAAgC;YAC7C,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM;YAC/B,SAAS,EAAE,IAAI;SACP;QACZ,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,WAAW,EAAE,6BAA6B;YAC1C,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;YACzB,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;YAClC,SAAS,EAAE,IAAI;SACP;QACZ,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,WAAW,EAAE,wCAAwC;YACrD,OAAO,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC;YAC5B,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU;YACnC,SAAS,EAAE,IAAI;SACP;QACZ,MAAM,EAAE;YACJ,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,sCAAsC;YACnD,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM;YAC/B,SAAS,EAAE,IAAI;SACP;QACZ,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,WAAW,EAAE,gCAAgC;YAC7C,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO;YAChC,SAAS,EAAE,IAAI;SACP;QACZ,sBAAsB,EAAE;YACpB,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,gEAAgE;YAC7E,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,sBAAsB;YAC/C,SAAS,EAAE,IAAI;SACP;QACZ,KAAK,EAAE;YACH,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,WAAW,EAAE,iDAAiD;YAC9D,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK;YAC9B,SAAS,EAAE,IAAI;SACP;QACZ,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wDAAwD;YACrE,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU;YACnC,SAAS,EAAE,IAAI;SACP;QACZ,YAAY,EAAE;YACV,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,WAAW,EAAE,mDAAmD;YAChE,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,YAAY;YACrC,SAAS,EAAE,IAAI;SACP;QACZ,UAAU,EAAE;YACR,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,WAAW,EAAE,wCAAwC;YACrD,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU;YACnC,SAAS,EAAE,IAAI;SACP;QACZ,eAAe,EAAE;YACb,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,IAAI;YACX,WAAW,EAAE,2CAA2C;YACxD,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,eAAe;YACxC,SAAS,EAAE,IAAI;SACP;QACZ,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,IAAI;YACX,WAAW,EAAE,sDAAsD;YACnE,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO;YAChC,SAAS,EAAE,IAAI;SACP;QACZ,YAAY,EAAE;YACV,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,IAAI;YACX,WAAW,EAAE,mDAAmD;YAChE,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,YAAY;YACrC,SAAS,EAAE,IAAI;SACP;KACf,CAAA;IAED;;OAEG;IACH,MAAM,CAAC,eAAe,GAAG;QACrB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;QAC7B,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc;QAC3C,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;QAC3B,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY;QACvC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;QAC3B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;QACjC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;QACnC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;QAC3B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;QAC7B,sBAAsB,EAAE,IAAI,CAAC,OAAO,CAAC,sBAAsB;QAC3D,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK;QACzB,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;QACnC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY;QACvC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;QACnC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe;QAC7C,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;QAC7B,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY;KAC1C,CAAA;IAED,MAAM,CAAC,WAAW,GAAG;QACjB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;QAC7B,cAAc,EAAE,MAAM,CAAC,OAAO,CAAC,cAAc;QAC7C,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM;QAC7B,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU;QACrC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO;KAClC,CAAA;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,YAAiC;QAC7D,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAA;QAC9C,MAAM,IAAI,GAAG,UAAU,EAAE,QAAQ,IAAI,IAAI,CAAC,cAAc,CAAA;QACxD,MAAM,aAAa,GAAG,EAAE,CAAA;QACxB,KAAK,CAAC,aAAa,EAAE,UAAU,EAAE,MAAM,IAAI,EAAE,EAAE,YAAY,CAAC,CAAA;QAC5D,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACxC,IAAI,iBAAiB,GAAG,EAAE,CAAA;QAC1B,QAAQ,aAAa,EAAE;YACnB,KAAK,KAAK;gBACN,iBAAiB,GAAG,kBAAkB,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAA;gBAC9E,MAAK;YACT,KAAK,OAAO;gBACR,iBAAiB,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAA;gBAC/D,MAAK;YACT;gBACI,MAAM,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAA;gBAChD,MAAK;SACZ;QACD,IAAI,iBAAiB,IAAI,IAAI,EAAE;YAC3B,OAAO,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAA;SAC/C;IACL,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,UAAmB;QACnD,MAAM,mBAAmB,GAAwB;YAC7C,OAAO,EAAE;gBACL,aAAa;gBACb,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;oBACtB,mEAAmE;oBACnE,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAA;oBAEnC,yCAAyC;oBACzC,IAAI,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE;wBACxB,OAAO,IAAI,CAAC,OAAO,CAAC,OAA8B,CAAA;qBACrD;oBACD,sCAAsC;oBACtC,IAAI,IAAI,EAAE,OAAO,EAAE;wBACf,OAAO,IAAI,CAAC,OAA8B,CAAA;qBAC7C;oBACD,8BAA8B;oBAC9B,OAAO,IAA2B,CAAA;gBACtC,CAAC;aACJ;SACJ,CAAA;QACD,IAAI,UAAU,EAAE;YACZ,mBAAmB,CAAC,YAAY,GAAG,CAAC,UAAU,CAAC,CAAA;SAClD;QACD,MAAM,UAAU,GAAgC,MAAM,WAAW,CAAC,MAAM,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC,MAAM,EAAE,CAAA;QAC/G,IAAI,UAAU,EAAE,QAAQ,EAAE;YACtB,MAAM,CAAC,cAAc,GAAG,UAAU,EAAE,QAAQ,CAAA;SAC/C;QACD,OAAO,UAAU,CAAA;IACrB,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,MAAkB,EAAE,cAA2B,KAAK;QAChF,MAAM,cAAc,GAAmB;YACnC,WAAW,EAAE,WAAW;YACxB,cAAc,EAAE,MAAM,CAAC,cAAc;YACrC,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,eAAe,EAAE,MAAM,CAAC,eAAe;YACvC,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,YAAY,EAAE,MAAM,CAAC,YAAY;SACpC,CAAA;QACD,OAAO,cAAc,CAAA;IACzB,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,OAAmB;QACtC,IAAI,OAAO,CAAC,SAAS,KAAK,OAAO,EAAE;YAC/B,IAAI,OAAO,CAAC,YAAY,KAAK,IAAI,EAAE;gBAC/B,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAA;gBACxC,OAAO,CAAC,YAAY,GAAG,IAAI,CAAA;aAC9B;SACJ;QAED,IAAI,OAAO,CAAC,UAAU,KAAK,KAAK,EAAE;YAC9B,IAAI,OAAO,CAAC,YAAY,KAAK,IAAI,EAAE;gBAC/B,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAA;gBACtC,OAAO,CAAC,YAAY,GAAG,IAAI,CAAA;aAC9B;SACJ;QAED,OAAO,OAAO,CAAA;IAClB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAoB;QACzC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QAEhE,MAAM,MAAM,GAAe;YACvB,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,sBAAsB,EAAE,OAAO,CAAC,sBAAsB;YACtD,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,YAAY,EAAE,OAAO,CAAC,YAAY;SACrC,CAAA;QAED,IAAI,UAAU,EAAE;YACZ,eAAe;YACf,IAAI,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE;gBAC9F,MAAM,CAAC,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAA;aACvD;YACD,YAAY;YACZ,IAAI,MAAM,CAAC,SAAS,KAAK,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,SAAS,EAAE;gBACtF,MAAM,CAAC,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAA;aACjD;YACD,aAAa;YACb,IAAI,MAAM,CAAC,UAAU,KAAK,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE;gBACzF,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAA;aACnD;YACD,UAAU;YACV,IAAI,MAAM,CAAC,OAAO,KAAK,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,UAAU,CAAC,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE;gBACrG,MAAM,CAAC,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAA;aAC7C;YACD,yBAAyB;YACzB,IACI,MAAM,CAAC,sBAAsB,KAAK,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,OAAO;gBAC/E,OAAO,UAAU,CAAC,MAAM,CAAC,sBAAsB,KAAK,SAAS,EAC/D;gBACE,MAAM,CAAC,sBAAsB,GAAG,UAAU,CAAC,MAAM,CAAC,sBAAsB,CAAA;aAC3E;YACD,SAAS;YACT,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;gBAClG,MAAM,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,CAAA;aAC3C;YACD,QAAQ;YACR,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,IAAI,OAAO,UAAU,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE;gBAC/F,MAAM,CAAC,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAA;aACzC;YACD,SAAS;YACT,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE;gBAC7E,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAA;aACjE;YACD,iBAAiB;YACjB,IAAI,MAAM,CAAC,cAAc,KAAK,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,cAAc,EAAE;gBACrG,MAAM,CAAC,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAA;aAC3D;YACD,SAAS;YACT,IACI,CAAC,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;gBAC/F,UAAU,CAAC,MAAM,CAAC,MAAM,EAC1B;gBACE,MAAM,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,CAAA;aAC3C;YACD,UAAU;YACV,IACI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBAChF,UAAU,CAAC,MAAM,CAAC,OAAO,EAC3B;gBACE,MAAM,CAAC,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAA;aAC7C;YACD,eAAe;YACf,IACI,MAAM,CAAC,YAAY,KAAK,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO;gBAC3D,OAAO,UAAU,CAAC,MAAM,CAAC,YAAY,KAAK,SAAS,EACrD;gBACE,MAAM,CAAC,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAA;aACvD;YACD,aAAa;YACb,IACI,MAAM,CAAC,UAAU,KAAK,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO;gBACvD,OAAO,UAAU,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS,EACnD;gBACE,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAA;aACnD;YACD,kBAAkB;YAClB,IACI,MAAM,CAAC,eAAe,KAAK,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO;gBACjE,OAAO,UAAU,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EACxD;gBACE,MAAM,CAAC,eAAe,GAAG,UAAU,CAAC,MAAM,CAAC,eAAe,CAAA;aAC7D;YACD,UAAU;YACV,IAAI,MAAM,CAAC,OAAO,KAAK,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,UAAU,CAAC,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE;gBACrG,MAAM,CAAC,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAA;aAC7C;YACD,eAAe;YACf,IACI,MAAM,CAAC,YAAY,KAAK,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO;gBAC3D,OAAO,UAAU,CAAC,MAAM,CAAC,YAAY,KAAK,SAAS,EACrD;gBACE,MAAM,CAAC,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAA;aACvD;SACJ;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IAChC,CAAC"}

package/lib/conflict-resolver.d.ts

@@ -0,0 +1,154 @@
+import type { Environment, GirClassElement, GirRecordElement, GirUnionElement, GirInterfaceElement, GirCallableParamElement, TsSignal, TsFunction, TsProperty, TsVar, TsTypeSeparator, TsType, TsClass, TypeGirFunction, TypeGirProperty, ConflictChildElement, ConflictGroupedElements, ConflictGroupedElement } from './types/index.js';
+/**
+ * Resolve conflicts between types caused by overloads / inheritances and implementations
+ * With multiple implementations or a inherit it can happen that the interfaces / parent have the same method and/or property names with incompatible types,
+ * we are trying to resolve this conflicts by merging, overloading or removing this conflicts.
+ */
+export declare class ConflictResolver {
+    private readonly environment;
+    private log;
+    private girFactory;
+    constructor(environment: Environment);
+    private girElArrToChildArr;
+    private tsElArrToChildArr;
+    /**
+     * Get class elements and parent elements (implementations and inherits)
+     * @param tsClass
+     * @param depth
+     * @returns
+     */
+    private getClassElements;
+    private tsElementIsMethod;
+    private tsElementIsStaticFunction;
+    private tsElementIsProperty;
+    private tsElementIsStaticProperty;
+    private tsElementIsSignal;
+    private tsElementIsConstructor;
+    private tsElementIsMethodOrFunction;
+    private tsElementIsPropertyOrVariable;
+    private tsElementIsStatic;
+    private typeIsString;
+    private mergeTypes;
+    private setTypesProperty;
+    /**
+     * Merges two parameter name and type of two parameters
+     * @param a
+     * @param b
+     * @returns
+     */
+    private mergeParam;
+    /**
+     * Merges parameter names and types of multiple functions
+     * @param params
+     * @returns
+     */
+    private mergeParams;
+    private paramCanBeOptional;
+    /**
+     * In Typescript no optional parameters are allowed if the following ones are not optional
+     * @param girParams
+     * @returns
+     */
+    private fixOptionalParameters;
+    /**
+     * Merge function types and parameters together
+     * @param baseFunc The function to change or null if you want to create a new property
+     * @param funcs The functions you want to merge
+     * @returns
+     */
+    mergeFunctions(baseFunc: TsFunction | null, ...funcs: TsFunction[]): TsFunction;
+    /**
+     * Merge property types together
+     * @param baseProp The property to change or null if you want to create a new property
+     * @param props The properties you want to merge
+     * @returns
+     */
+    mergeProperties(typeSeparator: TsTypeSeparator, baseProp: TsProperty | null, ...props: TsProperty[]): TsProperty;
+    /**
+     * Check if there is a type conflict between the ts elements a and b
+     * @param a
+     * @param b
+     * @returns
+     */
+    hasConflict(a: ConflictChildElement, b: ConflictChildElement): boolean;
+    newAnyTsProperty(name: string, girTypeName: TypeGirProperty): TsProperty;
+    /**
+     * Returns a new any function: `name(...args: any[]): any`
+     * @param name The name of the function
+     */
+    newAnyTsFunction(name: string, girTypeName: TypeGirFunction, isStatic: boolean, parent: TsClass | null): TsFunction;
+    getCompatibleTsProperty(elements: TsProperty[], baseProp: TsProperty): TsProperty | undefined;
+    getCompatibleTsFunction(elements: TsFunction[], baseFunc: TsFunction): TsFunction | undefined;
+    /**
+     * Use this instead of `getCompatibleTsProperty` and `getCompatibleTsProperty` if you can, because it's much faster
+     * @param elements
+     * @param name
+     * @returns
+     */
+    getTsElementByName(elements: (TsProperty | TsFunction)[], name: string): TsFunction | TsProperty | undefined;
+    protected canAddConflictProperty(conflictProperties: TsProperty[], prop: TsProperty): boolean | "" | null;
+    groupSignalConflicts(signalsMethods: ConflictChildElement<TsFunction>[], baseClass: TsClass): ConflictGroupedElements<TsFunction | TsProperty | TsVar>;
+    fixSignalConflicts(groupedElements: ConflictGroupedElements): void;
+    /**
+     * Check conflicts between the implementations / inheritances
+     * To fix type errors like:
+     * ```
+     *   Interface 'PopoverMenu' can\'t simultaneously extend types 'Popover' and 'Native'.
+     *   Named property 'parent' of types 'Popover' and 'Native' are not identical.
+     */
+    fixIndirectConflicts(name: string, elements: ConflictChildElement[], baseClass: TsClass): void;
+    /**
+     * Check conflicts within the class itself (ignores implementations / inheritances)
+     */
+    fixInternalConflicts(name: string, elements: ConflictChildElement[], baseClass: TsClass): void;
+    /**
+     * Check conflicts of the class with implementations and inheritances
+     */
+    fixDirectConflicts(name: string, elements: ConflictGroupedElement): void;
+    /**
+     * Fix the conflicts of a class
+     * @param groupedElements
+     */
+    fixConflicts(groupedElements: ConflictGroupedElements): void;
+    /**
+     * Group conflicts by name and sort them by depth for simpler handling of conflicts
+     */
+    groupConflicts(elements: ConflictChildElement[], tsClass: TsClass): ConflictGroupedElements<TsFunction | TsProperty | TsVar>;
+    /**
+     * With multiple implementations or a inherit it can happen that the interfaces / parent have the same method and/or property name with incompatible types.
+     * We merge these types here to solve this problem.
+     * @param girClass
+     */
+    repairClass(girClass: GirClassElement | GirUnionElement | GirInterfaceElement | GirRecordElement): GirClassElement | GirUnionElement | GirInterfaceElement | GirRecordElement;
+    /**
+     * Returns true if `p1s` and `p2s` conflicting with each other.
+     * The parameters must have the same length and the same type but can have different names
+     * @param params
+     * @returns
+     */
+    paramsHasConflict(...params: GirCallableParamElement[][]): boolean;
+    typesHasConflict(a: TsType[], b: TsType[]): boolean;
+    /**
+     * Returns `true` if the function / method types of `a` and `b` are not compatible with each other.
+     * The parameters must have the same length and the same type but can have different names
+     * @param a
+     * @param b
+     * @returns
+     */
+    functionHasConflict(a: TsFunction, b: TsFunction): boolean;
+    /**
+     * Returns `true` if the property types of `a` and `b` are not compatible with each other.
+     * @param a
+     * @param b
+     * @returns
+     */
+    propertyHasConflict(a: TsVar & TsProperty, b: TsVar & TsProperty): boolean;
+    signalHasConflict(a: TsSignal, b: TsSignal): boolean;
+    /**
+     * Returns true if the elements (properties or methods) of `a` and `b` are not compatible with each other (has no conflict).
+     * @param a
+     * @param b
+     * @returns
+     */
+    elementHasConflict(a: TsFunction | TsVar | TsProperty | TsSignal, b: TsFunction | TsVar | TsProperty | TsSignal): boolean;
+}