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

package/README.md

@@ -10,7 +10,7 @@
   <img src="https://badgen.net/npm/dw/@ts-for-gir/cli" />
 </p>
 
-<p align="center">TypeScript type definition generator for GObject introspection interfaces</p>
+<p align="center">TypeScript type definition generator for GObject introspection GIR files</p>
 
 <p align="center">
   <img src="https://raw.githubusercontent.com/gjsify/ts-for-gir/main/.github/feeling.gif" />
@@ -18,7 +18,7 @@
 
 # CLI
 
-CLI tool to generate Typescript Type Definition files for Gjs and node-gtk.
+CLI tool to generate Typescript Type Definition files for GJS and node-gtk.
 
 ## Getting started
 
@@ -42,10 +42,10 @@ After you have installed `@ts-for-gir/cli` you can run the `ts-for-gir` command:
 ```bash
 $ ts-for-gir --help
 
-Typescript .d.ts generator from GIR for gjs or node-gtk
+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
+  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
   ts-for-gir doc [modules..]       The HTML documentation generator is not yet i
@@ -58,7 +58,7 @@ Options:
 
 ## Example
 
-To generate the Typescript type definitions of Gtk-4.0 for Gjs run:
+To generate the Typescript type definitions of Gtk-4.0 for GJS run:
 
 ```
 ts-for-gir generate Gtk-4.0
@@ -79,7 +79,9 @@ $ ts-for-gir generate --help
 
 ts-for-gir generate [modules..]
 
-Generates .d.ts files from GIR for gjs or node-gtk
+ts-for-gir generate [modules..]
+
+Generates .d.ts files from GIR for GJS or node-gtk
 
 Options:
       --version                 Show version number                    [boolean]
@@ -87,7 +89,14 @@ Options:
       --modules                 GIR modules to load, e.g. 'Gio-2.0'. Accepts mul
                                 tiple modules           [array] [default: ["*"]]
   -g, --girDirectories          GIR directories
