UNPKG

alm

Version:

The best IDE for TypeScript

github.com/alm-tools/alm

alm-tools/alm

18 lines (11 loc) • 965 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# About this folder This the backend to generate the live documentation for a TypeScript project. ## Basic overview We start at each source file. * If its a module we create a new module entry. * If not we add its stuff to the `global` module entry. There are different transformers: Stuff that takes a TypeScript AST `Node` and gives you `DocumentedType`. We just start at a source file and only visit the stuff we consider important for documentation purposes 🌹 ## Helper functions from ts There are quite a few helper functions in the TypeScript compiler. I have found exploring `getQuickInfo` and `getNavigateToItems` in `services.ts` to be amongst the best places to look for *that magic function*. ## Getting line/ch We pass the SourceFile around to use `ts.getLineAndCharacterOfPosition` which takes a `ts.SourceFile` and a position to return 'line,ch'. Internally this function only computes line starts for a SourceFile *once* so its pretty fast.