@needle-tools/needle-component-compiler 1.12.0-da2e0be → 1.12.1-90184de

package/Changelog.md

@@ -4,6 +4,14 @@ 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.12.1] - 2025-06-06
+- Fix: Private fields decorated with `@serializable()` should be annotated with `UnityEngine.SerializeField`
+- Fix: Comment for `// @serializeField` should not affect subsequent fields
+
+
+## [1.12.0] - 2025-06-02
+- Add: Support to serialize unknown classes when annotated with `// @type object` 
+
 ## [1.11.2] - 2023-12-16
 - Fix: property setter emitting invalid C# code
 

package/package.json

@@ -1,13 +1,13 @@
 {
     "name": "@needle-tools/needle-component-compiler",
-    "version": "1.12.0-da2e0be",
+    "version": "1.12.1-90184de",
     "description": "Compile mock unity components from typescript",
     "main": "index.js",
     "scripts": {
         "tsc": "tsc",
         "dev": "npm-watch compile",
         "compile": "tsc src/component-compiler.ts",
-        "test": "mocha -r ts-node/register test/**/*serializable.test.ts"
+        "test": "mocha -r ts-node/register test/**/*.test.ts"
     },
     "dependencies": {
         "typescript": "^4.5.5"

package/src/component-compiler.js

@@ -114,7 +114,8 @@ var ExportContext = /** @class */ (function () {
             fs.writeFileSync(path_1, code);
         }
         else {
-            console.log("No output dir specified");
+            if (allowDebugLogs)
+                console.log("No output dir specified");
         }
         this.reset();
         return code;
@@ -189,7 +190,8 @@ function run(program, outputDir, sourceFile) {
                     continue;
                 commentStarts.push(r.pos);
                 var comment = node.getSourceFile().getFullText().slice(r.pos, r.end);
-                console.log(comment);
+                if (allowDebugLogs)
+                    console.log(comment);
                 if (context) {
                     // https://regex101.com/r/ud4oev/1
                     var emitContextMenu = comment.match("(\/{2,}|\/\*) {0,}@contextmenu {1,}(?<text>[a-zA-Z 0-9]+)?");
@@ -199,7 +201,8 @@ function run(program, outputDir, sourceFile) {
                     // https://regex101.com/r/Sa6Q8T/3
                     var emitTooltip = comment.match("\/{2,} {0,}(@tooltip) *?(?<text>.+)");
                     if (emitTooltip) {
-                        console.log((_c = emitTooltip.groups) === null || _c === void 0 ? void 0 : _c.text);
+                        if (allowDebugLogs)
+                            console.log((_c = emitTooltip.groups) === null || _c === void 0 ? void 0 : _c.text);
                         context.emitTooltip = (_e = (_d = emitTooltip.groups) === null || _d === void 0 ? void 0 : _d.text) !== null && _e !== void 0 ? _e : null;
                     }
                     else if (comment.includes(serializeCommand))
@@ -245,6 +248,13 @@ function run(program, outputDir, sourceFile) {
             //     console.log("comment: " + node.getText())
             //     break;
             case ts.SyntaxKind.Decorator:
+                {
+                    // If a field is decorated with @serializable then we want to serialize it
+                    var name_1 = node.getText();
+                    if (name_1.startsWith("@serializable(")) {
+                        serializeField = true;
+                    }
+                }
                 break;
             case ts.SyntaxKind.MethodDeclaration:
                 lastTypeFound = null;
@@ -308,24 +318,25 @@ function run(program, outputDir, sourceFile) {
                 var pub = shouldEmitMethod(vardec);
                 var visibility = pub ? "public" : "private";
                 var isAccessible = pub;
-                dontSerialize = false;
                 if (serializeField) {
                     if (allowDebugLogs)
-                        console.log("[SerializeField]");
+                        console.log("Emit [UnityEngine.SerializeField]");
                     context.appendLine("[UnityEngine.SerializeField]");
                     isAccessible = true;
                 }
                 else if (skip)
                     isAccessible = false;
+                dontSerialize = false;
+                serializeField = false;
                 if (!isAccessible) {
                     if (allowDebugLogs)
                         console.log("Skip because not public or serializeable");
                     break;
                 }
-                var name_1 = vardec.name.getText();
+                var name_2 = vardec.name.getText();
                 if (allowDebugLogs)
-                    console.log("Variable:", name_1);
-                if (name_1.startsWith("\"@") || name_1.startsWith("\"$") || name_1.startsWith("$"))
+                    console.log("Variable:", name_2);
+                if (name_2.startsWith("\"@") || name_2.startsWith("\"$") || name_2.startsWith("$"))
                     break;
                 var typeString = lastTypeFound !== null && lastTypeFound !== void 0 ? lastTypeFound : tryResolveTypeRecursive(node);
                 var postFix = "";
@@ -402,18 +413,19 @@ function run(program, outputDir, sourceFile) {
                 break;
             case ts.SyntaxKind.ClassDeclaration:
                 serializeField = false;
+                dontSerialize = false;
                 var dec = node;
                 // a class must inherit a component
                 var inheritsComponent = testInheritsComponent(node);
                 if (!dontExportNextClass && (lastTypeFound || exportNextClass || inheritsComponent)) {
                     resetExportNextClass();
-                    var name_2 = (_g = dec.name) === null || _g === void 0 ? void 0 : _g.escapedText;
+                    var name_3 = (_g = dec.name) === null || _g === void 0 ? void 0 : _g.escapedText;
                     if (allowDebugLogs)
-                        console.log("Found class: ", name_2);
+                        console.log("Found class: ", name_3);
                     var namespace = (_h = tryParseNamespace(node)) !== null && _h !== void 0 ? _h : "Needle.Typescript.GeneratedComponents";
                     if (allowDebugLogs)
                         console.log("NAMESPACE", namespace);
-                    var newContext = new ExportContext(outputDir, name_2 + ".cs");
+                    var newContext = new ExportContext(outputDir, name_3 + ".cs");
                     newContext.appendLine("// auto generated code - do not edit directly");
                     newContext.appendLine("");
                     newContext.appendLine("#pragma warning disable");
@@ -428,7 +440,7 @@ function run(program, outputDir, sourceFile) {
                     if (lastTypeFound)
                         typeName_1 = lastTypeFound;
                     if (allowDebugLogs)
-                        console.log(name_2 + " inherits " + typeName_1);
+                        console.log(name_3 + " inherits " + typeName_1);
                     var modifiers = "";
                     if (dec.modifiers) {
                         for (var _p = 0, _q = dec.modifiers; _p < _q.length; _p++) {
@@ -437,7 +449,7 @@ function run(program, outputDir, sourceFile) {
                                 case "abstract":
                                     modifiers += " abstract";
                                     if (allowDebugLogs)
-                                        console.log(name_2 + " is abstract");
+                                        console.log(name_3 + " is abstract");
                                     break;
                             }
                         }
@@ -447,7 +459,7 @@ function run(program, outputDir, sourceFile) {
                     if (typeName_1 === "object") {
                         newContext.appendLine("[System.Serializable]");
                     }
-                    newContext.appendLine("public " + modifiers.trim() + " class " + name_2 + " : " + typeName_1);
+                    newContext.appendLine("public " + modifiers.trim() + " class " + name_3 + " : " + typeName_1);
                     newContext.appendLine("{");
                     newContext.indentLevel += 1;
                     newContext.classEnd = dec.end;
@@ -499,7 +511,8 @@ function run(program, outputDir, sourceFile) {
                     for (var _i = 0, _a = node.getChildren(); _i < _a.length; _i++) {
                         var ch = _a[_i];
                         var text = ch.getText();
-                        console.log("child", ts.SyntaxKind[ch.kind], text);
+                        if (allowDebugLogs)
+                            console.log("child", ts.SyntaxKind[ch.kind], text);
                         switch (ch.kind) {
                             case ts.SyntaxKind.Identifier:
                             case ts.SyntaxKind.PropertyAccessExpression:
@@ -528,7 +541,8 @@ function run(program, outputDir, sourceFile) {
                         args = "";
                     if (type || typeString) {
                         if (typeString) {
-                            console.log("Override type", type, typeString);
+                            if (allowDebugLogs)
+                                console.log("Override type", type, typeString);
                             type = typeString;
                         }
                         return "new " + type + "(" + args + ")";