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

package/README.md

@@ -0,0 +1,156 @@
+# CLI
+
+After you have linked this project you can use the `ts-for-gir` command in you project:
+
+```bash
+$ ts-for-gir --help
+
+Typescript .d.ts generator from GIR for gjs or node-gtk
+
+Commands:
+  ts-for-gir generate [modules..]  Generates .d.ts files from GIR for gjs or nod
+                                   e-gtk
+  ts-for-gir list [modules..]      Lists all available GIR modules
+
+Options:
+  --version  Show version number                                       [boolean]
+  --help     Show help                                                 [boolean]
+```
+
+## Generate .d.ts files
+
+```bash
+$ ts-for-gir generate --help
+
+ts-for-gir generate [modules..]
+
+Generates .d.ts files from GIR for gjs or node-gtk
+
+Options:
+      --version          Show version number                           [boolean]
+      --help             Show help                                     [boolean]
+      --modules          GIR modules to load, e.g. 'Gio-2.0'. Accepts multiple m
+                         odules                         [array] [default: ["*"]]
+  -g, --girDirectories   GIR directories
+                                       [array] [default: ["/usr/share/gir-1.0"]]
+  -o, --outdir           Directory to output to   [string] [default: "./@types"]
+  -e, --environments     Javascript environment
+                      [array] [choices: "gjs", "node"] [default: ["gjs","node"]]
+  -i, --ignore           Modules that should be ignored    [array] [default: []]
+  -b, --buildType        Definitions generation type
+                             [string] [choices: "lib", "types"] [default: "lib"]
+  -t, --moduleType       Specify what module code is generated.
+                     [string] [choices: "esm", "commonjs"] [default: "commonjs"]
+      --pretty           Prettifies the generated .d.ts files
+                                                       [string] [default: false]
+  -v, --verbose          Switch on/off the verbose mode [string] [default: true]
+      --ignoreVersionConflicts  Do not ask for package versions if multiple versions ar
+                         e found                       [string] [default: false]
+  -p, --print            Print the output to console and create no files
+                                                       [string] [default: false]
+      --configName       Name of the config if you want to use a different name
+                                                                        [string]
+  -d, --useNamespace     Export all symbols for each module as a namespace
+                                                       [string] [default: false]
+  -n, --noComments       Do not generate documentation comments
+                                                       [string] [default: false]
+
+Examples:
+  ts-for-gir generate                       Run 'ts-for-gir generate' in your gj
+                                            s or node-gtk project to generate ty
+                                            pings for your project, pass the gir
+                                             modules you need for your project
+  ts-for-gir generate Gtk*                  You can also use wild cards
+  ts-for-gir generate '*'                   If you want to parse all of your loc
+                                            ally installed gir modules run
+  ts-for-gir generate '*' -e gjs            Generate .d.ts. files only for gjs
+  ts-for-gir generate '*' -e node           Generate .d.ts. files only for node
+  ts-for-gir generate --configName='.ts-fo  Use a special config file
+  r-gir.gtk4.rc.js
+  ts-for-gir generate --ignore=Gtk-3.0 xra  Generate .d.ts. files but not for Gt
+  ndr-1.3                                   k-3.0 and xrandr-1.3
+```
+
+## List available GIR modules
+
+```bash
+$ ts-for-gir list --help
+ 
+ts-for-gir list [modules..]
+
+Lists all available GIR modules
+
+Options:
+      --version         Show version number                            [boolean]
+      --help            Show help                                      [boolean]
+      --modules         GIR modules to load, e.g. 'Gio-2.0'. Accepts multiple mo
+                        dules                           [array] [default: ["*"]]
+  -g, --girDirectories  GIR directories[array] [default: ["/usr/share/gir-1.0"]]
+  -i, --ignore          Modules that should be ignored     [array] [default: []]
+  -v, --verbose         Switch on/off the verbose mode  [string] [default: true]
+      --configName      Name of the config if you want to use a different name
+                                                                        [string]
+
+Examples:
+  ts-for-gir list -g ./vala-girs/gir-1.0    Lists all available GIR modules in .
+                                            /vala-girs/gir-1.0
+  ts-for-gir list --ignore=Gtk-3.0 xrandr-  Lists all available GIR modules in /
+  1.3                                       usr/share/gir-1.0 but not Gtk-3.0 an
+                                            d xrandr-1.3
+```
+
+## Generate HTML documentation
+
+```bash
+$ ts-for-gir doc --help
+
+ts-for-gir doc [modules..]
+
+The HTML documentation generator is not yet implemented, but feel free to implem
+ent it 🤗
+```
+## Config
+
+In addition to the option of passing options as a CLI flag, you can also write them in a config file.
+To do that, create a new config file called `.ts-for-girrc.js` in your project root directory, like this:
+
+```js
+// or on CommonJs: exports.default = {
+export default {
+  pretty: false,
+  print: false,
+  verbose: true,
+  environments: ['gjs', 'node'],
+  outdir: '@types',
+  girDirectories: '/usr/share/gir-1.0',
+  modules: ['*'],
+  ignore: [],
+  useNamespace: true,
+  buildType: 'lib',
+  moduleType: 'esm'
+}
+```
+
+The javascript config files must also be in ESM format if you are inside a ESM Package, this is the case if `"type": "module"` is defined in your package.json. Alternatively, the file can be saved in json format, then it works in both cases.
+
+## About the `--moduleType esm` option
+
+Gjs now supports ES modules, which can be activated with its `gjs -m` flag. Using this in conjunction with `"module": "es6"` in tsconfig.json is generally more
+convenient than using the `imports` global object, because you no longer have to provide an implementation of `require`. However, it creates two new
+problems for Typescript/ts-for-gjs. The first is that `gi` imports use a URI format, which Typescript doesn't support yet. To work around this problem
+you can import from a relative filename as usual, and the Javascript stubs generated by ts-for-gjs now forward the imports from the `gi` URI.
+
+Or you can use a bundler like Webpack to handle the imports, the [example/gjs/browser](example/gjs/browser) uses esm and does exactly this.
+
+The second problem is that in ES module mode, `gi` imports behave as if they were exported by `export default`, which is not backwards compatible with
+ts-for-gjs. Where you would previously write:
+
+`import * as Gtk from "<path to gi bindings>/Gtk-4.0js"`
+
+you now have to write:
+
+`import Gtk from "<path to gi bindings>/Gtk-4.0js"`
+
+Destructuring individual items in the import statement is not supported for this type of import.
+
+See `examples/Gjs/browser` for an example for Gjs with ESM. 

