summaryrefslogtreecommitdiff
path: root/docs/guide/typescript/installation.md
blob: 0c193251119cc663eee04ae088bb52a1fecd5990 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Installation

It is recommended to use [AGS](https://aylur.github.io/ags/)
to scaffold and run projects in TypeScript.

It lets you

- generate TypeScript types using [ts-for-gir](https://github.com/gjsify/ts-for-gir)
- generate a tsconfig which is used by LSPs to provide intellisense
- bundle your TypeScript and JavaScript code using [esbuild](https://esbuild.github.io/)

:::details Trivia
AGS is the predecessor of Astal, which was written purely in TypeScript and so only supported
JavaScript/TypeScript. Now it serves as a scaffolding tool for Astal+TypeScript projects.
:::

## Setting up a project

🚧 Setting up a dev environment without AGS is not yet documented. 🚧