@needle-tools/needle-component-compiler 1.7.1 → 1.8.0

package/Changelog.md

@@ -4,6 +4,18 @@ 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.8.0] - 2022-09-02
+- Add ``@nonSerialized`` decorator for fields and methods
+- Fix comment gen for unknown types
+
+## [1.7.3] - 2022-09-02
+- Fix codegen for unknown array types
+- Fix codegen for abstract classes
+- Fix codegen for types imported as e.g. THREE.AnimationClip
+
+## [1.7.2] - 2022-07-27
+- fix UnityEvent codegen
+
 ## [1.7.1] - 2022-07-25
 - fix array type codegen, for example ``scenes: Array<AssetReference> = [];``, see issue https://github.com/needle-tools/needle-tiny-playground/issues/285
 

package/PUBLISH.bat

@@ -0,0 +1,8 @@
+@echo off
+echo Press a key to publish! (close the window if you changed your mind)
+pause
+echo Publishing in 2 sec
+timeout 2
+npm set registry https://registry.npmjs.org && npm publish
+echo Finished...
+timeout 10

package/Readme.md

@@ -10,6 +10,7 @@ Please run ``npm install`` first before using.
 ### 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]``
+- ``@serializeField`` field decorator, similar to ``[SerializeField]`` in Unity
+- ``@nonSerialized`` field or method decorator to skip generating c# code for a field or a method, similar to ``[NonSerialized]`` in Unity
 - ``@type MyNamespace.MyType`` decorator for fields or classes, specifiy C# type of field or class
 - ``@ifdef MY_IFDEF`` field decorator only at the moment

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@needle-tools/needle-component-compiler",
-    "version": "1.7.1",
+    "version": "1.8.0",
     "description": "Compile mock unity components from typescript",
     "main": "index.js",
     "scripts": {
@@ -16,5 +16,9 @@
         "name": "Needle",
         "email": "help@needle.tools",
         "url": "https://needle.tools/"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/needle-tools/needle-tiny-component-compiler.git"
     }
-}
+}

package/src/component-compiler.js

@@ -12,6 +12,7 @@ var exportNextClassCommand = "@generate-component";
 var dontExportNextClassCommand = "@dont-generate-component";
 // add above field to add [SerializeField] attribute
 var serializeCommand = "@serializeField";
+var dontSerializeCommand = "@nonSerialized";
 // https://regex101.com/r/ltpcKT/2
 var typePattern = new RegExp("@type ?(?<type>.+)");
 var ifdefPattern = new RegExp("@ifdef ?(?<ifdef>.+)");
@@ -21,6 +22,7 @@ var CODEGEN_MARKER_END = "// NEEDLE_CODEGEN_END";
 var exportNextClass = false;
 var dontExportNextClass = false;
 var serializeField = false;
+var dontSerialize = false;
 function resetExportNextClass() {
     dontExportNextClass = false;
     exportNextClass = false;
@@ -146,6 +148,8 @@ function run(program, outputDir, sourceFile) {
                     }
                     else if (comment.includes(serializeCommand))
                         serializeField = true;
+                    else if (comment.includes(dontSerializeCommand))
+                        dontSerialize = true;
                 }
                 if (comment.includes(exportNextClassCommand))
                     exportNextClass = true;
@@ -155,10 +159,10 @@ function run(program, outputDir, sourceFile) {
                 if (typeMatch && typeMatch.groups) {
                     // for some reason our regex does also match surrounding ( ) even tho: https://regex101.com/r/PoWK6V/1
                     // so we remove them
-                    var type = typeMatch.groups["type"];
-                    type = type.replace(/\(/, "").replace(/\)/, "");
-                    console.log("Found type: ", type);
-                    lastTypeFound = type;
+                    var type_1 = typeMatch.groups["type"];
+                    type_1 = type_1.replace(/\(/, "").replace(/\)/, "");
+                    console.log("Found type: ", type_1);
+                    lastTypeFound = type_1;
                 }
                 var ifdefMatch = ifdefPattern.exec(comment);
                 if (ifdefMatch && ifdefMatch.groups) {
@@ -168,6 +172,7 @@ function run(program, outputDir, sourceFile) {
                 }
             }
         }