package/lib/commands/doc.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Everything you need for the `ts-for-gir generate` command is located here
+ */
+import { Argv } from 'yargs';
+export declare const doc: {
+    command: string;
+    description: string;
+    builder: (yargs: Argv) => Argv<{
+        modules: unknown;
+    } & {
+        girDirectories: unknown;
+    } & {
+        outdir: unknown;
+    } & {
+        environments: unknown;
+    } & {
+        ignore: unknown;
+    } & {
+        verbose: unknown;
+    } & {
+        ignoreVersionConflicts: unknown;
+    } & {
+        configName: unknown;
+    }>;
+    handler: (args: any) => Promise<void>;
+    examples: readonly [string, (string | undefined)?][];
+};

package/lib/commands/doc.js

@@ -0,0 +1,48 @@
+/**
+ * Everything you need for the `ts-for-gir generate` command is located here
+ */
+import { GenerationHandler } from '../generation-handler.js';
+import { Config } from '../config.js';
+import { ModuleLoader } from '../module-loader.js';
+import { GeneratorType } from '../types/index.js';
+import { Logger } from '../logger.js';
+import { ERROR_NO_MODULES_FOUND } from '../messages.js';
+const command = 'doc [modules..]';
+const description = 'The HTML documentation generator is not yet implemented, but feel free to implement it 🤗';
+const builder = (yargs) => {
+    return yargs
+        .option('modules', Config.generateOptions.modules)
+        .option('girDirectories', Config.generateOptions.girDirectories)
+        .option('outdir', Config.generateOptions.outdir)
+        .option('environments', Config.generateOptions.environments)
+        .option('ignore', Config.generateOptions.ignore)
+        .option('verbose', Config.generateOptions.verbose)
+        .option('ignoreVersionConflicts', Config.generateOptions.ignoreVersionConflicts)
+        .option('configName', Config.generateOptions.configName)
+        .example(examples);
+};
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handler = async (args /* TODO */) => {
+    const config = await Config.load(args);
+    for (let i = 0; i < config.environments.length; i++) {
+        if (config.environments[i]) {
+            const generateConfig = Config.getGenerateConfig(config, config.environments[i]);
+            const moduleLoader = new ModuleLoader(generateConfig);
+            const { keep, grouped } = await moduleLoader.getModulesResolved(config.modules, config.ignore || [], config.ignoreVersionConflicts);
+            if (keep.length === 0) {
+                return Logger.error(ERROR_NO_MODULES_FOUND(config.girDirectories));
+            }
+            const tsForGir = new GenerationHandler(generateConfig, GeneratorType.HTML_DOC);
+            await tsForGir.start(Array.from(keep).map((girModuleResolvedBy) => girModuleResolvedBy.module), Object.values(grouped));
+        }
+    }
+};
+const examples = [];
+export const doc = {
+    command,
+    description,
+    builder,
+    handler,
+    examples,
+};
+//# sourceMappingURL=doc.js.map

