Fix a bunch of things

* add template literals
* fix a bug where two generated functions would have the same name
* add a header to all generated files
* properly type load() and preload() PackedScenes
* fix a bug where object literals wouldnt have a trailing newline

Author: johnfn

README.md

@@ -2,9 +2,9 @@
 
 Why use ts2gd?
 
-* Incrementally compiles to GDScript in under a tenth of a second.
-* Provides insanely good autocomplete and documentation.
-* Use all of TS's extremely powerful type system.
+- Incrementally compiles to GDScript in under a tenth of a second.
+- Provides insanely good autocomplete and documentation.
+- Use all of TS's extremely powerful type system.
 
 ## Install:
 
@@ -37,6 +37,18 @@ Now, run the compiler on tsgd.json:
 
 ## Details and Differences
 
+### load/preload
+
+Sure, you _could_ do preload("YourScriptFile.tscn)... but why would you? ts2gd automatically creates globals for your scenes that you can
+import directly. e.g. if you want to instance, "YourScriptFile.tscn", just type YourScriptFileTscn and allow TS to auto-import it. You can
+then instance() it as normal. e.g., this:
+
+`const new_obj = preload("res://MyScene.tscn).instance()`
+
+is equivalent to this:
+
+`const new_obj = MySceneTscn.instance()`
+
 ### Enums
 
 Godot decides to put a bunch of enum values into global scope. I think this clutters things up: the global scope has tons of mostly useless enum values in it, and it's impossible to tell what property belongs to which enum. So we move them into `EnumName.PropertyName` instead. This is extra nice because now if you type `EnumName` you get autocomplete of all the types in that Enum.

generate_library_defs/generate_library.ts

@@ -483,7 +483,7 @@ ${Object.keys(enums)
   //   let fileName = 'KinematicBody2D.xml';
   //   const result = await parseFile(godotDocumentationPath + fileName);
 
-  //   console.log(result);
+  //   console.info(result);
   // }
 
   await main()

main.ts

@@ -1,41 +1,45 @@
 // VERY USEFUL
 
-// TODO: Windows build.
+// [ ]: strongly typed RPCs
 
-// TODO: This doesnt work:
-//       enem.connect("on_die", () => { this.enemies.erase(enem) });
-// b/c it captures "this.enemies"
+// [ ]: Windows build.
+// [ ]: Could gitignore compiled files?
+// [ ]: Yield autocompletion stopped working
 
-// TODO: Import constants from other files.
+// [ ]: Parse input actions
+
+// [ ]: Add a test to make sure that signals on classes typecheck
+
+// [ ]: Import constants from other files.
 // - we'd have to extract these into a standard global autoload class, and point all references to constants to that global autoload.
 
-// TODO:
+// [ ]:
 //   print([1, 3, 2, 4].sort_custom((a, b) => a - b))
-// This also doesn't work ^ 
+// This also doesn't work ^
 
 // USEFUL
 
-// TODO: Handle string interpolation
-// TODO: Have a github action that auto publishes an html5 build
-// TODO: https://gist.github.com/tmaybe/4c9d94712711229cd506 use this strategy to avoid conflicts in the /compiled folder
-// TODO  make load/preload() work and return proper string
-// TODO make FooTscn return proper type of root node (without script, not just Node)
-// TODO: Merge conflict markers in project.godot cause a ts2gd crash.
-// TODO: Better print() output, with spacing
-// TODO: check for E_OK
-// TODO: Deleting a scene can cause a "I dont know the type of that thing." error.
-// TODO: Every file should export something - show an error otherwise
+// [x] Handle string interpolation
+// [ ]: Have a github action that auto publishes an html5 build
+// [ ]: https://gist.github.com/tmaybe/4c9d94712711229cd506 use this strategy to avoid conflicts in the /compiled folder
+// [ ] make FooTscn return proper type of root node (without script, not just Node)
+// [ ]: Merge conflict markers in project.godot cause a ts2gd crash.
+// [x]  make load/preload() work and return proper string
+// [x]: Better print() output, with spacing (there is prints, nevermind)
+// [ ]: check for E_OK
+// [ ]: Deleting a scene can cause a "I dont know the type of that thing." error.
+// [ ]: Every file should export something - show an error otherwise
 
-// TODO: Ensure that there aren't any bugs with _ prefixes.
+// [ ]: Ensure that there aren't any bugs with _ prefixes.
 
 // HIGH
 
-// TODO: Rename ParsedArgs to ParsedFlags
-// TODO: It would be extremely useful for some things - like the project settings and ParsedArgs - to be singletons.
+// [ ]: Rename ParsedArgs to ParsedFlags
+// [ ]: It would be extremely useful for some things - like the project settings and ParsedArgs - to be singletons.
 
-// TODO: It might be handy to keep ParseNodeTypes around for subnodes etc and return an entire tree of them. this would help code in parse_call_express that wants to inspect child nodes to see what they are etc
+// [ ]: It might be handy to keep ParseNodeTypes around for subnodes etc and return an entire tree of them. this would help code in parse_call_express that wants to inspect child nodes to see what they are etc
 
-// TODO: Refactor error handling strategy.
+// [x]: Refactor error handling strategy.
 // TODO: change_scene_to takes a PackedScene but since it's a <T> it's treated as an any.
 // TODO: Make a testing harness for project-related stuff.
 // TODO: I need to abstract over the TS and chokidar file watcher interface thingy.
@@ -46,7 +50,7 @@
 // TODO: Taking in funcrefs and calling them.
 //   specifically for mapping over my 2d board.
 // TODO: new assets aren't immediately imported.
-// TODO: There are bugs when you have both a constructor and an _ready() method.
+// TODO: There are bugs when you have both a constructor and a _ready() method.
 // TODO: Inline gdscript
 // TODO: Resolve node paths even through instances.
 
@@ -154,11 +158,11 @@ const setup = (tsgdJson: Paths) => {
 
   const host = ts.createWatchCompilerHost(
     tsgdJson.tsconfigPath,
-    { },
+    {},
     ts.sys,
     ts.createEmitAndSemanticDiagnosticsBuilderProgram,
     reportDiagnostic,
-    reportWatchStatusChanged,
+    reportWatchStatusChanged
   )
   watchProgram = ts.createWatchProgram(host)
   const configFile = ts.readJsonConfigFile(

parse_node.ts

@@ -6,6 +6,7 @@ import { parseSourceFile } from "./parse_node/parse_source_file"
 import {
   generatePrecedingNewlines,
   syntaxKindToString as kindToString,
+  syntaxKindToString,
 } from "./ts_utils"
 import { parseTypeReference } from "./parse_node/parse_type_reference"
 import { parseNumericLiteral } from "./parse_node/parse_numeric_literal"
@@ -43,7 +44,10 @@ import { parseYieldExpression } from "./parse_node/parse_yield_expression"
 import { parseReturnStatement } from "./parse_node/parse_return_statement"
 import { parseBreakStatement } from "./parse_node/parse_break_statement"
 import { parseBlock } from "./parse_node/parse_block"
-import { LibraryFunctionName, parseCallExpression } from "./parse_node/parse_call_expression"
+import {
+  LibraryFunctionName,
+  parseCallExpression,
+} from "./parse_node/parse_call_expression"
 import { parseVariableStatement } from "./parse_node/parse_variable_statement"
 import { parseSetAccessor } from "./parse_node/parse_set_accessor"
 import { parseGetAccessor } from "./parse_node/parse_get_accessor"
@@ -58,6 +62,7 @@ import { parseTypeofExpression } from "./parse_node/parse_typeof_expression"
 import { TsGdProjectClass } from "./project/project"
 import { Scope } from "./scope"
 import { ErrorName, TsGdError } from "./errors"
+import { parseTemplateExpression } from "./parse_node/parse_template_expression"
 
 export type ParseState = {
   isConstructor: boolean
@@ -129,8 +134,10 @@ export function combine(args: {
 }): ParseNodeType {
   let { parent, nodes, props, parsedStrings, parsedObjs, addIndent } = args
 
-  if (!parsedStrings && !parsedObjs) {
-    throw new Error("Need at least one of parsedStrings or parsedObjs")
+  if ((!parsedStrings && !parsedObjs) || (parsedStrings && parsedObjs)) {
+    throw new Error(
+      "Need at least one of parsedStrings or parsedObjs, but not both."
+    )
   }
 
   if (Array.isArray(nodes)) {
@@ -174,7 +181,7 @@ export function combine(args: {
   })
 
   for (const parsedNode of parsedNodes) {
-    const { node, content, enums, extraLines } = parsedNode
+    const { node, content, extraLines } = parsedNode
 
     if (!node) {
       continue
@@ -223,7 +230,7 @@ export function combine(args: {
       }
     }
 
-    if (isStandAloneLine && lines.length === 1) {
+    if (isStandAloneLine) {
       formattedContent = formattedContent + "\n"
     }
 
@@ -250,9 +257,11 @@ export function combine(args: {
     hoistedEnumImports: parsedNodes.flatMap(
       (node) => node.hoistedEnumImports ?? []
     ),
-    hoistedLibraryFunctions: new Set(parsedNodes.flatMap(
-      (node) => [...(node.hoistedLibraryFunctions?.keys() ?? [])]
-    )),
+    hoistedLibraryFunctions: new Set(
+      parsedNodes.flatMap((node) => [
+        ...(node.hoistedLibraryFunctions?.keys() ?? []),
+      ])
+    ),
     hoistedArrowFunctions: parsedNodes.flatMap(
       (node) => node.hoistedArrowFunctions ?? []
     ),
@@ -355,6 +364,11 @@ export const parseNode = (
       return parseReturnStatement(genericNode as ts.ReturnStatement, props)
     case SyntaxKind.StringLiteral:
       return parseStringLiteral(genericNode as ts.StringLiteral, props)
+    case SyntaxKind.TemplateExpression:
+      return parseTemplateExpression(
+        genericNode as ts.TemplateExpression,
+        props
+      )
     case SyntaxKind.BreakStatement:
       return parseBreakStatement(genericNode as ts.BreakStatement, props)
     case SyntaxKind.ContinueStatement:
@@ -478,6 +492,7 @@ export const parseNode = (
       return { content: "null" }
 
     default:
+      console.error(syntaxKindToString(genericNode.kind))
       props.addError({
         error: ErrorName.UnknownTsSyntax,
         location: genericNode,

parse_node/parse_arrow_function.ts

@@ -27,8 +27,8 @@ const getFreeVariables = (
     node.kind === SyntaxKind.Identifier ||
     node.kind === SyntaxKind.PropertyAccessExpression
   ) {
-    if (node.kind === SyntaxKind.PropertyAccessExpression) {
-      // In cases like "a.b.c", only return "a".
+    // In cases like "a.b.c", only return "a".
+    while (node.kind === SyntaxKind.PropertyAccessExpression) {
       const pae = node as ts.PropertyAccessExpression
       node = pae.expression
     }
@@ -83,23 +83,30 @@ export const getCapturedScope = (
   const uniqueFreeVariables = freeVariables.filter(
     (item, index) => freeVariables.indexOf(item) === index
   )
-
   // We don't want to capture `this` as part of our scope. There's no reason to
   // do it: lambdas are only ever executed in the current class, so `this` will
   // never be different. Plus, we'd have to rewrite all `this` access in the
   // function to be `_self`, which would be confusing, and look stupid, and
   // basically be a completely pointless workaround.
-  const freeVariablesWithoutThis = uniqueFreeVariables.filter(v => v.getText() !== "this");
+  const freeVariablesWithoutThis = uniqueFreeVariables.filter(
+    (v) => v.getText() !== "this"
+  )
+
+  const getNodeName = (node: ts.Node) => {
+    const text = node.getText()
+
+    return text
+  }
 
   const capturedScopeObject =
     "{" +
     freeVariablesWithoutThis
-      .map((freeVar) => `"${freeVar.getText()}": ${freeVar.getText()}`)
+      .map((freeVar) => `"${getNodeName(freeVar)}": ${getNodeName(freeVar)}`)
       .join(", ") +
     "}"
 
   const unwrapCapturedScope = freeVariablesWithoutThis
-    .map((v) => `  var ${v.getText()} = captures.${v.getText()}\n`)
+    .map((v) => `  var ${getNodeName(v)} = captures.${getNodeName(v)}\n`)
     .join("")
 
   return {

parse_node/parse_block.ts

@@ -11,7 +11,9 @@ export const parseBlock = (
       parent: node,
       nodes: node.statements,
       props,
-      parsedStrings: (...parsed) => parsed.join(""),
+      parsedStrings: (...parsed) => {
+        return parsed.join("")
+      },
     })
   } else {
     return combine({