@needle-tools/needle-component-compiler 1.1.0 → 1.3.0

package/Changelog.md

@@ -4,6 +4,12 @@ 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.3.0] - 2022-06-27
+- add support for typescript namespace
+
+## [1.2.1] - 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

package/Readme.md

@@ -11,4 +11,4 @@ Please run ``npm install`` first before using.
 - ``@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
+- ``@type(MyNamespace.MyType)`` decorator for fields or classes, specifiy C# type of field or class

package/dist/MyClass.cs

@@ -1,23 +1,10 @@
-// auto generated code - do not edit
-namespace Needle.Typescript.GeneratedComponents
+// auto generated code - do not edit directly
+
+#pragma warning disable
+
+namespace Hello.World.Deep
 {
-	// source: C:\git\needle-tiny-playground\projects\Compiled_Export\myProject\src\scripts\MyClass.ts
-	public class MyClass : UnityEngine.MonoBehaviour
+	public partial class MyClass : UnityEngine.MonoBehaviour
 	{
-		public void start(){}
-		public float myFloat = 15;
-		public bool myBool;
-		// just some default values
-		public float[] myArray = new float[]{ 1, 2, 3 };
-		// comment for myString
-		public string myString = "this is a string";
-		public UnityEngine.Transform myObject;
-		public bool myBool2;
-		public void myFunction(){}
-		public void myFunctionWithStringParameter(string @string){}
-		public void myFunctionWithSomeObjectAndArray(UnityEngine.Transform @obj, float[] @arr){}
-		public void myFunctionWithoutParamTypes(object @test){}
-		public UnityEngine.Transform[] someOtherStuff;
-		public UnityEngine.Events.UnityEvent myEvent;
 	}
 }

package/dist/NavComponent.cs

@@ -0,0 +1,13 @@
+// auto generated code - do not edit directly
+
+#pragma warning disable
+
+namespace Needle.Typescript.GeneratedComponents
+{
+	public partial class NavComponent : UnityEngine.MonoBehaviour
+	{
+		public void next(){}
+		public void prev(){}
+		public void isAtEnd(){}
+	}
+}

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/OtherClass.cs

@@ -0,0 +1,10 @@
+// auto generated code - do not edit directly
+
+#pragma warning disable
+
+namespace Needle.Typescript.GeneratedComponents
+{
+	public partial class OtherClass : UnityEngine.MonoBehaviour
+	{
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@needle-tools/needle-component-compiler",
-    "version": "1.1.0",
+    "version": "1.3.0",
     "description": "Compile mock unity components from typescript",
     "main": "index.js",
     "scripts": {

package/src/component-compiler.js

@@ -11,7 +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>.+)\)");
+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;
@@ -78,16 +78,18 @@ function run(program, outputDir, sourceFile) {
         ts.forEachChild(node, traverseFile);
     }
     function visit(node) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e;
         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());
@@ -107,29 +109,32 @@ function run(program, outputDir, sourceFile) {
                     }
                     else if (comment.includes(serializeCommand))
                         serializeField = true;
-                    else {
-                        console.log(comment);
-                        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;
-                        }
-                    }
                 }
                 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"];
+                    type = type.replace(/\(/, "").replace(/\)/, "");
+                    console.log("found type: ", type);
+                    lastTypeFound = type;
+                }
             }
         }
         switch (node.kind) {
+            // Namespace
+            // case ts.SyntaxKind.ModuleDeclaration:
+            //     const mod = node as ts.ModuleDeclaration;
+            //     console.log(ts.SyntaxKind[mod.getChildAt(1).kind])
+            //     const type = mod.getChildAt(1) as ts.Identifier;
+            //     console.log("MODULE", type.text)
+            //     break;
+            // case ts.SyntaxKind.Identifier:
+            //     break;
             // case ts.SyntaxKind.ClassDeclaration:
             // case ts.SyntaxKind.SingleLineCommentTrivia:
             //     console.log("comment: " + node.getText())
@@ -147,8 +152,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 _f = 0, _g = meth.parameters; _f < _g.length; _f++) {
+                        var param = _g[_f];
                         if (!param || !param.name)
                             continue;
                         if (paramsStr.length > 0)
@@ -181,8 +186,8 @@ function run(program, outputDir, sourceFile) {
                 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 _h = 0, _j = node.getChildren(); _h < _j.length; _h++) {
+                        var ch = _j[_h];
                         switch (ch.kind) {
                             case ts.SyntaxKind.FalseKeyword:
                             case ts.SyntaxKind.TrueKeyword:
@@ -217,28 +222,32 @@ function run(program, outputDir, sourceFile) {
                 break;
             case ts.SyntaxKind.ClassDeclaration:
                 serializeField = false;
-                lastTypeFound = null;
                 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 namespace = (_e = tryParseNamespace(node)) !== null && _e !== void 0 ? _e : "Needle.Typescript.GeneratedComponents";
+                    console.log("NAMESPACE", namespace);
                     var newContext = new ExportContext(outputDir, name_2 + ".cs");
                     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("namespace " + namespace);
                     newContext.appendLine("{");
                     newContext.indentLevel += 1;
                     // newContext.appendLine("// source: " + path.resolve(sourceFile.fileName));
-                    newContext.appendLine("public partial 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) {
@@ -279,6 +288,31 @@ function run(program, outputDir, sourceFile) {
             }
             return true;
         }
+        function tryParseNamespace(node, namespace) {
+            // console.log("TRAVERSE - " + ts.SyntaxKind[node.kind]);
+            switch (node.kind) {
+                case ts.SyntaxKind.ModuleDeclaration:
+                    for (var _i = 0, _a = node.getChildren(); _i < _a.length; _i++) {
+                        var ch = _a[_i];
+                        // console.log("-- TRAVERSE - " + ts.SyntaxKind[ch.kind]);
+                        switch (ch.kind) {
+                            case ts.SyntaxKind.Identifier:
+                                var id = ch;
+                                if (id.text) {
+                                    if (!namespace)
+                                        namespace = "";
+                                    namespace = id.text + (namespace ? "." : "") + namespace;
+                                }
+                                break;
+                        }
+                    }
+                    break;
+            }
+            if (node.parent) {
+                return tryParseNamespace(node.parent, namespace);
+            }
+            return namespace;
+        }
         function tryResolveTypeRecursive(node) {
             var _a;
             if (!node)

package/src/component-compiler.ts

@@ -4,6 +4,7 @@ import * as fs from "fs";
 import * as path from "path";
 
 import * as types from "./types";
+import { traceDeprecation } from "process";
 const dict = types.dict;
 
 // add either of these two comments above a class to enforce code gen or disable it for the next class
@@ -11,7 +12,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>.+)\)");
+const typePattern = new RegExp("@type ?\((?<type>.+)\)");
 
 // will be set to true when e.g. a comment for export is found
 let exportNextClass: boolean = false;
@@ -81,7 +82,7 @@ class ExportContext {
 
 const contexts: ExportContext[] = [];
 
-let lastTypeFound : string | null = null;
+let lastTypeFound: string | null = null;
 
 export function run(program: ts.Program, outputDir: string, sourceFile: ts.SourceFile) {
 
@@ -100,14 +101,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]);
 
@@ -128,28 +131,33 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     }
                     else if (comment.includes(serializeCommand))
                         serializeField = true;
-                    else {
-                        console.log(comment);
-                        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;
-                        }
-                    }
                 }
                 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"];
