ts-gir/README.md

generate typescript from gir

# ts-gir

[![GitHub stars](https://img.shields.io/github/stars/codejamninja/ts-gir.svg?style=social&label=Stars)](https://github.com/codejamninja/ts-gir)

> generate typescript from gir

Please ★ this repo if you found it useful ★ ★ ★

## Features

- supports gir
- supports typescript

## Installation

```sh
npm install -g ts-gir
```

## Dependencies

- [NodeJS](https://nodejs.org)

## Usage

```bash
ts-gir --help
generate typescript from gir

USAGE
  $ ts-gir

OPTIONS
  -d, --dir=dir        Output dir
  -h, --help           show CLI help
  -i, --inputs=inputs  (required) [default: /usr/share/gir-1.0/*.gir] Paths to GIR files to generate type definitions from (with wild card support)
  -m, --module=module
  -o, --output=output  Output basename, if not set, the namespace is used
  -s, --silent
  -v, --version        show CLI version
  --verbose
```

[Contribute](https://github.com/codejamninja/ts-gir/blob/master/CONTRIBUTING.md) usage docs

## Support

Submit an [issue](https://github.com/codejamninja/ts-gir/issues/new)

## Screenshots

[Contribute](https://github.com/codejamninja/ts-gir/blob/master/CONTRIBUTING.md) a screenshot

## Contributing

Review the [guidelines for contributing](https://github.com/codejamninja/ts-gir/blob/master/CONTRIBUTING.md)

## License

[MIT License](https://github.com/codejamninja/ts-gir/blob/master/LICENSE)

[Jam Risser](https://codejam.ninja) © 2019

## Changelog

Review the [changelog](https://github.com/codejamninja/ts-gir/blob/master/CHANGELOG.md)

## Credits

- [Jam Risser](https://codejam.ninja) - Author

## Support on Liberapay

A ridiculous amount of coffee ☕ ☕ ☕ was consumed in the process of building this project.

[Add some fuel](https://liberapay.com/codejamninja/donate) if you'd like to keep me going!

[![Liberapay receiving](https://img.shields.io/liberapay/receives/codejamninja.svg?style=flat-square)](https://liberapay.com/codejamninja/donate)
[![Liberapay patrons](https://img.shields.io/liberapay/patrons/codejamninja.svg?style=flat-square)](https://liberapay.com/codejamninja/donate)

## Related Projects

### TypeScript Type Definitions

- [ts-for-gjs](https://github.com/sammydre/ts-for-gjs)
- [node-gir-typedef](https://github.com/SolarLiner/node-gir-typedef)
- [gir2dts](https://github.com/darkoverlordofdata/gir2dts)
- [gir-dts-generator](https://github.com/Place1/gir-dts-generator)
- [gjs-ts](https://github.com/niagr/gjs-ts)
- [gjs-docs](https://github.com/apla/gjs-docs)

### Other

- [node-gtk](https://github.com/romgrk/node-gtk)
- [cgjs](https://github.com/cgjs/cgjs)
- [jsgtk](https://github.com/WebReflection/jsgtk)
- [vala-girs](https://github.com/nemequ/vala-girs)