@needle-tools/needle-component-compiler 1.0.0 → 1.2.0

package/Changelog.md

@@ -0,0 +1,21 @@
+# Changelog
+All notable changes to this package will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [1.1.0] - 2022-06-15
+- allow adding ``@type(MyNamespace.MyType)`` to class declaration
+
+## [1.1.0] - 2022-06-13
+- add ``@type(MyNamespace.MyType)`` decorator for fields to specifiy C# type
+- add minimal docs to readme
+- dont emit comments anymore
+- make created classes partial
+
+## [1.0.1] - 2022-05-29
+- disable all warnings for generated scripts
+- add mesh and texture types
+
+## [1.0.0] - 2022-04-22
+- initial release

package/Readme.md

@@ -4,4 +4,11 @@ Little helper package to transpile typescript files to Unity C# components.
 Please run ``npm install`` first before using.
 
 ### Usage
-``node <path to>/component-compiler.js <output_directory> <path_to/my_script.ts>``
+``node <path to>/component-compiler.js <output_directory> <path_to/my_script.ts>``
+
+
+### Command decorators
+- ``@dont-generate-component`` add before class to skip generating a component
+- ``@generate-component`` to enforce generating a component (not required)
+- ``@serializeField`` field decorator, similar to ``[SerializeField]``
+- ``@type(MyNamespace.MyType)`` field decorator, specifiy C# type of field

package/dist/MaterialColorHandler.cs

@@ -0,0 +1,11 @@
+// auto generated code - do not edit
+
+#pragma warning disable
+
+namespace Needle.Typescript.GeneratedComponents
+{
+	public class MaterialColorHandler : UnityEngine.MonoBehaviour
+	{
+		public UnityEngine.Renderer[] @renderer;
+	}
+}

package/dist/NavigationManager.cs

@@ -0,0 +1,13 @@
+// auto generated code - do not edit directly
+
+#pragma warning disable
+
+namespace Needle.Typescript.GeneratedComponents
+{
+	public partial class NavigationManager : RoomEntity
+	{
+		public float @fl = 1f;
+		public void nav_forward(){}
+		public void nav_backward(){}
+	}
+}

package/dist/PointOfInterest.cs

@@ -0,0 +1,14 @@
+// auto generated code - do not edit directly
+
+#pragma warning disable
+
+namespace Needle.Typescript.GeneratedComponents
+{
+	public partial class PointOfInterest : UnityEngine.MonoBehaviour
+	{
+		public float @myVal = 12f;
+		public void myFunction(){}
+		public UnityEngine.Camera @view;
+		public string @test = "123";
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@needle-tools/needle-component-compiler",
-    "version": "1.0.0",
+    "version": "1.2.0",
     "description": "Compile mock unity components from typescript",
     "main": "index.js",
     "scripts": {
@@ -16,6 +16,5 @@
         "name": "Needle",
         "email": "help@needle.tools",
         "url": "https://needle.tools/"
-    },
-    "license": "ISC"
+    }
 }

package/src/component-compiler.js

@@ -11,6 +11,7 @@ var exportNextClassCommand = "@generate-component";
 var dontExportNextClassCommand = "@dont-generate-component";
 // add above field to add [SerializeField] attribute
 var serializeCommand = "@serializeField";
+var typePattern = new RegExp("@type ?\((?<type>.+)\)");
 // will be set to true when e.g. a comment for export is found
 var exportNextClass = false;
 var dontExportNextClass = false;
@@ -65,6 +66,7 @@ var ExportContext = /** @class */ (function () {
     return ExportContext;
 }());
 var contexts = [];