package/lib/commands/doc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc.js","sourceRoot":"","sources":["../../src/commands/doc.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAClD,OAAO,EAAe,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAA;AAEvD,MAAM,OAAO,GAAG,iBAAiB,CAAA;AAEjC,MAAM,WAAW,GAAG,2FAA2F,CAAA;AAE/G,MAAM,OAAO,GAAG,CAAC,KAAW,EAAE,EAAE;IAC5B,OAAO,KAAK;SACP,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC;SACjD,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,eAAe,CAAC,cAAc,CAAC;SAC/D,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC;SAC/C,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC;SAC3D,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC;SAC/C,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC;SACjD,MAAM,CAAC,wBAAwB,EAAE,MAAM,CAAC,eAAe,CAAC,sBAAsB,CAAC;SAC/E,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC;SACvD,OAAO,CAAC,QAAQ,CAAC,CAAA;AAC1B,CAAC,CAAA;AAED,8DAA8D;AAC9D,MAAM,OAAO,GAAG,KAAK,EAAE,IAAS,CAAC,UAAU,EAAE,EAAE;IAC3C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,IAAmB,CAAC,CAAA;IAErD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACjD,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE;YACxB,MAAM,cAAc,GAAG,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;YAC/E,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,cAAc,CAAC,CAAA;YACrD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,YAAY,CAAC,kBAAkB,CAC3D,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,MAAM,IAAI,EAAE,EACnB,MAAM,CAAC,sBAAsB,CAChC,CAAA;YACD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;gBACnB,OAAO,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAA;aACrE;YACD,MAAM,QAAQ,GAAG,IAAI,iBAAiB,CAAC,cAAc,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAA;YAE9E,MAAM,QAAQ,CAAC,KAAK,CAChB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,mBAAmB,EAAE,EAAE,CAAC,mBAAmB,CAAC,MAAM,CAAC,EACzE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CACzB,CAAA;SACJ;KACJ;AACL,CAAC,CAAA;AAED,MAAM,QAAQ,GAAqC,EAAE,CAAA;AAErD,MAAM,CAAC,MAAM,GAAG,GAAG;IACf,OAAO;IACP,WAAW;IACX,OAAO;IACP,OAAO;IACP,QAAQ;CACX,CAAA"}

package/lib/commands/generate.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Everything you need for the `ts-for-gir generate` command is located here
+ */
+import { Argv } from 'yargs';
+export declare const generate: {
+    command: string;
+    description: string;
+    builder: (yargs: Argv) => Argv<{
+        modules: unknown;
+    } & {
+        girDirectories: unknown;
+    } & {
+        outdir: unknown;
+    } & {
+        environments: unknown;
+    } & {
+        ignore: unknown;
+    } & {
+        buildType: unknown;
+    } & {
+        moduleType: unknown;
+    } & {
+        pretty: unknown;
+    } & {
+        verbose: unknown;
+    } & {
+        ignoreVersionConflicts: unknown;
+    } & {
+        print: unknown;
+    } & {
+        configName: unknown;
+    } & {
+        useNamespace: unknown;
+    } & {
+        noComments: unknown;
+    } & {
+        noDebugComments: unknown;
+    } & {
+        noCheck: unknown;
+    } & {
+        fixConflicts: unknown;
+    }>;
+    handler: (args: any) => Promise<void>;
+    examples: readonly [string, (string | undefined)?][];
+};

