Giter Club home page Giter Club logo

glint's Introduction

Glint CI

TypeScript-powered tooling for Glimmer templates.

Overview

Glint is a set of tools to aid in developing code that uses the Glimmer VM for rendering, such as Ember.js v3.24+ and GlimmerX projects. Similar to Vetur for Vue projects or Svelte Language Tools, Glint consists of a CLI and a language server to provide feedback and enforce correctness both locally during editing and project-wide in CI.

Getting Started

Glint is broken into several different packages that you may use, depending on the details of your project. Typically you'll add @glint/core, @glint/template and a Glint environment package that reflects the type of project you're working on, then add a "glint" key to your tsconfig.json that tells Glint what it should look at.

For more specific details on setting up Glint in your project, take a look at the documentation, in particular the Installation pages for Ember.js projects and for GlimmerX projects.

Using Glint

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.

glint being run at a terminal and producing a tsc-style type error for a template file

You can use the glint executable in CI to ensure you maintain type safety in your templates. You can also use the glint command locally with the --watch flag to monitor your project as you work!

Similarly, glint-language-server can be used by editor integrations to expose that same information inline as you type.

a TypeScript-style type error being shown inline for a template file

The language server can also enable your editor to provide other richer help, such as type information on hover, automated refactoring, and more. See the VS Code extension README for further examples.

Debugging Glint

See CONTRIBUTING.md for instructions on how to run and debug the Glint language server and VSCode extension locally.

glint's People

Contributors

bitwolfe avatar boris-petrov avatar boussonkarel avatar bwbuchanan avatar cafreeman avatar camerondubas avatar chadhietala avatar chriskrycho avatar dependabot[bot] avatar dfreeman avatar ef4 avatar erinsinger93 avatar evoactivity avatar gitkrystan avatar heroiceric avatar ignacemaes avatar jamescdavis avatar lancestasinski avatar lukasnys avatar lukemelia avatar machty avatar nullvoxpopuli avatar nwhittaker avatar patricklx avatar sergeastapov avatar simonihmig avatar tragiclifestories avatar wagenet avatar wtype avatar yratanov avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.