tsickle

Tsickle - TypeScript to Closure Annotator

Tsickle processes TypeScript and adds Closure Compiler-compatible JSDoc annotations. This allows using TypeScript to transpile your sources, and then Closure Compiler to bundle and optimize them, while taking advantage of type information in Closure Compiler.

Installation

• Execute npm i to install the dependencies.

Usage

Project Setup

Tsickle works by wrapping tsc. To use it, you must set up your project such that it builds correctly when you run tsc from the command line, by configuring the settings in tsconfig.json.

If you have complicated tsc command lines and flags in a build file (like a gulpfile etc.) Tsickle won't know about it. Another reason it's nice to put everything in tsconfig.json is so your editor inherits all these settings as well.

Invocation

Run tsickle --help for the full syntax, but basically you provide any tsickle specific options and use it as a TypeScript compiler.

Development

Gulp tasks

• gulp watch executes the unit tests in watch mode (use gulp test.unit for a single run),
• gulp test.e2e executes the e2e tests,
• gulp test.check-format checks the source code formatting using clang-format,
• gulp test runs unit tests, e2e tests and checks the source code formatting.

Export the environment variable UPDATE_GOLDENS=1 to have the test suite rewrite the golden files when you run it.