package/lib/commands/generate.js

@@ -0,0 +1,71 @@
+/**
+ * Everything you need for the `ts-for-gir generate` command is located here
+ */
+import { GenerationHandler } from '../generation-handler.js';
+import { Config } from '../config.js';
+import { ModuleLoader } from '../module-loader.js';
+import { GeneratorType } from '../types/index.js';
+import { Logger } from '../logger.js';
+import { ERROR_NO_MODULES_FOUND } from '../messages.js';
+const command = 'generate [modules..]';
+const description = 'Generates .d.ts files from GIR for gjs or node-gtk';
+const builder = (yargs) => {
+    return yargs
+        .option('modules', Config.generateOptions.modules)
+        .option('girDirectories', Config.generateOptions.girDirectories)
+        .option('outdir', Config.generateOptions.outdir)
+        .option('environments', Config.generateOptions.environments)
+        .option('ignore', Config.generateOptions.ignore)
+        .option('buildType', Config.generateOptions.buildType)
+        .option('moduleType', Config.generateOptions.moduleType)
+        .option('pretty', Config.generateOptions.pretty)
+        .option('verbose', Config.generateOptions.verbose)
+        .option('ignoreVersionConflicts', Config.generateOptions.ignoreVersionConflicts)
+        .option('print', Config.generateOptions.print)
+        .option('configName', Config.generateOptions.configName)
+        .option('useNamespace', Config.generateOptions.useNamespace)
+        .option('noComments', Config.generateOptions.noComments)
+        .option('noDebugComments', Config.generateOptions.noDebugComments)
+        .option('noCheck', Config.generateOptions.noCheck)
+        .option('fixConflicts', Config.generateOptions.fixConflicts)
+        .example(examples);
+};
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handler = async (args /* TODO */) => {
+    const config = await Config.load(args);
+    for (const env of config.environments) {
+        const generateConfig = Config.getGenerateConfig(config, env);
+        const moduleLoader = new ModuleLoader(generateConfig);
+        const { keep, grouped } = await moduleLoader.getModulesResolved(config.modules, config.ignore || [], config.ignoreVersionConflicts);
+        if (keep.length === 0) {
+            return Logger.error(ERROR_NO_MODULES_FOUND(config.girDirectories));
+        }
+        const tsForGir = new GenerationHandler(generateConfig, GeneratorType.TYPES);
+        const girModules = Array.from(keep).map((girModuleResolvedBy) => girModuleResolvedBy.module);
+        const girModulesGrouped = Object.values(grouped);
+        await tsForGir.start(girModules, girModulesGrouped);
+    }
+};
+const examples = [
+    [
+        `${Config.appName} generate`,
+        `Run '${Config.appName} generate' in your gjs or node-gtk project to generate typings for your project, pass the gir modules you need for your project`,
+    ],
+    [`${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-3.0 xrandr-1.3`,
+        'Generate .d.ts. files but not for Gtk-3.0 and xrandr-1.3',
+    ],
+];
+export const generate = {
+    command,
+    description,
+    builder,
+    handler,
+    examples,
+};
+//# sourceMappingURL=generate.js.map

