test: Re-use snapshot formatting from scip-python (#306)

Co-authored-by: Titouan Launay <[email protected]>

Author: varungandhi-src

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

@@ -1,3 +1,5 @@
+// format-options: showDocs
+
 export function a(): string {
   return ''
 }

snapshots/output/invalid-package-json/packages/a/src/a.ts

@@ -1,8 +1,7 @@
-  export function a(): string {
-// definition @example/a HEAD src/`a.ts`/
-//documentation ```ts\nmodule "a.ts"\n```
-//                ^ definition @example/a HEAD src/`a.ts`/a().
-//                documentation ```ts\nfunction a(): string\n```
-    return ''
-  }
-  
+// < definition @example/a HEAD src/`a.ts`/
+
+export function a(): string {
+//              ^ definition @example/a HEAD src/`a.ts`/a().
+  return ''
+}
+

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

@@ -1,8 +1,15 @@
-  export function a(): string {
-// definition @example/a 1.0.0 src/`index.ts`/
-//documentation ```ts\nmodule "index.ts"\n```
-//                ^ definition @example/a 1.0.0 src/`index.ts`/a().
-//                documentation ```ts\nfunction a(): string\n```
-    return ''
-  }
-  
+// < definition @example/a 1.0.0 src/`index.ts`/
+//documentation ```ts
+//            > module "index.ts"
+//            > ```
+
+// format-options: showDocs
+
+export function a(): string {
+//              ^ definition @example/a 1.0.0 src/`index.ts`/a().
+//              documentation ```ts
+//                          > function a(): string
+//                          > ```
+  return ''
+}
+

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

@@ -1,13 +1,12 @@
-  import { a } from '@example/a/src'
-// definition @example/b 1.0.0 src/`b.ts`/
-//documentation ```ts\nmodule "b.ts"\n```
-//         ^ reference @example/a 1.0.0 src/`index.ts`/a().
-//                  ^^^^^^^^^^^^^^^^ reference @example/a 1.0.0 src/`index.ts`/
-  
-  export function b() {
-//                ^ definition @example/b 1.0.0 src/`b.ts`/b().
-//                documentation ```ts\nfunction b(): string\n```
-    return a()
-//         ^ reference @example/a 1.0.0 src/`index.ts`/a().
-  }
-  
+// < definition @example/b 1.0.0 src/`b.ts`/
+
+import { a } from '@example/a/src'
+//       ^ reference @example/a 1.0.0 src/`index.ts`/a().
+//                ^^^^^^^^^^^^^^^^ reference @example/a 1.0.0 src/`index.ts`/
+
+export function b() {
+//              ^ definition @example/b 1.0.0 src/`b.ts`/b().
+  return a()
+//       ^ reference @example/a 1.0.0 src/`index.ts`/a().
+}
+

snapshots/output/pnpm-workspaces/packages/a/src/a.ts

@@ -1,8 +1,7 @@
-  export function a(): string {
-// definition @example/a 1.0.0 src/`a.ts`/
-//documentation ```ts\nmodule "a.ts"\n```
-//                ^ definition @example/a 1.0.0 src/`a.ts`/a().
-//                documentation ```ts\nfunction a(): string\n```
-    return ''
-  }
-  
+// < definition @example/a 1.0.0 src/`a.ts`/
+
+export function a(): string {
+//              ^ definition @example/a 1.0.0 src/`a.ts`/a().
+  return ''
+}
+

snapshots/output/pnpm-workspaces/packages/b/src/b.ts

@@ -1,13 +1,12 @@
-  import { a } from '@example/a'
-// definition @example/b 1.0.0 src/`b.ts`/
-//documentation ```ts\nmodule "b.ts"\n```
-//         ^ reference @example/a 1.0.0 src/`a.ts`/a().
-//                  ^^^^^^^^^^^^ reference @example/a 1.0.0 src/`a.ts`/
-  
-  export function b() {
-//                ^ definition @example/b 1.0.0 src/`b.ts`/b().
-//                documentation ```ts\nfunction b(): string\n```
-    return a()
-//         ^ reference @example/a 1.0.0 src/`a.ts`/a().
-  }
-  
+// < definition @example/b 1.0.0 src/`b.ts`/
+
+import { a } from '@example/a'
+//       ^ reference @example/a 1.0.0 src/`a.ts`/a().
+//                ^^^^^^^^^^^^ reference @example/a 1.0.0 src/`a.ts`/
+
+export function b() {
+//              ^ definition @example/b 1.0.0 src/`b.ts`/b().
+  return a()
+//       ^ reference @example/a 1.0.0 src/`a.ts`/a().
+}
+

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

@@ -1,117 +1,99 @@
-  function fib(n) {
-// definition pure-js 1.0.0 src/`main.js`/
-//documentation ```ts\nmodule "main.js"\n```
-//         ^^^ definition pure-js 1.0.0 src/`main.js`/fib().
-//         documentation ```ts\nfunction fib(n: any): any\n```
-//             ^ definition pure-js 1.0.0 src/`main.js`/fib().(n)
-//             documentation ```ts\n(parameter) n: any\n```
-    if (n <= 1) {
-//      ^ reference pure-js 1.0.0 src/`main.js`/fib().(n)
-      return 0
-    }
-    return fib(n - 1) + fib(n - 2)
-//         ^^^ reference pure-js 1.0.0 src/`main.js`/fib().
-//             ^ reference pure-js 1.0.0 src/`main.js`/fib().(n)
-//                      ^^^ reference pure-js 1.0.0 src/`main.js`/fib().
-//                          ^ reference pure-js 1.0.0 src/`main.js`/fib().(n)
+// < definition pure-js 1.0.0 src/`main.js`/
+
+function fib(n) {
+//       ^^^ definition pure-js 1.0.0 src/`main.js`/fib().
+//           ^ definition pure-js 1.0.0 src/`main.js`/fib().(n)
+  if (n <= 1) {
+//    ^ reference pure-js 1.0.0 src/`main.js`/fib().(n)
+    return 0
   }
-  
-  function print_fib(a) {
-//         ^^^^^^^^^ definition pure-js 1.0.0 src/`main.js`/print_fib().
-//         documentation ```ts\nfunction print_fib(a: any): void\n```
-//                   ^ definition pure-js 1.0.0 src/`main.js`/print_fib().(a)
-//                   documentation ```ts\n(parameter) a: any\n```
-    console.log(fib(a))
-//  ^^^^^^^ reference typescript 5.3.3 lib/`lib.dom.d.ts`/console.
-//  ^^^^^^^ reference @types/node 20.10.5 `globals.d.ts`/global/console.
-//  ^^^^^^^ reference @types/node 20.10.5 `console.d.ts`/`"node:console"`/global/console/
-//  ^^^^^^^ reference @types/node 20.10.5 `console.d.ts`/`"node:console"`/global/console.
-//          ^^^ reference typescript 5.3.3 lib/`lib.dom.d.ts`/Console#log().
-//          ^^^ reference @types/node 20.10.5 `console.d.ts`/`"node:console"`/global/Console#log().
-//              ^^^ reference pure-js 1.0.0 src/`main.js`/fib().
-//                  ^ reference pure-js 1.0.0 src/`main.js`/print_fib().(a)
-  }
-  
-  var y = 'Hello'
-//    ^ definition pure-js 1.0.0 src/`main.js`/y.
-//    documentation ```ts\nvar y: string\n```
-  function capture() {
-//         ^^^^^^^ definition pure-js 1.0.0 src/`main.js`/capture().
-//         documentation ```ts\nfunction capture(): 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\nvar capture_lambda: () => 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\nvar i: number\n```
-//                ^ reference local 2
-//                         ^ reference local 2
-  
-  for (const x of [1, 2, 3]) {
-//           ^ definition local 5
-//           documentation ```ts\nvar x: number\n```
-  }
-  
-  var a = 0
-//    ^ definition pure-js 1.0.0 src/`main.js`/a.
-//    documentation ```ts\nvar a: number\n```
-  var a = 1
-//    ^ definition pure-js 1.0.0 src/`main.js`/a.
-//    documentation ```ts\nvar a: number\n```
-  print_fib(a)
+  return fib(n - 1) + fib(n - 2)
+//       ^^^ reference pure-js 1.0.0 src/`main.js`/fib().
+//           ^ reference pure-js 1.0.0 src/`main.js`/fib().(n)
+//                    ^^^ reference pure-js 1.0.0 src/`main.js`/fib().
+//                        ^ reference pure-js 1.0.0 src/`main.js`/fib().(n)
+}
+
+function print_fib(a) {
+//       ^^^^^^^^^ definition pure-js 1.0.0 src/`main.js`/print_fib().
+//                 ^ definition pure-js 1.0.0 src/`main.js`/print_fib().(a)
+  console.log(fib(a))
+//^^^^^^^ reference typescript 5.3.3 lib/`lib.dom.d.ts`/console.
+//^^^^^^^ reference @types/node 20.10.5 `globals.d.ts`/global/console.
+//^^^^^^^ reference @types/node 20.10.5 `console.d.ts`/`"node:console"`/global/console/
+//^^^^^^^ reference @types/node 20.10.5 `console.d.ts`/`"node:console"`/global/console.
+//        ^^^ reference typescript 5.3.3 lib/`lib.dom.d.ts`/Console#log().
+//        ^^^ reference @types/node 20.10.5 `console.d.ts`/`"node:console"`/global/Console#log().
+//            ^^^ reference pure-js 1.0.0 src/`main.js`/fib().
+//                ^ reference pure-js 1.0.0 src/`main.js`/print_fib().(a)
+}
+
+var y = 'Hello'
+//  ^ definition pure-js 1.0.0 src/`main.js`/y.
+function capture() {
+//       ^^^^^^^ definition pure-js 1.0.0 src/`main.js`/capture().
+  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.
+  return y
+//       ^ reference pure-js 1.0.0 src/`main.js`/y.
+}
+
+for (var i = 0; i <= 10; i++) {}
+//       ^ definition local 2
+//              ^ reference local 2
+//                       ^ reference local 2
+
+for (const x of [1, 2, 3]) {
+//         ^ definition local 5
+}
+
+var a = 0
+//  ^ definition pure-js 1.0.0 src/`main.js`/a.
+var a = 1
+//  ^ definition pure-js 1.0.0 src/`main.js`/a.
+print_fib(a)
+//^^^^^^^^ reference pure-js 1.0.0 src/`main.js`/print_fib().
+//        ^ reference pure-js 1.0.0 src/`main.js`/a.
+
+function forever() {
+//       ^^^^^^^ definition pure-js 1.0.0 src/`main.js`/forever().
+  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().
+  print_fib(n)
 //^^^^^^^^^ reference pure-js 1.0.0 src/`main.js`/print_fib().
-//          ^ reference pure-js 1.0.0 src/`main.js`/a.
-  
-  function forever() {
-//         ^^^^^^^ definition pure-js 1.0.0 src/`main.js`/forever().
-//         documentation ```ts\nfunction forever(): never\n```
-    return forever()
-//         ^^^^^^^ reference pure-js 1.0.0 src/`main.js`/forever().
+//          ^ reference local 8
+  var n = 10
+//    ^ definition local 8
+
+  if (forever()) {
+//    ^^^^^^^ reference pure-js 1.0.0 src/`main.js`/forever().
+    var m = 10
+//      ^ definition local 11
   }
-  
-  function use_before_def() {
-//         ^^^^^^^^^^^^^^ definition pure-js 1.0.0 src/`main.js`/use_before_def().
-//         documentation ```ts\nfunction use_before_def(): 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\nvar n: number\n```
-  
-    if (forever()) {
-//      ^^^^^^^ reference pure-js 1.0.0 src/`main.js`/forever().
-      var m = 10
-//        ^ definition local 11
-//        documentation ```ts\nvar m: number\n```
-    }
-    print_fib(m)
-//  ^^^^^^^^^ reference pure-js 1.0.0 src/`main.js`/print_fib().
-//            ^ reference local 11
-  }
-  
-  function var_function_scope() {
-//         ^^^^^^^^^^^^^^^^^^ definition pure-js 1.0.0 src/`main.js`/var_function_scope().
-//         documentation ```ts\nfunction var_function_scope(): void\n```
-    var k = 0
-//      ^ definition local 14
-//      documentation ```ts\nvar k: number\n```
-    if (forever()) {
-//      ^^^^^^^ reference pure-js 1.0.0 src/`main.js`/forever().
-      var k = 1
-//        ^ definition local 17
-//        documentation ```ts\nvar k: number\n```
-    }
-    print_fib(k)
-//  ^^^^^^^^^ reference pure-js 1.0.0 src/`main.js`/print_fib().
-//            ^ reference local 14
-//            ^ reference local 17
+  print_fib(m)
+//^^^^^^^^^ reference pure-js 1.0.0 src/`main.js`/print_fib().
+//          ^ reference local 11
+}
+
+function var_function_scope() {
+//       ^^^^^^^^^^^^^^^^^^ definition pure-js 1.0.0 src/`main.js`/var_function_scope().
+  var k = 0
+//    ^ definition local 14
+  if (forever()) {
+//    ^^^^^^^ reference pure-js 1.0.0 src/`main.js`/forever().
+    var k = 1
+//      ^ definition local 17
   }
-  
+  print_fib(k)
+//^^^^^^^^^ reference pure-js 1.0.0 src/`main.js`/print_fib().
+//          ^ reference local 14
+//          ^ reference local 17
+}
+