Getting Started
First, add
@glint/core, @glint/template and an appropriate Glint environment to your project's devDependencies.Then, add a
"glint" key in your tsconfig.json that tells Glint what environment you're working in and, optionally, which files it should include in its typechecking.See the Configuration page for more details about options you can specify under the
"glint" key. For setup instructions specific to your project type, check out the links below:The
@glint/core package includes two executables: glint and glint-language-server.The
glint CLI can be used to typecheck your project in a similar manner to tsc, but with understanding of how values flow through templates.
A tsc-style template type error in the terminal
You can use the
glint executable in CI to ensure you maintain type safety in your templates.For example, in GitHub Actions you might change this:
- name: Typecheck
run: npx tsc --noEmit
To this:
- name: Typecheck
run: npx glint
You can also use the
glint command locally with the --watch flag to monitor your project as you work!You can install an editor extension to display Glint's diagnostics inline in your templates and provide richer editor support—typechecking, type information on hover, automated refactoring, and more—powered by
glint-language-server:
A type error being shown inline for a template file in VS Code
Last modified 1mo ago