package/lib/commands/generate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/commands/generate.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAClD,OAAO,EAAe,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAA;AAEvD,MAAM,OAAO,GAAG,sBAAsB,CAAA;AAEtC,MAAM,WAAW,GAAG,oDAAoD,CAAA;AAExE,MAAM,OAAO,GAAG,CAAC,KAAW,EAAE,EAAE;IAC5B,OAAO,KAAK;SACP,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC;SACjD,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,eAAe,CAAC,cAAc,CAAC;SAC/D,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC;SAC/C,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC;SAC3D,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC;SAC/C,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC;SACrD,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC;SACvD,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC;SAC/C,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC;SACjD,MAAM,CAAC,wBAAwB,EAAE,MAAM,CAAC,eAAe,CAAC,sBAAsB,CAAC;SAC/E,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC;SAC7C,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC;SACvD,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC;SAC3D,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC;SACvD,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC,eAAe,CAAC,eAAe,CAAC;SACjE,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC;SACjD,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC;SAC3D,OAAO,CAAC,QAAQ,CAAC,CAAA;AAC1B,CAAC,CAAA;AAED,8DAA8D;AAC9D,MAAM,OAAO,GAAG,KAAK,EAAE,IAAS,CAAC,UAAU,EAAE,EAAE;IAC3C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,IAAmB,CAAC,CAAA;IAErD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,YAAY,EAAE;QACnC,MAAM,cAAc,GAAG,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QAC5D,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,cAAc,CAAC,CAAA;QACrD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,YAAY,CAAC,kBAAkB,CAC3D,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,MAAM,IAAI,EAAE,EACnB,MAAM,CAAC,sBAAsB,CAChC,CAAA;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YACnB,OAAO,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAA;SACrE;QACD,MAAM,QAAQ,GAAG,IAAI,iBAAiB,CAAC,cAAc,EAAE,aAAa,CAAC,KAAK,CAAC,CAAA;QAE3E,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,mBAAmB,EAAE,EAAE,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAA;QAC5F,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QAEhD,MAAM,QAAQ,CAAC,KAAK,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAA;KACtD;AACL,CAAC,CAAA;AAED,MAAM,QAAQ,GAAqC;IAC/C;QACI,GAAG,MAAM,CAAC,OAAO,WAAW;QAC5B,QAAQ,MAAM,CAAC,OAAO,iIAAiI;KAC1J;IACD,CAAC,GAAG,MAAM,CAAC,OAAO,gBAAgB,EAAE,6BAA6B,CAAC;IAClE,CAAC,GAAG,MAAM,CAAC,OAAO,eAAe,EAAE,oEAAoE,CAAC;IACxG,CAAC,GAAG,MAAM,CAAC,OAAO,sBAAsB,EAAE,oCAAoC,CAAC;IAC/E,CAAC,GAAG,MAAM,CAAC,OAAO,uBAAuB,EAAE,qCAAqC,CAAC;IACjF,CAAC,GAAG,MAAM,CAAC,OAAO,gDAAgD,EAAE,2BAA2B,CAAC;IAChG;QACI,GAAG,MAAM,CAAC,OAAO,uCAAuC;QACxD,0DAA0D;KAC7D;CACJ,CAAA;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG;IACpB,OAAO;IACP,WAAW;IACX,OAAO;IACP,OAAO;IACP,QAAQ;CACX,CAAA"}

package/lib/commands/index.d.ts

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

package/lib/commands/index.js

@@ -0,0 +1,4 @@
+export * from './doc.js';
+export * from './generate.js';
+export * from './list.js';
+//# sourceMappingURL=index.js.map

package/lib/commands/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/commands/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAC7B,cAAc,WAAW,CAAA"}

package/lib/commands/list.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Everything you need for the `ts-for-gir list` command is located here
+ */
+import { Argv } from 'yargs';
+export declare const list: {
+    command: string;
+    description: string;
+    builder: (yargs: Argv) => Argv<{
+        modules: unknown;
+    } & {
+        girDirectories: unknown;
+    } & {
+        ignore: unknown;
+    } & {
+        verbose: unknown;
+    } & {
+        configName: unknown;
+    }>;
+    handler: (args: any) => Promise<void>;
+    examples: readonly [string, (string | undefined)?][];
+};

package/lib/commands/list.js