+var lastTypeFound = null;
 function run(program, outputDir, sourceFile) {
     if (!fs.existsSync(outputDir)) {
         console.error("Output directory does not exist: \"" + outputDir + "\"");
@@ -76,16 +78,18 @@ function run(program, outputDir, sourceFile) {
         ts.forEachChild(node, traverseFile);
     }
     function visit(node) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         var context = contexts.length > 0 ? contexts[contexts.length - 1] : null;
-        if ((context === null || context === void 0 ? void 0 : context.classEnd) > 0 && node.pos >= (context === null || context === void 0 ? void 0 : context.classEnd)) {
-            while (context.indentLevel > 0) {
-                context.indentLevel -= 1;
-                context.append("}\n");
+        if (context) {
+            if ((context === null || context === void 0 ? void 0 : context.classEnd) > 0 && node.pos >= (context === null || context === void 0 ? void 0 : context.classEnd)) {
+                while (context.indentLevel > 0) {
+                    context.indentLevel -= 1;
+                    context.append("}\n");
+                }
+                context.flush();
+                context = null;
+                contexts.pop();
             }
-            context.flush();
-            context = null;
-            contexts.pop();
         }
         console.log("\t", ts.SyntaxKind[node.kind]);
         var commentRanges = ts.getLeadingCommentRanges(sourceFile.getFullText(), node.getFullStart());
@@ -105,13 +109,23 @@ function run(program, outputDir, sourceFile) {
                     }
                     else if (comment.includes(serializeCommand))
                         serializeField = true;
-                    else
-                        context.appendLine(comment);
                 }
                 if (comment.includes(exportNextClassCommand))
                     exportNextClass = true;
                 if (comment.includes(dontExportNextClassCommand))
                     dontExportNextClass = true;
+                var match = typePattern.exec(comment);
+                if (match && match.groups) {
+                    // for some reason our regex does also match surrounding ( ) even tho: https://regex101.com/r/PoWK6V/1
+                    // so we remove them
+                    var type = match.groups["type"];
+                    if (type.startsWith("("))
+                        type = type.slice(1);
+                    if (type.endsWith(")"))
+                        type = type.slice(0, -1);
+                    console.log("found type: ", type);
+                    lastTypeFound = type;
+                }
             }
         }
         switch (node.kind) {
@@ -122,6 +136,7 @@ function run(program, outputDir, sourceFile) {
             case ts.SyntaxKind.Decorator:
                 break;
             case ts.SyntaxKind.MethodDeclaration:
+                lastTypeFound = null;
                 serializeField = false;
                 resetExportNextClass();
                 if (!context)
@@ -131,8 +146,8 @@ function run(program, outputDir, sourceFile) {
                 // const isCoroutine = func.asteriskToken;
                 if (meth.name) {
                     var paramsStr = "";
-                    for (var _d = 0, _e = meth.parameters; _d < _e.length; _d++) {
-                        var param = _e[_d];
+                    for (var _e = 0, _f = meth.parameters; _e < _f.length; _e++) {
+                        var param = _f[_e];
                         if (!param || !param.name)
                             continue;
                         if (paramsStr.length > 0)
@@ -158,15 +173,15 @@ function run(program, outputDir, sourceFile) {
                 console.log(name_1);
                 if (name_1.startsWith("\"@") || name_1.startsWith("\"$") || name_1.startsWith("$"))
                     break;
-                var typeString = tryResolveTypeRecursive(node);
+                var typeString = lastTypeFound !== null && lastTypeFound !== void 0 ? lastTypeFound : tryResolveTypeRecursive(node);
                 if (typeString === undefined) {
                     context.append("// Could not resolve type \"" + ((_c = vardec.type) === null || _c === void 0 ? void 0 : _c.getText()) + "\"\n");
                 }
                 var prefix = typeString === undefined ? "// " : "";
                 var assignment = "";
                 if (typeString !== undefined) {
-                    for (var _f = 0, _g = node.getChildren(); _f < _g.length; _f++) {
-                        var ch = _g[_f];
+                    for (var _g = 0, _h = node.getChildren(); _g < _h.length; _g++) {
+                        var ch = _h[_g];
                         switch (ch.kind) {
                             case ts.SyntaxKind.FalseKeyword:
                             case ts.SyntaxKind.TrueKeyword:
@@ -197,27 +212,34 @@ function run(program, outputDir, sourceFile) {
                     context.appendLine("[UnityEngine.SerializeField]");
                 }
                 context.append(prefix + visibility + " " + typeString + " " + varName + assignment + ";\n");
+                lastTypeFound = null;
                 break;
             case ts.SyntaxKind.ClassDeclaration:
                 serializeField = false;
                 var dec = node;
                 // a class must inherit a component
-                if (!dontExportNextClass && (exportNextClass || testInheritsComponent(node))) {
+                if (!dontExportNextClass && (lastTypeFound || exportNextClass || testInheritsComponent(node))) {
                     resetExportNextClass();
-                    var name_2 = dec.name.escapedText;
+                    var name_2 = (_d = dec.name) === null || _d === void 0 ? void 0 : _d.escapedText;
                     console.log("Found class: ", name_2);
                     var newContext = new ExportContext(outputDir, name_2 + ".cs");
-                    newContext.appendLine("// auto generated code - do not edit");
+                    newContext.appendLine("// auto generated code - do not edit directly");
+                    newContext.appendLine("");
+                    newContext.appendLine("#pragma warning disable");
+                    newContext.appendLine("");
                     newContext.appendLine("namespace Needle.Typescript.GeneratedComponents");
                     newContext.appendLine("{");
                     newContext.indentLevel += 1;
                     // newContext.appendLine("// source: " + path.resolve(sourceFile.fileName));
-                    newContext.appendLine("public class " + name_2 + " : UnityEngine.MonoBehaviour");
+                    var typeName = lastTypeFound !== null && lastTypeFound !== void 0 ? lastTypeFound : "UnityEngine.MonoBehaviour";
+                    console.log(name_2 + " inherits " + typeName);
+                    newContext.appendLine("public partial class " + name_2 + " : " + typeName);
                     newContext.appendLine("{");
                     newContext.indentLevel += 1;
                     newContext.classEnd = dec.end;
                     contexts.push(newContext);
                 }
+                lastTypeFound = null;
                 break;
         }
         function testInheritsComponent(node) {

package/src/component-compiler.ts

@@ -11,6 +11,7 @@ const exportNextClassCommand = "@generate-component";
 const dontExportNextClassCommand = "@dont-generate-component";
 // add above field to add [SerializeField] attribute
 const serializeCommand = "@serializeField";
+const typePattern = new RegExp("@type ?\((?<type>.+)\)");
 
 // will be set to true when e.g. a comment for export is found
 let exportNextClass: boolean = false;
@@ -80,6 +81,8 @@ class ExportContext {
 
 const contexts: ExportContext[] = [];
 
+let lastTypeFound: string | null = null;
+
 export function run(program: ts.Program, outputDir: string, sourceFile: ts.SourceFile) {
 
     if (!fs.existsSync(outputDir)) {
@@ -97,14 +100,16 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
     function visit(node: ts.Node) {
         let context: ExportContext | null = contexts.length > 0 ? contexts[contexts.length - 1] : null;
 
-        if (context?.classEnd > 0 && node.pos >= context?.classEnd) {
-            while (context.indentLevel > 0) {
-                context.indentLevel -= 1;
-                context.append("}\n");
+        if (context) {
+            if (context?.classEnd > 0 && node.pos >= context?.classEnd) {
+                while (context.indentLevel > 0) {
+                    context.indentLevel -= 1;
+                    context.append("}\n");
+                }
+                context.flush();
+                context = null;
+                contexts.pop();
             }
-            context.flush();
-            context = null;
-            contexts.pop();
         }
         console.log("\t", ts.SyntaxKind[node.kind]);
 
@@ -125,13 +130,21 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     }
                     else if (comment.includes(serializeCommand))
                         serializeField = true;
-                    else
-                        context.appendLine(comment);
                 }
                 if (comment.includes(exportNextClassCommand))
                     exportNextClass = true;
                 if (comment.includes(dontExportNextClassCommand))
                     dontExportNextClass = true;
+                const match = typePattern.exec(comment);
+                if (match && match.groups) {
+                    // for some reason our regex does also match surrounding ( ) even tho: https://regex101.com/r/PoWK6V/1
+                    // so we remove them
+                    let type = match.groups["type"];
+                    if (type.startsWith("(")) type = type.slice(1);
+                    if (type.endsWith(")")) type = type.slice(0, -1);
+                    console.log("found type: ", type);
+                    lastTypeFound = type;
+                }
             }
         }
 
@@ -143,6 +156,7 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
             case ts.SyntaxKind.Decorator:
                 break;
             case ts.SyntaxKind.MethodDeclaration:
+                lastTypeFound = null;
                 serializeField = false;
                 resetExportNextClass();
                 if (!context) break;
@@ -174,7 +188,7 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                 const name = vardec.name.getText();
                 console.log(name);
                 if (name.startsWith("\"@") || name.startsWith("\"$") || name.startsWith("$")) break;
-                let typeString = tryResolveTypeRecursive(node);
+                let typeString = lastTypeFound ?? tryResolveTypeRecursive(node);
                 if (typeString === undefined) {
                     context.append("// Could not resolve type \"" + vardec.type?.getText() + "\"\n");
                 }
@@ -212,28 +226,35 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     context.appendLine("[UnityEngine.SerializeField]");
                 }
                 context.append(prefix + visibility + " " + typeString + " " + varName + assignment + ";\n");
+                lastTypeFound = null;
                 break;
 
             case ts.SyntaxKind.ClassDeclaration:
                 serializeField = false;
                 const dec = <ts.ClassDeclaration>node;
                 // a class must inherit a component
-                if (!dontExportNextClass && (exportNextClass || testInheritsComponent(node))) {
+                if (!dontExportNextClass && (lastTypeFound || exportNextClass || testInheritsComponent(node))) {
                     resetExportNextClass();
-                    const name = dec.name.escapedText;
+                    const name = dec.name?.escapedText;
                     console.log("Found class: ", name);
                     const newContext = new ExportContext(outputDir, name + ".cs");
-                    newContext.appendLine("// auto generated code - do not edit")
+                    newContext.appendLine("// auto generated code - do not edit directly");
+                    newContext.appendLine("");
+                    newContext.appendLine("#pragma warning disable");
+                    newContext.appendLine("");
                     newContext.appendLine("namespace Needle.Typescript.GeneratedComponents");
                     newContext.appendLine("{");
                     newContext.indentLevel += 1;
                     // newContext.appendLine("// source: " + path.resolve(sourceFile.fileName));
-                    newContext.appendLine("public class " + name + " : UnityEngine.MonoBehaviour");
+                    const typeName = lastTypeFound ?? "UnityEngine.MonoBehaviour";
+                    console.log(name + " inherits " + typeName);
+                    newContext.appendLine("public partial class " + name + " : " + typeName);
                     newContext.appendLine("{");
                     newContext.indentLevel += 1;
                     newContext.classEnd = dec.end;
                     contexts.push(newContext);
                 }
+                lastTypeFound = null;
                 break;
         }
 
@@ -275,7 +296,7 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
             if (!node) return undefined;
 
             // skip decorators (e.g. @serializable() may break array generation)
-            if(node.kind === ts.SyntaxKind.Decorator) 
+            if (node.kind === ts.SyntaxKind.Decorator)
                 return undefined;
 
             let typeName = node?.getText();
@@ -323,12 +344,11 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                 console.log("Child type: " + ts.SyntaxKind[child.kind]);
                 res = tryResolveTypeRecursive(child);
             }
-            
-            if(ts.isTypeReferenceNode(node)){
+
+            if (ts.isTypeReferenceNode(node)) {
                 const typeRef = node as ts.TypeReferenceNode;
                 const typeName = typeRef.typeName.getText();
-                switch(typeName)
-                {
+                switch (typeName) {
                     case "Array":
                         res += "[]";
                         return res;

package/src/test.ts

@@ -1,13 +1,42 @@
 
 // @generate-component
 
+//@type (RoomEntity)
+export class NavigationManager extends RoomEntity {
 
-export class MaterialColorHandler extends Behaviour {
+    fl:number = 1;
 
-    @serializeable(Renderer)
-    renderer?: Renderer[];
+    nav_forward() {
+
+    }
+
+    nav_backward() { 
+
+    }
 }
 
+
+// export class PointOfInterest extends Behaviour {
+
+//     myVal:number = 12;
+    
+//     // @type(HELLO)
+//     myFunction(){
+
+//     }
+
+//     // @type(UnityEngine.Camera)
+//     view?:Camera;
+//     test:string = "123";
+//     // test
+// }
+
+// export class MaterialColorHandler extends Behaviour {
+
+//     @serializeable(Renderer)
+//     renderer?: Renderer[];
+// }
+
 // export class MyArray extends Behaviour {
     
 //     arr? : Array<number> = [1,2,3];

package/src/types.js

@@ -37,6 +37,8 @@ const dict = {
     // Rendering
     "Renderer" : "UnityEngine.Renderer",
     "Material" : "UnityEngine.Material",
+    "Mesh" : "UnityEngine.Mesh",
+    "Texture" : "UnityEngine.Texture",
     // UI
     "Text" : "UnityEngine.UI.Text",
     "Image" : "UnityEngine.UI.Image",