Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gjsify/ts-for-gir
TypeScript type definition generator for GObject introspection interfaces
https://github.com/gjsify/ts-for-gir
dts gir gjs glib gnome gobject gobject-introspection gtk node-gtk typescript
Last synced: 3 days ago
JSON representation
TypeScript type definition generator for GObject introspection interfaces
- Host: GitHub
- URL: https://github.com/gjsify/ts-for-gir
- Owner: gjsify
- License: apache-2.0
- Created: 2017-06-13T21:18:02.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-01-22T11:22:21.000Z (20 days ago)
- Last Synced: 2025-02-03T10:43:42.239Z (8 days ago)
- Topics: dts, gir, gjs, glib, gnome, gobject, gobject-introspection, gtk, node-gtk, typescript
- Language: TypeScript
- Homepage: https://gjsify.org/pages/projects
- Size: 169 MB
- Stars: 250
- Watchers: 11
- Forks: 20
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
- stars - gjsify/ts-for-gir
README
TS for GIR
TypeScript type definition generator for GObject introspection GIR files
`ts-for-gir` is a robust [TypeScript](https://www.typescriptlang.org/) type definitions generator that improves the development experience of [GJS](https://gitlab.gnome.org/GNOME/gjs/) projects. It has been completely rewritten over time to provide a more complete and accurate TypeScript representation of the [GObject introspection](https://gi.readthedocs.io/en/latest/) interfaces. With `ts-for-gir`, developers can now benefit from TypeScript's strong typing and improved code navigation, making it easier to build robust and powerful applications with GJS.
# Branch 'main' - Next Version
You are on the `main` branch. This are the next features of `ts-for-gir` v4.x where `ts-for-gir` is merged with [gi.ts](https://github.com/gjsify/gi.ts).
`main` branch: https://github.com/gjsify/ts-for-gir/tree/main
`3.x` branch: https://github.com/gjsify/ts-for-gir/tree/3.x
## Getting Started
Install the latest LTS version of Node.js. We recommend using [NVM](https://github.com/nvm-sh/nvm) for this purpose. After Node.js has been installed, `ts-for-gir` can be executed with the following command:
```bash
npx @ts-for-gir/cli --help
```
That's it, you can start generating your types 👩💻☕
## NPM packages
If you are only interested in the types and do not want to generate them yourself, you can use our pre-generated NPM packages. For example, if you want to develop a Gtk4 application with GJS, it is enough to install the corresponding NPM packages:
```bash
npm install @girs/gjs @girs/gtk-4.0 --save
```
```ts
import '@girs/gjs'
import '@girs/gjs/dom'
import '@girs/gtk-4.0'
import Gtk from 'gi://Gtk?version=4.0';
const button = new Gtk.Button();
```
All pre-generated NPM packages can be found on [gjsify/types](https://github.com/gjsify/types).
> You want your or any other missing GObject introspection based library types to be published on NPM for every release? Then feel free to create an issue for it, we will be happy to include it.
## Maintainer wanted for node-gtk maintenance
Version 3.x has working [node-gtk](https://github.com/romgrk/node-gtk) support. This is currently not planned for version 4.x. We ourselves want to focus on GJS support. However, if there is a need in the community to maintain node-gtk support, then we are looking for a maintainer for that. Feel free to get in touch 🤓
## Further information
[Examples](/examples/README.md) - Take a look at many different examples to see how you can use TypeScript with different bundlers.
[CLI](/packages/cli/README.md) - Learn about the CLI options and what to keep in mind when using them.
[Development](/DEVELOPMENT.md) - Learn how you can contribute to this project.
[gjsify/types](https://github.com/gjsify/types) - Pre-generated NPM packages that you can use directly without needing ts-for-gir for it.
[GNOME Shell Extension Types](https://github.com/gjsify/gnome-shell) - Very experimental additional hand written type definitions for GNOME Shell Extensions.