@@ -0,0 +1,77 @@
+/**
+ * Everything you need for the `ts-for-gir list` command is located here
+ */
+import { ModuleLoader } from '../module-loader.js';
+import { Config } from '../config.js';
+import { ResolveType } from '../types/index.js';
+import { Logger } from '../logger.js';
+import { ERROR_NO_MODULES_FOUND } from '../messages.js';
+const command = 'list [modules..]';
+const description = 'Lists all available GIR modules';
+const builder = (yargs) => {
+    return yargs
+        .option('modules', Config.listOptions.modules)
+        .option('girDirectories', Config.listOptions.girDirectories)
+        .option('ignore', Config.listOptions.ignore)
+        .option('verbose', Config.listOptions.verbose)
+        .option('configName', Config.listOptions.configName)
+        .example(examples);
+};
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handler = async (args /* TODO */) => {
+    const config = await Config.load(args);
+    const generateConfig = Config.getGenerateConfig(config);
+    const moduleLoader = new ModuleLoader(generateConfig);
+    const { grouped, failed } = await moduleLoader.getModules(config.modules, config.ignore);
+    const moduleGroups = Object.values(grouped);
+    if (Object.keys(grouped).length === 0) {
+        return Logger.error(ERROR_NO_MODULES_FOUND(config.girDirectories));
+    }
+    const conflictModules = moduleGroups.filter((moduleGroup) => moduleGroup.hasConflict);
+    const byHandModules = moduleGroups.filter((moduleGroup) => moduleGroup.modules[0].resolvedBy === ResolveType.BY_HAND);
+    const depModules = moduleGroups.filter((moduleGroup) => moduleGroup.modules[0].resolvedBy === ResolveType.DEPENDENCE);
+    Logger.info('\nSelected Modules:');
+    for (const moduleGroup of byHandModules) {
+        for (const depModule of moduleGroup.modules) {
+            Logger.white(`- ${depModule.packageName}`);
+        }
+    }
+    if (depModules.length > 0) {
+        Logger.yellow('\nDependencies:');
+        for (const moduleGroup of depModules) {
+            for (const depModule of moduleGroup.modules) {
+                Logger.white(`- ${depModule.packageName}`);
+            }
+        }
+    }
+    if (conflictModules.length > 0) {
+        Logger.danger('\nConflicts:');
+        for (const moduleGroup of conflictModules) {
+            Logger.white(`- ${moduleGroup.namespace}`);
+            for (const conflictModule of moduleGroup.modules) {
+                Logger.white(`  - ${conflictModule.packageName}`);
+            }
+        }
+    }
+    if (failed.length > 0) {
+        Logger.danger('\nDependencies not found:');
+        for (const fail of failed) {
+            Logger.white(`- ${fail}`);
+        }
+    }
+};
+const examples = [
+    [`${Config.appName} list -g ./vala-girs/gir-1.0`, `Lists all available GIR modules in ./vala-girs/gir-1.0`],
+    [
+        `${Config.appName} list --ignore=Gtk-3.0 xrandr-1.3`,
+        'Lists all available GIR modules in /usr/share/gir-1.0 but not Gtk-3.0 and xrandr-1.3',
+    ],
+];
+export const list = {
+    command,
+    description,
+    builder,
+    handler,
+    examples,
+};
+//# sourceMappingURL=list.js.map

package/lib/commands/list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../src/commands/list.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,WAAW,EAAe,MAAM,mBAAmB,CAAA;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAA;AAEvD,MAAM,OAAO,GAAG,kBAAkB,CAAA;AAElC,MAAM,WAAW,GAAG,iCAAiC,CAAA;AAErD,MAAM,OAAO,GAAG,CAAC,KAAW,EAAE,EAAE;IAC5B,OAAO,KAAK;SACP,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC;SAC7C,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC;SAC3D,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC;SAC3C,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC;SAC7C,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC;SACnD,OAAO,CAAC,QAAQ,CAAC,CAAA;AAC1B,CAAC,CAAA;AAED,8DAA8D;AAC9D,MAAM,OAAO,GAAG,KAAK,EAAE,IAAS,CAAC,UAAU,EAAE,EAAE;IAC3C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,IAAmB,CAAC,CAAA;IACrD,MAAM,cAAc,GAAG,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAA;IACvD,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,cAAc,CAAC,CAAA;IACrD,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;IACxF,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAC3C,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QACnC,OAAO,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAA;KACrE;IAED,MAAM,eAAe,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,CAAA;IAErF,MAAM,aAAa,GAAG,YAAY,CAAC,MAAM,CACrC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,KAAK,WAAW,CAAC,OAAO,CAC7E,CAAA;IAED,MAAM,UAAU,GAAG,YAAY,CAAC,MAAM,CAClC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,KAAK,WAAW,CAAC,UAAU,CAChF,CAAA;IAED,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;IAClC,KAAK,MAAM,WAAW,IAAI,aAAa,EAAE;QACrC,KAAK,MAAM,SAAS,IAAI,WAAW,CAAC,OAAO,EAAE;YACzC,MAAM,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC,WAAW,EAAE,CAAC,CAAA;SAC7C;KACJ;IAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;QACvB,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAA;QAChC,KAAK,MAAM,WAAW,IAAI,UAAU,EAAE;YAClC,KAAK,MAAM,SAAS,IAAI,WAAW,CAAC,OAAO,EAAE;gBACzC,MAAM,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC,WAAW,EAAE,CAAC,CAAA;aAC7C;SACJ;KACJ;IAED,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;QAC5B,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;QAC7B,KAAK,MAAM,WAAW,IAAI,eAAe,EAAE;YACvC,MAAM,CAAC,KAAK,CAAC,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC,CAAA;YAC1C,KAAK,MAAM,cAAc,IAAI,WAAW,CAAC,OAAO,EAAE;gBAC9C,MAAM,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,WAAW,EAAE,CAAC,CAAA;aACpD;SACJ;KACJ;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACnB,MAAM,CAAC,MAAM,CAAC,2BAA2B,CAAC,CAAA;QAC1C,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE;YACvB,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAA;SAC5B;KACJ;AACL,CAAC,CAAA;AAED,MAAM,QAAQ,GAAqC;IAC/C,CAAC,GAAG,MAAM,CAAC,OAAO,8BAA8B,EAAE,wDAAwD,CAAC;IAC3G;QACI,GAAG,MAAM,CAAC,OAAO,mCAAmC;QACpD,sFAAsF;KACzF;CACJ,CAAA;AAED,MAAM,CAAC,MAAM,IAAI,GAAG;IAChB,OAAO;IACP,WAAW;IACX,OAAO;IACP,OAAO;IACP,QAAQ;CACX,CAAA"}

