typescript-closure-compiler

Patches the TypeScript compiler to generate JSDoc annotations

npm install typescript-closure-compiler
3 downloads in the last day
5 downloads in the last week
57 downloads in the last month

TypeScript Closure Compiler

This patches the TypeScript 0.9.1-1 compiler to generate JSDoc annotations ready for Google Closure Compiler. A demo is available online at http://evanw.github.io/typescript-closure-compiler/.

Usage

The patched version of the TypeScript compiler is available as tscc after installing globally with npm install -g typescript-closure-compiler. Substitute tsc with tscc in your build script. Note that the --module flag is not supported since the intent is to compile and optimize all code into one big bundle.

The patched compiler provides three additional flags that help generate better input for Google Closure Compiler. Compile-time defines can be explicitly set with the --define flag:

$ echo "var foo = 1;" > example.ts
$ tscc example.ts --define foo
$ cat example.js
/** @define {number} */ var foo = 1;

Constant annotations are automatically added with the --const flag. The constant detection pass only annotates non-instance variables with primitive types that are initialized and then never modified.

$ echo "var foo = 1;" > example.ts
$ tscc example.ts --const
$ cat example.js
/** @const {number} */ var foo = 1;

The --mangle flag attempts to mangle internal variable names to help disambiguate them from identical names in any extern files you may be using. Google Closure Compiler will not optimize properties with the same name as an extern, which means that code would otherwise never be compressed, inlined, or eliminated as dead code. Note that name mangling will only work on typed symbols so typing your code is required (use the --noImplicitAny flag). Unfortunately the --noImplicitAny flag doesn't quite work yet in 0.9.1-1 because type inference isn't fully implemented, but the development version of the compiler is looking much better and should hopefully be released soon.

$ echo "var foo = { length: 1 };" > example.ts
$ tscc example.ts --mangle
$ cat example.js
/** @type {?{ length$mangled: number }} */ var foo = { length$mangled: 1 };

License

Like the TypeScript compiler itself, this code is licensed under the Apache License 2.0.

npm loves you