TypeScript binding generator for GJS and node-gtk (in a very early stage). Inspired by gir2dts but re-written and re-designed to be a more thorough TypeScript description of the GObject introspection interfaces.
The definitions can be used for both TypeScript or JavaScript projects.
git clone https://github.com/sammydre/ts-for-gjs
cd ts-for-gjs
git submodule update --init
npm install
npm linkRun npm link, this is similar to npm -g install ts-for-gir but links to your local development repository which allows you to test your changes directly.
Now you can execute ts-for-gir anywhere on your system:
ts-for-gir --helpAlternatively, you can run
npm run start -- --helpto test your changes, this will run ts-for-gir with ts-node, so you don't need to rebuild the package for this.
After you have linked this project you can use the ts-for-gir command in you project:
$ ts-for-gir --help
Typescript .d.ts generator from GIR for gjs or node-gtk
VERSION
ts-for-gir/1.0.0 linux-x64 node-v12.14.1
USAGE
$ ts-for-gir [COMMAND]
COMMANDS
generate Generates .d.ts files from GIR for gjs or node-gtk
help display help for ts-for-gir
list Lists all available GIR modules$ ts-for-gir generate --help
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"]
--pretty prettifies the generated .d.ts files
[string] [default: false]
-v, --verbose Switch on/off the verbose mode [string] [default: true]
--ignoreConflicts 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, --exportDefault Export all symbols for each module as a single entity u
sing ES6 export default [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$ 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
A9BD
usr/share/gir-1.0 but not Gtk-3.0 an
d xrandr-1.3In 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:
module.exports = {
pretty: false,
print: false,
verbose: true,
environments: ['gjs', 'node'],
outdir: '@types',
girDirectories: '/usr/share/gir-1.0',
modules: ['*'],
ignore: [],
exportDefault: true,
}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.
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 exportDefault and Gjs ESM.
Run npm run regress or ts-for-gir --configName='.ts-for-gir.regress.rc.js' in the root of this project to generate the type definitions for the examples
Now open some code with an editor that understands TypeScript and see what happens, for example Visual Studio Code.
code examples/gjs/browserInstall GObject Introspection Repository files:
# Ubuntu 18.04
sudo apt update && sudo apt install \
libappindicator3-dev \
libgda-5.0-dev \
libgirepository1.0-dev \
libgtk-3-dev \
libgtksourceview-3.0-dev \
libnotify-dev \
libsoup2.4-dev \
libwebkit2gtk-4.0-dev
# Fedora 35
sudo dnf update && sudo dnf install \
libappindicator-gtk3-devel \
libgda-devel \
gobject-introspection-devel \
gtk3-devel \
gtksourceview3-devel \
libnotify-devel \
libsoup-devel \
webkit2gtk3-develGenerate example type definitions:
npm run regressSee gobject-introspection/docs/gir-1.2.rnc for type definitions.
To validate all your generated type definition files in this project run
npm run validate:allTo validate only your type definition files for Gjs
npm run validate:gjsTo validate only your type definition files for node-gtk
npm run validate:nodeYou can also validate a single type definition file like this
npm run validate -- ./@types/Gjs/GObject-2.0.d.tsTo run our ava tests just run:
npm run test:avaWe have a test which tries to generate the type definition files for all gir files from the vala-girs repository.
Before you can run this test you need to checkout the vala-girs submodule, to do that run this in the root of ts-for-gjs:
git submodule update --initNow you can run the test with
npm run test:girs:gjs
npm run test:girs:node
# or npm run test:girs:all- gnome-gtk - Typescript bindings for gnome gtk
- ts-gir - Typescript bindings for GJS
- node-gir-typedef - TypeScript bindings for node-gir
- gir2dts - The project this is inspired by
- gir-dts-generator - The project that inspired this project
- gjs-ts - Typescript bindings for GJS
- Typescript Doclet - Experimental TypeScript binding generator written in Vala as a Valadoc extension
- gi.ts - Highly accurate TypeScript bindings for GJS
- gjs-docs - GJS documentation server written using gjs
- node-gtk - GIO bindings for NodeJS
- cgjs - A NodeJS / CommonJS Runtime for GJS
- jsgtk - Replaced by cgjs
- vala-girs - Collection of GIRs and VAPIs for the Vala toolchain
- gjs-examples - GJS examples showing how to build Gtk javascript applications
- hello-gjs-npm - Gjs example using Babel and Rollup
- vala-object - Set of examples of how you can build native code with Vala and use it in Gjs, Node.js and other environments