+        var skip = dontSerialize;
         switch (node.kind) {
             // Namespace
             // case ts.SyntaxKind.ModuleDeclaration:
@@ -187,13 +192,14 @@ function run(program, outputDir, sourceFile) {
             case ts.SyntaxKind.MethodDeclaration:
                 lastTypeFound = null;
                 serializeField = false;
+                dontSerialize = false;
                 resetExportNextClass();
                 if (!context)
                     break;
                 // TODO: always emit at least OnEnable method per class so generated components have toggle in editor
                 var meth = node;
                 // const isCoroutine = func.asteriskToken;
-                if (meth.name) {
+                if (!skip && meth.name) {
                     var paramsStr = "";
                     for (var _g = 0, _h = meth.parameters; _g < _h.length; _g++) {
                         var param = _h[_g];
@@ -201,10 +207,10 @@ function run(program, outputDir, sourceFile) {
                             continue;
                         if (paramsStr.length > 0)
                             paramsStr += ", ";
-                        var type = tryResolveTypeRecursive(param);
-                        if (type === undefined)
-                            type = "object";
-                        paramsStr += type + " @" + param.name.getText();
+                        var type_2 = tryResolveTypeRecursive(param);
+                        if (type_2 === undefined)
+                            type_2 = "object";
+                        paramsStr += type_2 + " @" + param.name.getText();
                     }
                     var methodName = meth.name.getText();
                     context.onBeforeMethod(methodName);
@@ -222,11 +228,14 @@ function run(program, outputDir, sourceFile) {
                 var pub = isPublic(vardec);
                 var visibility = pub ? "public" : "private";
                 var isAccessible = pub;
-                if (!pub && serializeField) {
+                dontSerialize = false;
+                if (serializeField) {
                     console.log("[SerializeField]");
                     context.appendLine("[UnityEngine.SerializeField]");
                     isAccessible = true;
                 }
+                else if (skip)
+                    isAccessible = false;
                 if (!isAccessible) {
                     console.log("Skip because not public or serializeable");
                     break;
@@ -238,10 +247,10 @@ function run(program, outputDir, sourceFile) {
                 var typeString = lastTypeFound !== null && lastTypeFound !== void 0 ? lastTypeFound : tryResolveTypeRecursive(node);
                 var postFix = "";
                 var typeName = (_c = vardec.type) === null || _c === void 0 ? void 0 : _c.getText();
+                var shouldCommentTheLine = typeString === undefined;
                 if (typeString === undefined) {
                     postFix = " → Could not resolve C# type";
                 }
-                var prefix = typeString === undefined ? "// " : "";
                 var assignment = "";
                 if (typeString !== undefined) {
                     for (var _j = 0, _k = node.getChildren(); _j < _k.length; _j++) {
@@ -284,7 +293,14 @@ function run(program, outputDir, sourceFile) {
                 }
                 if (typeString === undefined)
                     typeString = typeName;
-                console.log("EMIT member: " + typeString + " " + varName);
+                if (typeString === "[]") {
+                    console.log("Unknown array type for \"" + varName + " " + typeName + "\" - your type is probably not known (did you just create it this session?) and you might need to regenerate the Typemap in Unity. Go to \"Needle Engine/Internal/Generate Type Map for component compiler");
+                    // typeString = "object[]";
+                    // assignment = " = new object[0]";
+                    shouldCommentTheLine = true;
+                }
+                console.log("EMIT member: \"" + typeString + "\" " + varName, assignment, "Last type found:", lastTypeFound);
+                var prefix = shouldCommentTheLine ? "// " : "";
                 context.append(prefix + visibility + " " + typeString + " " + varName + assignment + ";" + postFix + "\n");
                 lastTypeFound = null;
                 if (requireEndIf) {
@@ -317,7 +333,20 @@ function run(program, outputDir, sourceFile) {
                     if (lastTypeFound)
                         typeName_1 = lastTypeFound;
                     console.log(name_2 + " inherits " + typeName_1);
-                    newContext.appendLine("public partial class " + name_2 + " : " + typeName_1);
+                    var modifiers = "";
+                    if (dec.modifiers) {
+                        for (var _l = 0, _m = dec.modifiers; _l < _m.length; _l++) {
+                            var mod = _m[_l];
+                            switch (mod.getText()) {
+                                case "abstract":
+                                    modifiers += " abstract";
+                                    console.log(name_2 + " is abstract");
+                                    break;
+                            }
+                        }
+                    }
+                    modifiers += " partial";
+                    newContext.appendLine("public " + modifiers.trim() + " class " + name_2 + " : " + typeName_1);
                     newContext.appendLine("{");
                     newContext.indentLevel += 1;
                     newContext.classEnd = dec.end;
@@ -339,10 +368,10 @@ function run(program, outputDir, sourceFile) {
                             if (h.types.length <= 0)
                                 continue;
                             for (var _b = 0, _c = h.types; _b < _c.length; _b++) {
-                                var type = _c[_b];
+                                var type_3 = _c[_b];
                                 // const symbol = program.getTypeChecker().getSymbolAtLocation(type.expression);
                                 // console.log(symbol);
-                                var text = type.expression.getText();
+                                var text = type_3.expression.getText();
                                 if (text === "Component")
                                     return true;
                                 if (text === "Behaviour")
@@ -363,28 +392,31 @@ function run(program, outputDir, sourceFile) {
                 case ts.SyntaxKind.FirstLiteralToken:
                     return node.getText();
                 case ts.SyntaxKind.NewExpression:
-                    var type = undefined;
+                    var type_4 = undefined;
                     var args = undefined;
                     for (var _i = 0, _a = node.getChildren(); _i < _a.length; _i++) {
                         var ch = _a[_i];
-                        // console.log("child", ts.SyntaxKind[ch.kind]);
+                        var text = ch.getText();
+                        // console.log("child", ts.SyntaxKind[ch.kind], text);
                         switch (ch.kind) {
+                            case ts.SyntaxKind.Identifier:
                             case ts.SyntaxKind.PropertyAccessExpression:
-                                type = tryGetTypeFromText(ch.getText());
+                                type_4 = tryGetTypeFromText(text);
                                 break;
                             case ts.SyntaxKind.SyntaxList:
-                                args = ch.getText();
+                                args = text;
                                 break;
                         }
                     }
                     if (!args)
                         args = "";
-                    if (type)
-                        return "new " + type + "(" + args + ")";
+                    if (type_4)
+                        return "new " + type_4 + "(" + args + ")";
                     // const expType = node.getChildren().find(c => c.kind === ts.SyntaxKind.Identifier);
                     break;
             }
             var str = node.getText();
+            console.log("Unknown assignment:", str, ts.SyntaxKind[node.kind]);
             return str;
         }
         function isPublic(node) {
@@ -427,6 +459,14 @@ function run(program, outputDir, sourceFile) {
             return namespace;
         }
         function tryGetTypeFromText(typeName) {
+            // if a type is imported via some namespace e.g. THREE.AnimationClip
+            // we want to remove that namespace / import name
+            var separatorIndex = typeName.lastIndexOf(".");
+            if (separatorIndex > 0) {
+                var newName = typeName.substring(separatorIndex + 1);
+                console.log("Remove import name from type: \"" + typeName + "\" → \"" + newName + "\"");
+                typeName = newName;
+            }
             var res = dict[typeName];
             if (res === undefined) {
                 switch (typeName) {
@@ -438,6 +478,7 @@ function run(program, outputDir, sourceFile) {
                         break;
                 }
             }
+            // console.log(typeName, res);
             return res;
         }
         function tryResolveTypeRecursive(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 { type } from "os";
 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,6 +12,7 @@ const exportNextClassCommand = "@generate-component";
 const dontExportNextClassCommand = "@dont-generate-component";
 // add above field to add [SerializeField] attribute
 const serializeCommand = "@serializeField";
+const dontSerializeCommand = "@nonSerialized";
 // https://regex101.com/r/ltpcKT/2
 const typePattern = new RegExp("@type ?(?<type>.+)");
 const ifdefPattern = new RegExp("@ifdef ?(?<ifdef>.+)")
@@ -22,6 +24,7 @@ const CODEGEN_MARKER_END = "// NEEDLE_CODEGEN_END";
 let exportNextClass: boolean = false;
 let dontExportNextClass: boolean = false;
 let serializeField: boolean = false;
+let dontSerialize: boolean = false;
 function resetExportNextClass() {
     dontExportNextClass = false;
     exportNextClass = false;
@@ -170,6 +173,8 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     }
                     else if (comment.includes(serializeCommand))
                         serializeField = true;
+                    else if (comment.includes(dontSerializeCommand))
+                        dontSerialize = true;
                 }
                 if (comment.includes(exportNextClassCommand))
                     exportNextClass = true;
@@ -194,6 +199,7 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
             }
         }
 
+        const skip = dontSerialize;
         switch (node.kind) {
             // Namespace
             // case ts.SyntaxKind.ModuleDeclaration:
@@ -213,12 +219,13 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
             case ts.SyntaxKind.MethodDeclaration:
                 lastTypeFound = null;
                 serializeField = false;
+                dontSerialize = false;
                 resetExportNextClass();
                 if (!context) break;
                 // TODO: always emit at least OnEnable method per class so generated components have toggle in editor
                 const meth = node as ts.MethodDeclaration;
                 // const isCoroutine = func.asteriskToken;
-                if (meth.name) {
+                if (!skip && meth.name) {
                     let paramsStr = "";
                     for (let param of meth.parameters) {
                         if (!param || !param.name) continue;
@@ -245,11 +252,15 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                 const pub = isPublic(vardec);
                 const visibility = pub ? "public" : "private";
                 let isAccessible = pub;
-                if (!pub && serializeField) {
+                dontSerialize = false;
+                if (serializeField) {
                     console.log("[SerializeField]");
                     context.appendLine("[UnityEngine.SerializeField]");
                     isAccessible = true;
                 }
+                else if(skip) 
+                    isAccessible = false;
+                
                 if (!isAccessible) {
                     console.log("Skip because not public or serializeable")
                     break;
@@ -261,10 +272,10 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                 let typeString = lastTypeFound ?? tryResolveTypeRecursive(node);
                 let postFix = "";
                 let typeName = vardec.type?.getText();
+                let shouldCommentTheLine = typeString === undefined;
                 if (typeString === undefined) {
                     postFix = " → Could not resolve C# type";
                 }
-                const prefix = typeString === undefined ? "// " : "";
                 let assignment = "";
                 if (typeString !== undefined) {
                     for (const ch of node.getChildren()) {
@@ -305,7 +316,14 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     context.appendLine("#ifdef " + ifdefSections.pop());
                 }
                 if (typeString === undefined) typeString = typeName;
-                console.log("EMIT member: " + typeString + " " + varName)
+                if (typeString === "[]") {
+                    console.log("Unknown array type for \"" + varName + " " + typeName + "\" - your type is probably not known (did you just create it this session?) and you might need to regenerate the Typemap in Unity. Go to \"Needle Engine/Internal/Generate Type Map for component compiler")
+                    // typeString = "object[]";
+                    // assignment = " = new object[0]";
+                    shouldCommentTheLine = true;
+                }
+                console.log("EMIT member: \"" + typeString + "\" " + varName, assignment, "Last type found:", lastTypeFound);
+                const prefix = shouldCommentTheLine ? "// " : "";
                 context.append(prefix + visibility + " " + typeString + " " + varName + assignment + ";" + postFix + "\n");
                 lastTypeFound = null;
                 if (requireEndIf) {
@@ -337,7 +355,19 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     if (typeof inheritsComponent === "string") typeName = inheritsComponent;
                     if (lastTypeFound) typeName = lastTypeFound;
                     console.log(name + " inherits " + typeName);
-                    newContext.appendLine("public partial class " + name + " : " + typeName);
+                    let modifiers = "";
+                    if (dec.modifiers) {
+                        for (const mod of dec.modifiers) {
+                            switch (mod.getText()) {
+                                case "abstract":
+                                    modifiers += " abstract";
+                                    console.log(name + " is abstract");
+                                    break;
+                            }
+                        }
+                    }
+                    modifiers += " partial";
+                    newContext.appendLine("public " + modifiers.trim() + " class " + name + " : " + typeName);
                     newContext.appendLine("{");
                     newContext.indentLevel += 1;
                     newContext.classEnd = dec.end;
@@ -382,13 +412,15 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     let type: string | undefined = undefined;
                     let args: string | undefined = undefined;
                     for (const ch of node.getChildren()) {
-                        // console.log("child", ts.SyntaxKind[ch.kind]);
+                        const text = ch.getText();
+                        // console.log("child", ts.SyntaxKind[ch.kind], text);
                         switch (ch.kind) {
+                            case ts.SyntaxKind.Identifier:
                             case ts.SyntaxKind.PropertyAccessExpression:
-                                type = tryGetTypeFromText(ch.getText());
+                                type = tryGetTypeFromText(text);
                                 break;
                             case ts.SyntaxKind.SyntaxList:
-                                args = ch.getText();
+                                args = text;
                                 break;
                         }
                     }
@@ -399,6 +431,7 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     break;
             }
             const str = node.getText();
+            console.log("Unknown assignment:", str, ts.SyntaxKind[node.kind]);
             return str;
         }
 
@@ -441,6 +474,16 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
         }
 
         function tryGetTypeFromText(typeName: string) {
+
+            // if a type is imported via some namespace e.g. THREE.AnimationClip
+            // we want to remove that namespace / import name
+            const separatorIndex = typeName.lastIndexOf(".");
+            if (separatorIndex > 0) {
+                let newName = typeName.substring(separatorIndex + 1);
+                console.log("Remove import name from type: \"" + typeName + "\" → \"" + newName + "\"");
+                typeName = newName;
+            }
+
             let res = dict[typeName];
             if (res === undefined) {
                 switch (typeName) {
@@ -452,6 +495,7 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                         break;
                 }
             }
+            // console.log(typeName, res);
             return res;
         }
 

package/src/test.ts

@@ -1,27 +1,67 @@
 import { ThisExpression } from "typescript";
 
-export class SocLoader extends Behaviour {    
+
+export class SkipFieldAndMethod extends Behaviour {
     
-    @serializeable(AssetReference) 
-    scenes: Array<AssetReference> = [];
+    //@nonSerialized
+    myMethod() {
+
+    }
+
+    // @nonSerialized
+    myField : string;
+
 }
-// class Test123 {}
-
-export class Bla extends Behaviour
-{
-    myNumber:number = 42;
-    myBool:boolean = true;
-    myString:string = "test";
-    numberArr: number[] = [1,2,3];
-    myColor : THREE.Color = new THREE.Color(255, 0, 0);
-    renderers = new Array<Renderer>();
-    renderers2 : Renderer[] = [];
-    objArr : object[];
-    colArr: THREE.Color[] = [new THREE.Color(1,2,3)];
-    map : Map<string> = new Map<string>();
-    map2 : Map<object> = new Map<object>();
-    private myThing : Test123;
-} 
+
+
+// export class ComponentWithUnknownType extends Behaviour {
+//     views: SomeUnknownType;
+// }
+
+
+// export class ComponentWithAnimationClip extends Behaviour implements IPointerClickHandler {
+
+//     @serializeable(AnimationClip)
+//     animation?: THREE.AnimationClip;
+// }
+
+// export abstract class MyAbstractComponent extends Behaviour {
+//     abstract myMethod();
+// }
+
+
+// export class CameraView extends Behaviour {
+//     static views: CameraView[] = [];
+// }
+
+    
+// export class EventComponent extends Behaviour {    
+//     @serializeable(EventList)
+//     roomChanged: EventList = new EventList();
+// }
+
+// export class SocLoader extends Behaviour {    
+
+//     @serializeable(AssetReference) 
+//     scenes: Array<AssetReference> = [];
+// }
+// // class Test123 {}
+
+// export class Bla extends Behaviour
+// {
+//     myNumber:number = 42;
+//     myBool:boolean = true;
+//     myString:string = "test";
+//     numberArr: number[] = [1,2,3];
+//     myColor : THREE.Color = new THREE.Color(255, 0, 0);
+//     renderers = new Array<Renderer>();
+//     renderers2 : Renderer[] = [];
+//     objArr : object[];
+//     colArr: THREE.Color[] = [new THREE.Color(1,2,3)];
+//     map : Map<string> = new Map<string>();
+//     map2 : Map<object> = new Map<object>();
+//     private myThing : Test123;
+// } 
 
 // //@type UnityEngine.MonoBehaviour
 // export class ButtonObject extends Interactable implements IPointerClickHandler, ISerializable {