package/lib/config.d.ts

@@ -0,0 +1,103 @@
+/**
+ * Default values, parse the config file and handle CLI flags
+ */
+import { Options } from 'yargs';
+import type { Environment, UserConfig, ConfigFlags, GenerateConfig } from './types/index.js';
+export declare class Config {
+    static appName: string;
+    static usage: string;
+    /**
+     * Default cli flag and argument values
+     */
+    static defaults: {
+        environments: string[];
+        pretty: boolean;
+        print: boolean;
+        configName: string;
+        outdir: string;
+        girDirectories: string[];
+        modules: string[];
+        ignore: never[];
+        verbose: boolean;
+        ignoreVersionConflicts: boolean;
+        useNamespace: boolean;
+        buildType: string;
+        moduleType: string;
+        noComments: boolean;
+        noDebugComments: boolean;
+        noCheck: boolean;
+        fixConflicts: boolean;
+    };
+    static configFilePath: string;
+    /**
+     * CLI options used in commands/generate.ts and commands/list.ts
+     */
+    static options: {
+        modules: Options;
+        girDirectories: Options;
+        outdir: Options;
+        environments: Options;
+        ignore: Options;
+        buildType: Options;
+        moduleType: Options;
+        pretty: Options;
+        verbose: Options;
+        ignoreVersionConflicts: Options;
+        print: Options;
+        configName: Options;
+        useNamespace: Options;
+        noComments: Options;
+        noDebugComments: Options;
+        noCheck: Options;
+        fixConflicts: Options;
+    };
+    /**
+     * CLI flags used in commands/generate.ts
+     */
+    static generateOptions: {
+        modules: Options;
+        girDirectories: Options;
+        outdir: Options;
+        environments: Options;
+        ignore: Options;
+        buildType: Options;
+        moduleType: Options;
+        pretty: Options;
+        verbose: Options;
+        ignoreVersionConflicts: Options;
+        print: Options;
+        configName: Options;
+        useNamespace: Options;
+        noComments: Options;
+        noDebugComments: Options;
+        noCheck: Options;
+        fixConflicts: Options;
+    };
+    static listOptions: {
+        modules: Options;
+        girDirectories: Options;
+        ignore: Options;
+        configName: Options;
+        verbose: Options;
+    };
+    /**
+     * Overwrites values in the user config
+     * @param configsToAdd
+     */
+    static addToConfig(configsToAdd: Partial<UserConfig>): Promise<void>;
+    /**
+     * 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
+     */
+    private static loadConfigFile;
+    static getGenerateConfig(config: UserConfig, environment?: Environment): GenerateConfig;
+    static validate(options: UserConfig): UserConfig;
+    /**
+     * 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 load(options: ConfigFlags): Promise<UserConfig>;
+}