Render documentation and relationships in the snapshot tests (#97)

* Add support to render relationships and docstrings in snapshots

* Fix a bug where we emitted empty documentation strings

Author: olafurpg

snapshots/output/multi-project/packages/a/src/index.ts

@@ -1,5 +1,6 @@
   export function a(): string {
 //                ^ definition @example/a 1.0.0 src/`index.ts`/a().
+//                documentation ```ts\n() => string\n```
     return ''
   }
 

snapshots/output/multi-project/packages/b/src/b.ts

@@ -3,6 +3,7 @@
 
   export function b() {
 //                ^ definition @example/b 1.0.0 src/`b.ts`/b().
+//                documentation ```ts\n() => string\n```
     return a()
 //         ^ reference @example/a 1.0.0 src/`index.ts`/a().
   }

snapshots/output/pure-js/src/main.js

@@ -1,6 +1,8 @@
   function fib(n) {
 //         ^^^ definition pure-js 1.0.0 src/`main.js`/fib().
+//         documentation ```ts\n(n: any) => any\n```
 //             ^ definition pure-js 1.0.0 src/`main.js`/fib().(n)
+//             documentation ```ts\nany\n```
     if (n <= 1) {
 //      ^ reference pure-js 1.0.0 src/`main.js`/fib().(n)
       return 0
@@ -14,7 +16,9 @@
 
   function print_fib(a) {
 //         ^^^^^^^^^ definition pure-js 1.0.0 src/`main.js`/print_fib().
+//         documentation ```ts\n(a: any) => void\n```
 //                   ^ definition pure-js 1.0.0 src/`main.js`/print_fib().(a)
+//                   documentation ```ts\nany\n```
     console.log(fib(a))
 //  ^^^^^^^ reference typescript 4.6.2 lib/`lib.dom.d.ts`/console.
 //  ^^^^^^^ reference @types/node 17.0.14 `globals.d.ts`/console.
@@ -28,53 +32,64 @@
 
   var y = 'Hello'
 //    ^ definition pure-js 1.0.0 src/`main.js`/y.
+//    documentation ```ts\nstring\n```
   function capture() {
 //         ^^^^^^^ definition pure-js 1.0.0 src/`main.js`/capture().
+//         documentation ```ts\n() => string\n```
     return y
 //         ^ reference pure-js 1.0.0 src/`main.js`/y.
   }
   const capture_lambda = () => {
 //      ^^^^^^^^^^^^^^ definition pure-js 1.0.0 src/`main.js`/capture_lambda.
+//      documentation ```ts\n() => string\n```
     return y
 //         ^ reference pure-js 1.0.0 src/`main.js`/y.
   }
 
   for (var i = 0; i <= 10; i++) {}
 //         ^ definition local 2
+//         documentation ```ts\nnumber\n```
 //                ^ reference local 2
 //                         ^ reference local 2
 
   for (const x of [1, 2, 3]) {
 //           ^ definition local 5
+//           documentation ```ts\nnumber\n```
   }
 
   var a = 0
 //    ^ definition pure-js 1.0.0 src/`main.js`/a.
+//    documentation ```ts\nnumber\n```
   var a = 1
 //    ^ definition pure-js 1.0.0 src/`main.js`/a.
+//    documentation ```ts\nnumber\n```
   print_fib(a)
 //^^^^^^^^^ reference pure-js 1.0.0 src/`main.js`/print_fib().
 //          ^ reference pure-js 1.0.0 src/`main.js`/a.
 //          ^ reference pure-js 1.0.0 src/`main.js`/a.
 
   function forever() {
 //         ^^^^^^^ definition pure-js 1.0.0 src/`main.js`/forever().
+//         documentation ```ts\n() => any\n```
     return forever()
 //         ^^^^^^^ reference pure-js 1.0.0 src/`main.js`/forever().
   }
 
   function use_before_def() {
 //         ^^^^^^^^^^^^^^ definition pure-js 1.0.0 src/`main.js`/use_before_def().
+//         documentation ```ts\n() => void\n```
     print_fib(n)
 //  ^^^^^^^^^ reference pure-js 1.0.0 src/`main.js`/print_fib().
 //            ^ reference local 8
     var n = 10
 //      ^ definition local 8
+//      documentation ```ts\nnumber\n```
 
     if (forever()) {
 //      ^^^^^^^ reference pure-js 1.0.0 src/`main.js`/forever().
       var m = 10
 //        ^ definition local 11
+//        documentation ```ts\nnumber\n```
     }
     print_fib(m)
 //  ^^^^^^^^^ reference pure-js 1.0.0 src/`main.js`/print_fib().
@@ -83,12 +98,15 @@
 
   function var_function_scope() {
 //         ^^^^^^^^^^^^^^^^^^ definition pure-js 1.0.0 src/`main.js`/var_function_scope().
+//         documentation ```ts\n() => void\n```
     var k = 0
 //      ^ definition local 14
+//      documentation ```ts\nnumber\n```
     if (forever()) {
 //      ^^^^^^^ reference pure-js 1.0.0 src/`main.js`/forever().
       var k = 1
 //        ^ definition local 14
+//        documentation ```ts\nnumber\n```
     }
     print_fib(k)
 //  ^^^^^^^^^ reference pure-js 1.0.0 src/`main.js`/print_fib().

snapshots/output/react/src/LoaderInput.tsx

@@ -4,16 +4,21 @@
   /** Takes loading prop, input component as child */
   interface Props {
 //          ^^^^^ definition react-example 1.0.0 src/`LoaderInput.tsx`/Props#
+//          documentation ```ts\nProps\n```
+//          documentation Takes loading prop, input component as child
     loading: boolean
 //  ^^^^^^^ definition react-example 1.0.0 src/`LoaderInput.tsx`/Props#loading.
+//  documentation ```ts\nboolean\n```
     children: React.ReactNode
 //  ^^^^^^^^ definition react-example 1.0.0 src/`LoaderInput.tsx`/Props#children.
+//  documentation ```ts\nReactNode\n```
 //            ^^^^^ reference @types/react 17.0.0 `index.d.ts`/React/
 //                  ^^^^^^^^^ reference @types/react 17.0.0 `index.d.ts`/React/ReactNode#
   }
 
   export const LoaderInput: React.FunctionComponent<Props> = ({
 //             ^^^^^^^^^^^ definition react-example 1.0.0 src/`LoaderInput.tsx`/LoaderInput.
+//             documentation ```ts\nFunctionComponent<Props>\n```
 //                          ^^^^^ reference @types/react 17.0.0 `index.d.ts`/React/
 //                                ^^^^^^^^^^^^^^^^^ reference @types/react 17.0.0 `index.d.ts`/React/FunctionComponent#
 //                                                  ^^^^^ reference react-example 1.0.0 src/`LoaderInput.tsx`/Props#
@@ -37,10 +42,12 @@
 
   export const LoaderInput2: React.FunctionComponent<Props> = props => {
 //             ^^^^^^^^^^^^ definition react-example 1.0.0 src/`LoaderInput.tsx`/LoaderInput2.
+//             documentation ```ts\nFunctionComponent<Props>\n```
 //                           ^^^^^ reference @types/react 17.0.0 `index.d.ts`/React/
 //                                 ^^^^^^^^^^^^^^^^^ reference @types/react 17.0.0 `index.d.ts`/React/FunctionComponent#
 //                                                   ^^^^^ reference react-example 1.0.0 src/`LoaderInput.tsx`/Props#
 //                                                            ^^^^^ definition local 6
+//                                                            documentation ```ts\nPropsWithChildren<Props>\n```
     return <LoaderInput loading={true} key="key" children={props.children} />
 //          ^^^^^^^^^^^ reference react-example 1.0.0 src/`LoaderInput.tsx`/LoaderInput.
 //                      ^^^^^^^ reference react-example 1.0.0 src/`LoaderInput.tsx`/Props#loading.

snapshots/output/react/src/MyTSXElement.tsx

@@ -3,9 +3,11 @@
 
   export interface MyProps {}
 //                 ^^^^^^^ definition react-example 1.0.0 src/`MyTSXElement.tsx`/MyProps#
+//                 documentation ```ts\nMyProps\n```
 
   export const MyTSXElement: React.FunctionComponent<MyProps> = ({}) => (<p></p>)
 //             ^^^^^^^^^^^^ definition react-example 1.0.0 src/`MyTSXElement.tsx`/MyTSXElement.
+//             documentation ```ts\nFunctionComponent<MyProps>\n```
 //                           ^^^^^ reference @types/react 17.0.0 `index.d.ts`/React/
 //                                 ^^^^^^^^^^^^^^^^^ reference @types/react 17.0.0 `index.d.ts`/React/FunctionComponent#
 //                                                   ^^^^^^^ reference react-example 1.0.0 src/`MyTSXElement.tsx`/MyProps#

snapshots/output/react/src/UseMyTSXElement.tsx

@@ -7,6 +7,7 @@
 
   export const _: React.FunctionComponent<MyProps> =
 //             ^ definition react-example 1.0.0 src/`UseMyTSXElement.tsx`/_.
+//             documentation ```ts\nFunctionComponent<MyProps>\n```
 //                ^^^^^ reference @types/react 17.0.0 `index.d.ts`/React/
 //                      ^^^^^^^^^^^^^^^^^ reference @types/react 17.0.0 `index.d.ts`/React/FunctionComponent#
 //                                        ^^^^^^^ reference react-example 1.0.0 src/`MyTSXElement.tsx`/MyProps#

snapshots/output/syntax/src/accessors.ts

@@ -1,63 +1,81 @@
   class C {
 //      ^ definition syntax 1.0.0 src/`accessors.ts`/C#
+//      documentation ```ts\nC\n```
     _length: number = 0
 //  ^^^^^^^ definition syntax 1.0.0 src/`accessors.ts`/C#_length.
+//  documentation ```ts\nnumber\n```
     get length(): number {
 //      ^^^^^^ definition syntax 1.0.0 src/`accessors.ts`/C#`<get>length`().
+//      documentation ```ts\nnumber\n```
       return this._length
 //                ^^^^^^^ reference syntax 1.0.0 src/`accessors.ts`/C#_length.
     }
     set length(value: number) {
 //      ^^^^^^ definition syntax 1.0.0 src/`accessors.ts`/C#`<get>length`().
+//      documentation ```ts\nnumber\n```
 //             ^^^^^ definition syntax 1.0.0 src/`accessors.ts`/C#`<set>length`().(value)
+//             documentation ```ts\nnumber\n```
       this._length = value
 //         ^^^^^^^ reference syntax 1.0.0 src/`accessors.ts`/C#_length.
 //                   ^^^^^ reference syntax 1.0.0 src/`accessors.ts`/C#`<set>length`().(value)
     }
 
     _capacity: number = 0
 //  ^^^^^^^^^ definition syntax 1.0.0 src/`accessors.ts`/C#_capacity.
+//  documentation ```ts\nnumber\n```
     get capacity(): number {
 //      ^^^^^^^^ definition syntax 1.0.0 src/`accessors.ts`/C#`<get>capacity`().
+//      documentation ```ts\nnumber\n```
       return this._capacity
 //                ^^^^^^^^^ reference syntax 1.0.0 src/`accessors.ts`/C#_capacity.
     }
   }
 
   export class D {
 //             ^ definition syntax 1.0.0 src/`accessors.ts`/D#
+//             documentation ```ts\nD\n```
     _length: number = 0
 //  ^^^^^^^ definition syntax 1.0.0 src/`accessors.ts`/D#_length.
+//  documentation ```ts\nnumber\n```
     public get length(): number {
 //             ^^^^^^ definition syntax 1.0.0 src/`accessors.ts`/D#`<get>length`().
+//             documentation ```ts\nnumber\n```
       return this._length
 //                ^^^^^^^ reference syntax 1.0.0 src/`accessors.ts`/D#_length.
     }
     public set length(value: number) {
 //             ^^^^^^ definition syntax 1.0.0 src/`accessors.ts`/D#`<get>length`().
+//             documentation ```ts\nnumber\n```
 //                    ^^^^^ definition syntax 1.0.0 src/`accessors.ts`/D#`<set>length`().(value)
+//                    documentation ```ts\nnumber\n```
       this._length = value
 //         ^^^^^^^ reference syntax 1.0.0 src/`accessors.ts`/D#_length.
 //                   ^^^^^ reference syntax 1.0.0 src/`accessors.ts`/D#`<set>length`().(value)
     }
 
     _capacity: number = 0
 //  ^^^^^^^^^ definition syntax 1.0.0 src/`accessors.ts`/D#_capacity.
+//  documentation ```ts\nnumber\n```
     public get capacity(): number {
 //             ^^^^^^^^ definition syntax 1.0.0 src/`accessors.ts`/D#`<get>capacity`().
+//             documentation ```ts\nnumber\n```
       return this._capacity
 //                ^^^^^^^^^ reference syntax 1.0.0 src/`accessors.ts`/D#_capacity.
     }
     private set capacity(value: number) {
 //              ^^^^^^^^ definition syntax 1.0.0 src/`accessors.ts`/D#`<get>capacity`().
+//              documentation ```ts\nnumber\n```
 //                       ^^^^^ definition syntax 1.0.0 src/`accessors.ts`/D#`<set>capacity`().(value)
+//                       documentation ```ts\nnumber\n```
       this._capacity = value
 //         ^^^^^^^^^ reference syntax 1.0.0 src/`accessors.ts`/D#_capacity.
 //                     ^^^^^ reference syntax 1.0.0 src/`accessors.ts`/D#`<set>capacity`().(value)
     }
     public unsafeSetCapacity(value: number): void {
 //         ^^^^^^^^^^^^^^^^^ definition syntax 1.0.0 src/`accessors.ts`/D#unsafeSetCapacity().
+//         documentation ```ts\n(value: number) => void\n```
 //                           ^^^^^ definition syntax 1.0.0 src/`accessors.ts`/D#unsafeSetCapacity().(value)
+//                           documentation ```ts\nnumber\n```
       this.capacity = value
 //         ^^^^^^^^ reference syntax 1.0.0 src/`accessors.ts`/D#`<get>capacity`().
 //         ^^^^^^^^ reference syntax 1.0.0 src/`accessors.ts`/D#`<set>capacity`().
@@ -67,12 +85,16 @@
 
   function g(_: number): void {}
 //         ^ definition syntax 1.0.0 src/`accessors.ts`/g().
+//         documentation ```ts\n(_: number) => void\n```
 //           ^ definition syntax 1.0.0 src/`accessors.ts`/g().(_)
+//           documentation ```ts\nnumber\n```
 
   function f() {
 //         ^ definition syntax 1.0.0 src/`accessors.ts`/f().
+//         documentation ```ts\n() => void\n```
     const c = new C()
 //        ^ definition local 2
+//        documentation ```ts\nC\n```
 //                ^ reference syntax 1.0.0 src/`accessors.ts`/C#
     c.length = 10
 //  ^ reference local 2
@@ -95,6 +117,7 @@
 
     const d = new D()
 //        ^ definition local 5
+//        documentation ```ts\nD\n```
 //                ^ reference syntax 1.0.0 src/`accessors.ts`/D#
     d.length = 0
 //  ^ reference local 5

snapshots/output/syntax/src/class.ts

@@ -1,44 +1,57 @@
   export class Class {
 //             ^^^^^ definition syntax 1.0.0 src/`class.ts`/Class#
+//             documentation ```ts\nClass\n```
     public classProperty: string
 //         ^^^^^^^^^^^^^ definition syntax 1.0.0 src/`class.ts`/Class#classProperty.
+//         documentation ```ts\nstring\n```
     constructor(constructorParam: string) {
 //              ^^^^^^^^^^^^^^^^ definition syntax 1.0.0 src/`class.ts`/Class#`<constructor>`().(constructorParam)
+//              documentation ```ts\nstring\n```
       this.classProperty = constructorParam
 //         ^^^^^^^^^^^^^ reference syntax 1.0.0 src/`class.ts`/Class#classProperty.
 //                         ^^^^^^^^^^^^^^^^ reference syntax 1.0.0 src/`class.ts`/Class#`<constructor>`().(constructorParam)
     }
     public method(methodParam: string): string {
 //         ^^^^^^ definition syntax 1.0.0 src/`class.ts`/Class#method().
+//         documentation ```ts\n(methodParam: string) => string\n```
 //                ^^^^^^^^^^^ definition syntax 1.0.0 src/`class.ts`/Class#method().(methodParam)
+//                documentation ```ts\nstring\n```
       return this.privateMethod(methodParam)
 //                ^^^^^^^^^^^^^ reference syntax 1.0.0 src/`class.ts`/Class#privateMethod().
 //                              ^^^^^^^^^^^ reference syntax 1.0.0 src/`class.ts`/Class#method().(methodParam)
     }
     public static staticMethod(methodParam: string): string {
 //                ^^^^^^^^^^^^ definition syntax 1.0.0 src/`class.ts`/Class#staticMethod().
+//                documentation ```ts\n(methodParam: string) => string\n```
 //                             ^^^^^^^^^^^ definition syntax 1.0.0 src/`class.ts`/Class#staticMethod().(methodParam)
+//                             documentation ```ts\nstring\n```
       return methodParam
 //           ^^^^^^^^^^^ reference syntax 1.0.0 src/`class.ts`/Class#staticMethod().(methodParam)
     }
     private privateMethod(methodParam: string): string {
 //          ^^^^^^^^^^^^^ definition syntax 1.0.0 src/`class.ts`/Class#privateMethod().
+//          documentation ```ts\n(methodParam: string) => string\n```
 //                        ^^^^^^^^^^^ definition syntax 1.0.0 src/`class.ts`/Class#privateMethod().(methodParam)
+//                        documentation ```ts\nstring\n```
       return methodParam
 //           ^^^^^^^^^^^ reference syntax 1.0.0 src/`class.ts`/Class#privateMethod().(methodParam)
     }
   }
 
   export function newClass(param: string): string {
 //                ^^^^^^^^ definition syntax 1.0.0 src/`class.ts`/newClass().
+//                documentation ```ts\n(param: string) => string\n```
 //                         ^^^^^ definition syntax 1.0.0 src/`class.ts`/newClass().(param)
+//                         documentation ```ts\nstring\n```
     const instance = new Class(param).classProperty
 //        ^^^^^^^^ definition local 2
+//        documentation ```ts\nstring\n```
 //                       ^^^^^ reference syntax 1.0.0 src/`class.ts`/Class#
 //                             ^^^^^ reference syntax 1.0.0 src/`class.ts`/newClass().(param)
 //                                    ^^^^^^^^^^^^^ reference syntax 1.0.0 src/`class.ts`/Class#classProperty.
     const instance2 = Class.staticMethod(param)
 //        ^^^^^^^^^ definition local 5
+//        documentation ```ts\nstring\n```
 //                    ^^^^^ reference syntax 1.0.0 src/`class.ts`/Class#
 //                          ^^^^^^^^^^^^ reference syntax 1.0.0 src/`class.ts`/Class#staticMethod().
 //                                       ^^^^^ reference syntax 1.0.0 src/`class.ts`/newClass().(param)

snapshots/output/syntax/src/enum.ts

@@ -1,13 +1,17 @@
   export enum Enum {
 //            ^^^^ definition syntax 1.0.0 src/`enum.ts`/Enum#
+//            documentation ```ts\nEnum\n```
     A,
 //  ^ definition syntax 1.0.0 src/`enum.ts`/Enum#A.
+//  documentation ```ts\nEnum.A\n```
     B,
 //  ^ definition syntax 1.0.0 src/`enum.ts`/Enum#B.
+//  documentation ```ts\nEnum.B\n```
   }
 
   export function newEnum(): Enum {
 //                ^^^^^^^ definition syntax 1.0.0 src/`enum.ts`/newEnum().
+//                documentation ```ts\n() => Enum\n```
 //                           ^^^^ reference syntax 1.0.0 src/`enum.ts`/Enum#
     return Enum.A
 //         ^^^^ reference syntax 1.0.0 src/`enum.ts`/Enum#

snapshots/output/syntax/src/function.ts

@@ -1,3 +1,4 @@
   export function newFunction(): void {}
 //                ^^^^^^^^^^^ definition syntax 1.0.0 src/`function.ts`/newFunction().
+//                documentation ```ts\n() => void\n```