mini-typescript

A miniature model of the Typescript compiler, intended to teach the structure of the real Typescript compiler

I started this project as part of reading Modern Compiler Implementation in ML because I wanted to learn more about compiler backends. When I started building the example compiler I found I disagreed with the implementation of nearly everything in the frontend. So I wrote my own, and found that I had just written a small Typescript.

I realised a small Typescript would be useful to others who want to learn how the Typescript compiler works. So I rewrote it in Typescript and added some exercises to let you practise with it. The resulting compiler covers a tiny slice of Typescript: just var declarations, assignments and numeric literals. The only two types are string and number.

To get set up

git clone https://github.com/sandersn/mini-typescript
cd mini-typescript
code .

# Get set up
npm i
npm run build

# Or have your changes instantly happen
npm run build --watch

# Run the compiler:
npm run mtsc ./tests/singleVar.ts

Limitations

1. This is an example of the way that Typescript's compiler does things. A compiler textbook will help you learn compilers. This project will help you learn Typescript's code.
2. This is only a tiny slice of the language, also unlike a textbook. Often I only put it one instance of a thing, like nodes that introduce a scope, to keep the code size small.
3. There is no laziness, caching or node reuse, so the checker and transformer code do not teach you those aspects of the design.
4. There's no surrounding infrastructure, like a language service or a program builder. This is just a model of tsc.

Exercises

• Add EmptyStatement (imteekay/mini-typescript#2).
• Make semicolon a statement ender, not statement separator (https://github.com/imteekay/mini-typescript/pull/7).
  • Hint: You'll need a predicate to peek at the next token and decide if it's the start of an element.
  • Bonus: Switch from semicolon to newline as statement ender.
• Add string literals (imteekay/mini-typescript#4).
• Refactor: rename Literal to NumericLiteral (imteekay/mini-typescript#6).
• Add support for the lexer to report errors
  • report unterminated string literal error
• Add let (https://github.com/imteekay/mini-typescript/pull/8).
  • Make sure the binder resolves variables declared with var and let the same way. The simplest way is to add a kind property to Symbol.
  • Add use-before-declaration errors in the checker.
  • Finally, add an ES2015 -> ES5 transform that transforms let to var.
• Allow var statements to declare multiple symbols (https://github.com/imteekay/mini-typescript/pull/9).
• Allow var to have multiple declarations.
  • You'll need to convert a Symbol's declaration into a list.
  • Check that all declarations have the same type.
• Add objects and object types.
  • Implement mapped types
  • Implement optional member
  • Implement method signature
• Add interface.
  • Make sure the binder resolves types declared with type and interface the same way.
  • After the basics are working, allow interface to have multiple declarations.
  • Interfaces should have an object type, but that object type should combine the properties from every declaration.
• Implement union types
• Add an ES5 transformer that converts let -> var.
• Add function declarations and function calls.
• Add arrow functions with an appropriate transform in ES5.