+                    type = type.replace(/\(/, "").replace(/\)/, "");
+                    console.log("found type: ", type);
+                    lastTypeFound = type;
+                }
             }
         }
 
         switch (node.kind) {
+            // Namespace
+            // case ts.SyntaxKind.ModuleDeclaration:
+            //     const mod = node as ts.ModuleDeclaration;
+            //     console.log(ts.SyntaxKind[mod.getChildAt(1).kind])
+            //     const type = mod.getChildAt(1) as ts.Identifier;
+            //     console.log("MODULE", type.text)
+            //     break;
+            // case ts.SyntaxKind.Identifier:
+            //     break;
             // case ts.SyntaxKind.ClassDeclaration:
             // case ts.SyntaxKind.SingleLineCommentTrivia:
             //     console.log("comment: " + node.getText())
@@ -232,28 +240,32 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
 
             case ts.SyntaxKind.ClassDeclaration:
                 serializeField = false;
-                lastTypeFound = null;
                 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 namespace = tryParseNamespace(node) ?? "Needle.Typescript.GeneratedComponents";
+                    console.log("NAMESPACE", namespace);
                     const newContext = new ExportContext(outputDir, name + ".cs");
                     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("namespace " + namespace);
                     newContext.appendLine("{");
                     newContext.indentLevel += 1;
                     // newContext.appendLine("// source: " + path.resolve(sourceFile.fileName));
-                    newContext.appendLine("public partial 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;
         }
 
@@ -291,6 +303,30 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
             return true;
         }
 
+        function tryParseNamespace(node: ts.Node, namespace?: string): string | null | undefined {
+            // console.log("TRAVERSE - " + ts.SyntaxKind[node.kind]);
+            switch (node.kind) {
+                case ts.SyntaxKind.ModuleDeclaration:
+                    for (const ch of node.getChildren()) {
+                        // console.log("-- TRAVERSE - " + ts.SyntaxKind[ch.kind]);
+                        switch (ch.kind) {
+                            case ts.SyntaxKind.Identifier:
+                                const id = ch as ts.Identifier;
+                                if (id.text) {
+                                    if(!namespace) namespace = "";
+                                    namespace = id.text + (namespace ? "." : "") + namespace;
+                                }
+                                break;
+                        }
+                    }
+                    break;
+            }
+            if (node.parent) {
+                return tryParseNamespace(node.parent, namespace);
+            }
+            return namespace;
+        }
+
         function tryResolveTypeRecursive(node: ts.Node | ts.VariableDeclaration): string | undefined {
             if (!node) return undefined;
 

package/src/test.ts

@@ -1,22 +1,58 @@
 
-// @generate-component
+// import { Behaviour } from "needle.tiny.engine/engine-components/Component";
+// import { RoomEntity } from "./Room";
 
 
-export class PointOfInterest extends Behaviour {
-
-    myVal:number = 12;
+namespace Hello.World
+{
+    namespace Deep {
+        export class MyClass extends Behaviour {
     
-    // @type(HELLO)
-    myFunction(){
-
+        }
     }
+}
+
+class OtherClass extends Behaviour {
 
-    // @type(UnityEngine.Camera)
-    view?:Camera;
-    test:string = "123";
-    // test
 }
 
+//@type (RoomEntity) 
+// export class NavigationManager extends RoomEntity {
+
+//     fl:number = 1;
+
+//     nav_forward() {
+
+//     }
+
+//     nav_backward() { 
+
+//     }
+// }
+
+// export abstract class NavComponent extends Behaviour {
+
+//     abstract next();  
+//     abstract prev();
+//     abstract isAtEnd():boolean; 
+// } 
+
+
+// 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)