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

package/Changelog.md

@@ -4,6 +4,10 @@ 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

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.3",
+    "version": "1.8.0",
     "description": "Compile mock unity components from typescript",
     "main": "index.js",
     "scripts": {

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;
@@ -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];
@@ -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,6 +247,7 @@ 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";
                 }
@@ -285,11 +295,12 @@ function run(program, outputDir, sourceFile) {
                     typeString = typeName;
                 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]";
+                    // typeString = "object[]";
+                    // assignment = " = new object[0]";
+                    shouldCommentTheLine = true;
                 }
                 console.log("EMIT member: \"" + typeString + "\" " + varName, assignment, "Last type found:", lastTypeFound);
-                var prefix = typeString === undefined ? "// " : "";
+                var prefix = shouldCommentTheLine ? "// " : "";
                 context.append(prefix + visibility + " " + typeString + " " + varName + assignment + ";" + postFix + "\n");
                 lastTypeFound = null;
                 if (requireEndIf) {

package/src/component-compiler.ts

@@ -12,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>.+)")
@@ -23,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;
@@ -171,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;
@@ -195,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:
@@ -214,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;
@@ -246,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;
@@ -262,6 +272,7 @@ 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";
                 }
@@ -307,11 +318,12 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                 if (typeString === undefined) typeString = typeName;
                 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]";
+                    // typeString = "object[]";
+                    // assignment = " = new object[0]";
+                    shouldCommentTheLine = true;
                 }
                 console.log("EMIT member: \"" + typeString + "\" " + varName, assignment, "Last type found:", lastTypeFound);
-                const prefix = typeString === undefined ? "// " : "";
+                const prefix = shouldCommentTheLine ? "// " : "";
                 context.append(prefix + visibility + " " + typeString + " " + varName + assignment + ";" + postFix + "\n");
                 lastTypeFound = null;
                 if (requireEndIf) {

package/src/test.ts

@@ -1,15 +1,33 @@
 import { ThisExpression } from "typescript";
 
 
+export class SkipFieldAndMethod extends Behaviour {
+    
+    //@nonSerialized
+    myMethod() {
+
+    }
+
+    // @nonSerialized
+    myField : string;
+
+}
+
+
+// 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 abstract class MyAbstractComponent extends Behaviour {
+//     abstract myMethod();
+// }
 
 
 // export class CameraView extends Behaviour {