-                                       [array] [default: ["/usr/share/gir-1.0"]]
+  [array] [default: ["/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/li
+  b64/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","/ho
+  me/jumplink/.local/share/flatpak/exports/share/gir-1.0","/var/lib/flatpak/expo
+                                                            rts/share/gir-1.0"]]
+      --root                    Root directory of your project
+                        [string] [default: "/home/jumplink/Projekte/ts-for-gir"]
   -o, --outdir                  Directory to output to
                                                   [string] [default: "./@types"]
   -e, --environments            Javascript environment
@@ -97,7 +106,7 @@ Options:
   -b, --buildType               Definitions generation type
                              [string] [choices: "lib", "types"] [default: "lib"]
   -t, --moduleType              Specify what module code is generated.
-                          [string] [choices: "esm", "commonjs"] [default: "esm"]
+                   [string] [choices: "esm", "commonjs", "cjs"] [default: "esm"]
   -v, --verbose                 Switch on/off the verbose mode
                                                        [string] [default: false]
       --ignoreVersionConflicts  Do not ask for package versions if multiple vers
@@ -117,10 +126,29 @@ Options:
                                                        [string] [default: false]
       --fixConflicts            Fix Inheritance and implementation type conflict
                                 s                       [string] [default: true]
-      --gnomeShellTypes         Generate types for GNOME Shell (Experimental)
-                                                       [string] [default: false]
   -a, --generateAlias           Generate an alias tsconfig file to support GJS E
                                 SM module imports      [string] [default: false]
+      --promisify               Generate promisified functions for async/finish
+                                calls                   [string] [default: true]
+      --npmScope                Scope of the generated NPM packages
+                                                     [string] [default: "@girs"]
+      --package                 Generates an NPM compatible packages for each GI
+                                R module               [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-4.0 xra  Generate .d.ts. files but not for Gt
+  ndr-1.3                                   k-4.0 and xrandr-1.3
 ```
 
 ## List available GIR modules
@@ -137,11 +165,24 @@ Options:
       --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"]]
+  -g, --girDirectories  GIR directories
+  [array] [default: ["/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/li
+  b64/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","/ho
+  me/jumplink/.local/share/flatpak/exports/share/gir-1.0","/var/lib/flatpak/expo
+                                                            rts/share/gir-1.0"]]
   -i, --ignore          Modules that should be ignored     [array] [default: []]
-  -v, --verbose         Switch on/off the verbose mode [string] [default: false]
       --configName      Name of the config if you want to use a different name
                                           [string] [default: ".ts-for-girrc.js"]
+  -v, --verbose         Switch on/off the verbose mode [string] [default: false]
+
+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
@@ -182,7 +223,7 @@ You can pass the config file name to the CLI using [configName](#configName).
 ## Options
 
 ### girDirectories
-Directories in which *.gir files are to be searched for. Default is `["/usr/share/gir-1.0"]`. More than one can be specified. If you want to generate the types for the GNOME Shell you have to search in several folders for the corresponding types: 
+Directories in which `*.gir` files are to be searched for. Default is `["/usr/share/gir-1.0"]`. More than one can be specified. If you want to generate the types for the GNOME Shell you have to search in several folders for the corresponding types: 
 ```js
 girDirectories: [
   // General gir files
@@ -247,14 +288,14 @@ Note that ignoring a module will prevent ts-for-gir from generating types for th
 `ts-for-gir` supports two build types for generating the types: `"lib"` and `"types"`.
 
 * If `"lib"` is specified, `.js` files are generated as well as `.d.ts`, this is useful for some bundlers that expect a `.js` file. Some bundlers are also able to generate the import of this file only once, even if it occurs multiple times in your code.
-* If `"types"` is specified, only `.d.ts` files are generated. In this mode it is recommended to add the generated `"@types/Gjs/index.d.ts" ` under `"include"` in the `tsconfig` to make the generated types known in your project. If you also want to use imports in `ESM` format, you should also enable the `generateAlias` option.
+* If `"types"` is specified, only `.d.ts` files are generated. In this mode it is recommended to add the generated `"@types/gjs.d.ts"` and `"@types/ambient.d.ts"` under `"include"` in the `tsconfig` to make the generated types known in your project. If you have problems to use imports in `ESM` format, you can also enable the `generateAlias` option and extend your `tsconfig` from the generated `"tsconfig.alias.json"`.
 
 ### moduleType
-The `moduleType` CLI option determines the format in which the generated JavaScript files should be exported. The option takes either `"esm"` or `"commonjs"` as its value, with `"esm"` being the default.
+The `moduleType` CLI option determines the format in which the generated JavaScript files should be exported. The option takes either `"esm"` or `"cjs"` as its value, with `"esm"` being the default.
 
 > This option is only relevant if the `buildType` is set to `"lib"`. The choice of `moduleType` may affect how the generated code is used in other parts of your project, so it's important to choose the right format that works best for your use case.
 
-The choice of `moduleType` is also important in the context of the bundler that you plan to use in your project. For example, if you are using a bundler that only supports ESM (such as Rollup), you would need to set `moduleType` to "esm". On the other hand, if you are using a bundler that supports both ESM and CommonJS (such as Webpack), you can choose whichever format you prefer. Ultimately, the choice of `moduleType` will depend on your project requirements and the tools that you are using. For Example, if you want to build a GNOME Shell Extension, you should use `"commonjs"` because `ESM` is currently not supported for GNOME Shell Extensions. For [node-gtk](https://github.com/romgrk/node-gtk) you also need to use `"commonjs"`. If you want to build a regular Gjs Application we recommend to use `ESM`.
+The choice of `moduleType` is also important in the context of the bundler that you plan to use in your project. For example, if you are using a bundler that only supports ESM (such as Rollup), you would need to set `moduleType` to "esm". On the other hand, if you are using a bundler that supports both ESM and CommonJS (such as Webpack), you can choose whichever format you prefer. Ultimately, the choice of `moduleType` will depend on your project requirements and the tools that you are using. For Example, if you want to build a GNOME Shell Extension, you should use `"cjs"` because `ESM` is currently not supported for GNOME Shell Extensions. For [node-gtk](https://github.com/romgrk/node-gtk) you also need to use `"cjs"`. If you want to build a regular GJS Application we recommend to use `ESM`.
 
 When `"esm"` is set, the generated JavaScript files will use the ECMAScript module (ESM) format for imports and exports. For example, the generated code might look like this:
 
@@ -278,9 +319,9 @@ import Gtk from 'gi://Gtk?version=4.0';
 export default Gtk;
 ```
 
-> The `"esm"` module type is recommended for Gjs applications as it makes use of the ESM import syntax, which is more modern and flexible compared to imports.gi / CommonJS imports. This allows for a more streamlined and convenient way of using the generated types in your Gjs application. Support for ES modules can be activated in `gjs` with its `gjs -m` flag.
+> The `"esm"` module type is recommended for GJS applications as it makes use of the ESM import syntax, which is more modern and flexible compared to imports.gi / CommonJS imports. This allows for a more streamlined and convenient way of using the generated types in your GJS application. Support for ES modules can be activated in `gjs` with its `gjs -m` flag.
 
-When `"commonjs"` and [`noNamespace`](#nonamespace) is set, the generated JavaScript files will use the CommonJS format exports and the `imports.gi` object for imports. For example:
+When `"cjs"` and [`noNamespace`](#nonamespace) is set, the generated JavaScript files will use the CommonJS format exports and the `imports.gi` object for imports. For example:
 
 ```ts
 // Gtk-4.0.d.ts
@@ -301,7 +342,7 @@ module.exports = { Gtk };
 exports.default = Gtk;
 ```
 
-> It is recommended to also set the [noNamespace](#nonamespace) option to true when using the `"commonjs"` moduleType option. This will ensure that the generated code is fully compatible with the CommonJS format.
+> It is recommended to also set the [noNamespace](#nonamespace) option to true when using the `"cjs"` moduleType option. This will ensure that the generated code is fully compatible with the CommonJS format.
 
 
 ### verbose
@@ -368,13 +409,6 @@ The `fixConflicts` CLI option is used to resolve type conflicts between the GObj
 
 > If you have found an issue with the `fixConflicts` CLI option, we encourage you to report it. Reporting issues helps improve the quality of `ts-for-gir` and makes it a better tool for everyone.
 
-### gnomeShellTypes
-The `gnomeShellTypes` CLI option generates types for GNOME Shell Extensions and is currently experimental. It is recommended to use this option if you are developing a GNOME Shell Extension and would like to benefit from type checking and auto-completion while writing your code. When this option is enabled, additional types will be generated for the GNOME Shell API.
-
-Note that the generated types may contain experimental or incomplete parts, so use this option with caution and report any issues you encounter. Also note that the generated types are specific to the version of GNOME Shell that you are targeting, so make sure that you are using the correct version of GNOME Shell and `gir` files.
-
-> The example in [examples/Gjs/gnome-shell-hello-world](https://github.com/gjsify/ts-for-gir/tree/main/examples/Gjs/gnome-shell-hello-world) demonstrates the usage of the `gnomeShellTypes` option and how you can build a GNOME Shell Extension with TypeScript using the generated types from `ts-for-gir`.
-
 ### generateAlias
 The `generateAlias` CLI option, when active, generates an alias `tsconfig.alias.json` file to support ESM module imports in GJS. This is particularly useful if you want to import GIR modules in your GJS code using the `'gi://...'` syntax. The generated `tsconfig.alias.json` file will contain the necessary path aliases to enable TypeScript to properly resolve the imported modules, allowing for improved code editor functionality, such as type checking and code completion.
 
@@ -388,15 +422,15 @@ You can extend the generated `tsconfig.alias.json` file in your main tsconfig.js
   "compilerOptions": {
     "baseUrl": ".",
     "paths": { 
-      "gi://Gio?version=2.0": ["./@types/Gjs/Gio-2.0.d.ts"],
-      "gi://Gio": ["./@types/Gjs/Gio-2.0.d.ts"],
-      "gi://GObject?version=2.0": ["./@types/Gjs/GObject-2.0.d.ts"],
-      "gi://GObject": ["./@types/Gjs/GObject-2.0.d.ts"],
-      "gi://GLib?version=2.0": ["./@types/Gjs/GLib-2.0.d.ts"],
-      "gi://GLib": ["./@types/Gjs/GLib-2.0.d.ts"]
+      "gi://Gio?version=2.0": ["./@types/gio-2.0.d.ts"],
+      "gi://Gio": ["./@types/gio-2.0.d.ts"],
+      "gi://GObject?version=2.0": ["./@types/gobject-2.0.d.ts"],
+      "gi://GObject": ["./@types/gobject-2.0.d.ts"],
+      "gi://GLib?version=2.0": ["./@types/glib-2.0.d.ts"],
+      "gi://GLib": ["./@types/glib-2.0.d.ts"]
     }
   },
-  "include": ["./@types/Gjs/*.ts"]
+  "include": ["./@types/*.ts"]
 }
 ```
 
@@ -410,11 +444,102 @@ You can extend the generated `tsconfig.alias.json` file in your main tsconfig.js
     "target": "ESNext",
     "module": "ESNext"
   },
-  "include": ["@types/Gjs/index.d.ts"],
+  "include": ["@types/gjs.d.ts"],
+  "files": [
+    "main.ts",
+  ]
+}
+```
+
+> The example in [examples/gjs/gio-2-cat-alias](https://github.com/gjsify/ts-for-gir/tree/main/examples/gjs/gio-2-cat-alias) demonstrates the usage of the generateAlias option. This example shows how to use the generated tsconfig.alias.json file in a GJS project and provides a clear understanding of how this option can be used in practice.
+
+# package
+
+The `--package` option of ts-for-gir is used to package the generated TypeScript type definitions into an NPM package. The generated package can be easily installed and used in other TypeScript projects via `npm install`.
+
+> Another advantage is NPM packages is, that you can use them in a monorepo using a package manager with support for workspaces such as Yarn, PNPM and Lerna. To use the generated packages in a monorepo, you can add them as dependencies to your project's package.json file, and use relative file paths or the file: protocol to point to the local package directories. This way, you can import the generated types from within your project like any other TypeScript module.
+
+When this option is used, each GObject introspection module will be packaged into its own NPM package. The package name will be in the format of `@girs/<lower case module name>-<version>`.
+
+For example, if the `--package` option is used to generate the TypeScript type definitions for the `Gtk-4.0` module, then the generated NPM package will have the name `@girs/gtk-3.0`.
+
+> You can change the NPM package scope name with the [`--npmScope`](#npmscope) option.
+
+To use the generated NPM package in your TypeScript project, you can also install our pregenerated packages:
+
+```bash
+npm install @girs/gtk-3.0
+```
+
+Then, import the desired module in your TypeScript code:
+
+```ts
+import Gtk from '@girs/gtk-4.0';
+
+const button = new Gtk.Button();
+```
+
+It is recommended to use the `--package` option when generating TypeScript type definitions for a GObject introspection module, as it allows for easy distribution and consumption of the generated types. However, please note that the generated NPM packages will only work with a package manager like NPM or Yarn, and cannot be used directly in a GJS or Node.js project.
+
+> Here are some examples are making use of the `--package` option:
+> * [examples/gjs/gio-2-cat-packages](https://github.com/gjsify/ts-for-gir/tree/main/examples/gjs/gio-2-cat-packages) - GJS example with `--package` option
+> * [examples/node-gtk/gio-2-cat-packages](https://github.com/gjsify/ts-for-gir/tree/main/examples/node-gtk/gio-2-cat-packages) - node-gtk example with `--package` option
+
+## npmScope
+
+The `--npmScope` CLI option can be used to specify a custom NPM package scope name for the generated packages. By default, the scope name is `@girs`.
+
+Here's an example command to generate NPM packages with a custom scope name:
+
+```bash
+ts-for-gir --buildType lib --package --npmScope my-scope
+```
+
+This command will generate NPM packages with the scope `my-scope` instead of the default `@girs` scope. For `Gtk-4.0` this would generate a package with the name of `@my-scope/gtk-4.0`.
+
+## Ambient modules
+
+In TypeScript, ambient modules are a way to define external modules that are not part of the TypeScript codebase. This can be useful for importing external libraries or modules, including those generated by ts-for-gir using the `gi://` syntax.
+
+If you want to have support for ambient modules, then you have to enable the [`--package`](#package) option, this will generate a NPM package for each module.
+Alternatively, you can also use the pre-generated NPM packages for this, so you don't even need to use ts-for-gir for it. For example, look at the NPM packages [gtk-4.0](https://www.npmjs.com/package/@girs/gtk-4.0), [gio-2.0](https://www.npmjs.com/package/@girs/gio-2.0) and [adw-1](https://www.npmjs.com/package/@girs/adw-1). All pre-generated NPM packages can be found on [gjsify/types](https://github.com/gjsify/types).
+
+> The advantage of self-generated types is that you generate the types exactly for your locally installed library version. However, we try to keep the pre-generated NPM packages as up to date as possible.
+
+### Alias
+If for some reason you don't want to or can't generate NPM packages, you can instead use the [`--generateAlias`](#generatealias) CLI option. This way you can also use imports in the `gi://` syntax with the generated types.
+
+To use ambient modules, the `ambient.d.ts` file must be imported either in the code like `import '@girs/gjs/ambient'` or by adding an entry to the `includes` property in the `tsconfig` file. The `ambient.d.ts` file is automatically generated.
+
+```json
+// tsconfig.json
+{
+  "compilerOptions": {   
+    "lib": ["ESNext"],
+    "types": [],
+    "target": "ESNext",
+    "module": "ESNext"
+  },
+  "include": ["@girs/gjs", "@girs/gjs/ambient"],
   "files": [
     "main.ts",
   ]
 }
 ```
 
-> The example in [examples/Gjs/gio-2-cat-alias](https://github.com/gjsify/ts-for-gir/tree/main/examples/Gjs/gio-2-cat-alias) demonstrates the usage of the generateAlias option. This example shows how to use the generated tsconfig.alias.json file in a Gjs project and provides a clear understanding of how this option can be used in practice.
+> Here are some examples demonstrating the usage of ambient modules:
+> * [examples/gjs/gio-2-cat-packages](https://github.com/gjsify/ts-for-gir/tree/main/examples/gjs/gio-2-cat-packages) - GJS example with `--package` option
+> * [examples/node-gtk/gio-2-cat-packages](https://github.com/gjsify/ts-for-gir/tree/main/examples/node-gtk/gio-2-cat-packages) - node-gtk example with `--package` option
+
+### Without version specifier
+
+Some ambient modules declarations are only defined with the version specifier to prevent version conflicts e.g. between Gtk-3.0 and Gtk-4.0.
+If you want to import the modules without the version specifier you can define the module declarations by yourself, similarly to this:
+
+```ts
+// gtk4-ambient.d.ts
+declare module "gi://Gtk" {
+  import Gtk from "gi://Gtk?version=4.0";
+  export default Gtk;
+}
+```

package/lib/commands/doc.d.ts

@@ -5,23 +5,7 @@ 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;
-    }>;
+    builder: (yargs: Argv) => Argv<{}>;
     handler: (args: any) => Promise<void>;
     examples: readonly [string, (string | undefined)?][];
 };

package/lib/commands/doc.js

@@ -1,25 +1,19 @@
 /**
  * Everything you need for the `ts-for-gir generate` command is located here
  */
+import { Logger, ERROR_NO_MODULES_FOUND } from '@ts-for-gir/lib';
+import { GeneratorType } from '@ts-for-gir/generator-base';
 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);
+    const optionNames = Object.keys(Config.docOptions);
+    for (const optionName of optionNames) {
+        yargs = yargs.option(optionName, Config.docOptions[optionName]);
+    }
+    return yargs.example(examples);
 };
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const handler = async (args /* TODO */) => {

package/lib/commands/doc.js.map

@@ -1 +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"}
+{"version":3,"file":"doc.js","sourceRoot":"","sources":["../../src/commands/doc.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAA;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAIlD,MAAM,OAAO,GAAG,iBAAiB,CAAA;AAEjC,MAAM,WAAW,GAAG,2FAA2F,CAAA;AAE/G,MAAM,OAAO,GAAG,CAAC,KAAW,EAAE,EAAE;IAC5B,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;IAClD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;QAClC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAA;KAClE;IACD,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;AAClC,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

@@ -5,43 +5,7 @@ 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;
-    } & {
-        verbose: unknown;
-    } & {
-        ignoreVersionConflicts: unknown;
-    } & {
-        print: unknown;
-    } & {
-        configName: unknown;
-    } & {
-        noNamespace: unknown;
-    } & {
-        noComments: unknown;
-    } & {
-        noDebugComments: unknown;
-    } & {
-        noDOMLib: unknown;
-    } & {
-        fixConflicts: unknown;
-    } & {
-        gnomeShellTypes: unknown;
-    } & {
-        generateAlias: unknown;
-    }>;
+    builder: (yargs: Argv) => Argv<{}>;
     handler: (args: any) => Promise<void>;
     examples: readonly [string, (string | undefined)?][];
 };

package/lib/commands/generate.js

@@ -1,35 +1,19 @@
 /**
  * Everything you need for the `ts-for-gir generate` command is located here
  */
+import { ERROR_NO_MODULES_FOUND, Logger } from '@ts-for-gir/lib';
+import { GeneratorType } from '@ts-for-gir/generator-base';
 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 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('verbose', Config.generateOptions.verbose)
-        .option('ignoreVersionConflicts', Config.generateOptions.ignoreVersionConflicts)
-        .option('print', Config.generateOptions.print)
-        .option('configName', Config.generateOptions.configName)
-        .option('noNamespace', Config.generateOptions.noNamespace)
-        .option('noComments', Config.generateOptions.noComments)
-        .option('noDebugComments', Config.generateOptions.noDebugComments)
-        .option('noDOMLib', Config.generateOptions.noDOMLib)
-        .option('fixConflicts', Config.generateOptions.fixConflicts)
-        .option('gnomeShellTypes', Config.generateOptions.gnomeShellTypes)
-        .option('generateAlias', Config.generateOptions.generateAlias)
-        .example(examples);
+    const optionNames = Object.keys(Config.generateOptions);
+    for (const optionName of optionNames) {
+        yargs = yargs.option(optionName, Config.generateOptions[optionName]);
+    }
+    return yargs.example(examples);
 };
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const handler = async (args /* TODO */) => {

package/lib/commands/generate.js.map

@@ -1 +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,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,aAAa,EAAE,MAAM,CAAC,eAAe,CAAC,WAAW,CAAC;SACzD,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC;SACvD,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC,eAAe,CAAC,eAAe,CAAC;SACjE,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC;SACnD,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC;SAC3D,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC,eAAe,CAAC,eAAe,CAAC;SACjE,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC,eAAe,CAAC,aAAa,CAAC;SAC7D,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"}
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/commands/generate.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,sBAAsB,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAIlD,MAAM,OAAO,GAAG,sBAAsB,CAAA;AAEtC,MAAM,WAAW,GAAG,oDAAoD,CAAA;AAExE,MAAM,OAAO,GAAG,CAAC,KAAW,EAAE,EAAE;IAC5B,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,CAAA;IACvD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;QAClC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAA;KACvE;IACD,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;AAClC,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/list.d.ts

@@ -5,17 +5,7 @@ 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;
-    }>;
+    builder: (yargs: Argv) => Argv<{}>;
     handler: (args: any) => Promise<void>;
     examples: readonly [string, (string | undefined)?][];
 };

package/lib/commands/list.js

@@ -3,19 +3,15 @@
  */
 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';
+import { Logger, ERROR_NO_MODULES_FOUND, ResolveType } from '@ts-for-gir/lib';
 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);
+    const optionNames = Object.keys(Config.listOptions);
+    for (const optionName of optionNames) {
+        yargs = yargs.option(optionName, Config.listOptions[optionName]);
+    }
+    return yargs.example(examples);
 };
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const handler = async (args /* TODO */) => {

package/lib/commands/list.js.map

@@ -1 +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"}
+{"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,MAAM,EAAE,sBAAsB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAI7E,MAAM,OAAO,GAAG,kBAAkB,CAAA;AAElC,MAAM,WAAW,GAAG,iCAAiC,CAAA;AAErD,MAAM,OAAO,GAAG,CAAC,KAAW,EAAE,EAAE;IAC5B,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;IACnD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;QAClC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAA;KACnE;IACD,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;AAClC,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

@@ -1,5 +1,5 @@
 import { Options } from 'yargs';
-import type { Environment, UserConfig, ConfigFlags, GenerateConfig } from './types/index.js';
+import type { Environment, UserConfig, ConfigFlags, GenerateConfig } from '@ts-for-gir/lib';
 export declare class Config {
     static appName: string;
     static usage: string;
@@ -10,6 +10,7 @@ export declare class Config {
         environments: string[];
         print: boolean;
         configName: string;
+        root: string;
         outdir: string;
         girDirectories: string[];
         modules: string[];
@@ -23,8 +24,10 @@ export declare class Config {
         noDebugComments: boolean;
         fixConflicts: boolean;
         noDOMLib: boolean;
-        gnomeShellTypes: boolean;
         generateAlias: boolean;
+        promisify: boolean;
+        npmScope: string;
+        package: boolean;
     };
     static configFilePath: string;
     /**
@@ -39,6 +42,7 @@ export declare class Config {
     static generateOptions: {
         modules: Options;
         girDirectories: Options;
+        root: Options;
         outdir: Options;
         environments: Options;
         ignore: Options;
@@ -53,8 +57,10 @@ export declare class Config {
         noDebugComments: Options;
         noDOMLib: Options;
         fixConflicts: Options;
-        gnomeShellTypes: Options;
         generateAlias: Options;
+        promisify: Options;
+        npmScope: Options;
+        package: Options;
     };
     static listOptions: {
         modules: Options;
@@ -63,11 +69,21 @@ export declare class Config {
         configName: Options;
         verbose: Options;
     };
+    static docOptions: {
+        modules: Options;
+        girDirectories: Options;
+        outdir: Options;
+        environments: Options;
+        ignore: Options;
+        verbose: Options;
+        ignoreVersionConflicts: Options;
+        configName: Options;
+    };
     /**
-     * Overwrites values in the user config
+     * Overwrites values in the user config file
      * @param configsToAdd
      */
-    static addToConfig(configsToAdd: Partial<UserConfig>): Promise<void>;
+    static addToConfig(configsToAdd: Partial<UserConfig>, configName?: string): 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