mirror of
https://github.com/bendtherules/Typescript.tools.git
synced 2026-08-18 13:51:55 +00:00
46 lines
2.7 KiB
Markdown
46 lines
2.7 KiB
Markdown
# Typescript.tools
|
|
|
|
### Collection of resources related to Typescript compiler api (and related things)
|
|
|
|
TSC = Typescript compiler
|
|
|
|
## AST Playground
|
|
|
|
1. [ASTExplorer](https://astexplorer.net/#/gist/84d8957b9cf1e9e9f0cdda496755c52e/latest) - Shows AST returned by TSC parser. Very useful.
|
|
|
|
2. [TypeScript AST Viewer](https://ts-ast-viewer.com) - SImilar to ASTExplorer, but custom made for Typescript. Very useful for checking symbols (not shown in ASTExplorer).
|
|
|
|
## Reading and examples
|
|
|
|
1. [Typescript Architectural Overview](https://github.com/microsoft/TypeScript/wiki/Architectural-Overview) - Explains how all the different parts of TS are connected together. Also defines the common terminologies.
|
|
|
|
2. [Typescript compiler wiki page](https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API) - Example code to use diff parts of TS. Show boilerplate code and some example.
|
|
|
|
*More services covered, less depth.*
|
|
|
|
3. [Typescript Deep Dive by Basarat](https://basarat.gitbook.io/typescript/overview) - Good introduction to various parts of TSC api.
|
|
|
|
*Gives the initial hints and basic concept of many apis, but often doesn't show full examples or connect the different parts it is describing. Feels like a developer's note.*
|
|
|
|
4. [Typescript Transformer Handbook](https://github.com/madou/typescript-transformer-handbook) - Lots of links and examples on how to write custom transformer. More of complete working examples, less theory. Same techniques apply for using TSC api directly.
|
|
|
|
## Wrappers and utils
|
|
|
|
1. [ts-morph](https://github.com/dsherret/ts-morph) - Easier and nicer abstraction layer on top of TS internals. Exposes underlying constructs for advanced usecases.
|
|
|
|
*Slower startup due to extra initial overhead.*
|
|
|
|
2. [byots](https://github.com/basarat/byots) - Modified version of Typescript lib, which exposes more internal apis. Matching releases are created automatically.
|
|
|
|
*TS has anyway opened up more apis, is it worth using anymore ??*
|
|
|
|
3. [ttypescript](https://github.com/cevek/ttypescript) - TSC drop-in replacement which supports passing custom transformers as cmdline argument.
|
|
|
|
## Tools built using it
|
|
|
|
1. Typescript language service plugin in VS Code (inbuilt), [atom](https://github.com/TypeStrong/atom-typescript), [Sublime Text](https://github.com/Microsoft/TypeScript-Sublime-Plugin) - Supports similar feature set in multiple editors
|
|
|
|
2. Typedoc - Very popular Typescript documentation generator which extracts type definitions and inline jsdoc comments into separate documents.
|
|
|
|
3. [shameless plug] [webpack-strip-log-loader](https://github.com/bendtherules/webpack-strip-log-loader) - webpack plugin to remove some module (or symbol) and their usages recursively in a project. Uses TSC api internally.
|