@needle-tools/needle-component-compiler 1.9.2 → 1.9.4

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.9.4] - 2023-05-24
+- Change: `Object3D` now emits `GameObject` field instead of `Transform`
+- Fix: ignore `static` methods
+- Fix: ignore `abstract` methods
+
+## [1.9.3] - 2022-12-30
+- Add debug logs for when no file or target directory was passed in. Also wrapping core with try catch
+
 ## [1.9.2] - 2022-11-29
 - Fix codegen deleting code added manually outside of codegen sections
 - Fix codegen creating output directory if it does not exist yet

package/package.json

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

package/src/component-compiler.js

@@ -90,8 +90,9 @@ var ExportContext = /** @class */ (function () {
         this.append(text + "\n");
     };
     ExportContext.prototype.flush = function () {
-        if (this.textBuffer.length <= 0)
+        if (this.textBuffer.length <= 0) {
             return;
+        }
         this.textBuffer = CODEGEN_MARKER_START + "\n" + this.textBuffer + "\n" + CODEGEN_MARKER_END;
         var code = this.textBuffer;
         if (this.outputDir !== null) {
@@ -104,6 +105,9 @@ var ExportContext = /** @class */ (function () {
                 console.log("Write to " + path_1);
             fs.writeFileSync(path_1, code);
         }
+        else {
+            console.log("No output dir specified");
+        }
         this.reset();
         return code;
     };
@@ -238,7 +242,7 @@ function run(program, outputDir, sourceFile) {
                 var meth = node;
                 // const isCoroutine = func.asteriskToken;
                 if (!skip && meth.name) {
-                    var pub_1 = isPublic(meth);
+                    var pub_1 = shouldEmitMethod(meth);
                     if (!pub_1)
                         return;
                     var paramsStr = "";
@@ -276,7 +280,7 @@ function run(program, outputDir, sourceFile) {
                     console.log("Found variable", node.getText());
                 var vardec = node;
                 var varName = "@" + vardec.name.getText();
-                var pub = isPublic(vardec);
+                var pub = shouldEmitMethod(vardec);
                 var visibility = pub ? "public" : "private";
                 var isAccessible = pub;
                 dontSerialize = false;
@@ -497,16 +501,24 @@ function run(program, outputDir, sourceFile) {
                 console.log("Unknown assignment:", str, ts.SyntaxKind[node.kind]);
             return str;
         }
-        function isPublic(node) {
+        function shouldEmitMethod(node) {
             if (node.kind === ts.SyntaxKind.PublicKeyword) {
                 return true;
             }
             else if (node.kind === ts.SyntaxKind.PrivateKeyword || node.kind === ts.SyntaxKind.ProtectedKeyword) {
                 return false;
             }
+            // check if its static
+            else if (node.kind === ts.SyntaxKind.StaticKeyword) {
+                return false;
+            }
+            // check if its abstract
+            else if (node.kind === ts.SyntaxKind.AbstractKeyword) {
+                return false;
+            }
             for (var _i = 0, _a = node.getChildren(); _i < _a.length; _i++) {
                 var ch = _a[_i];
-                if (!isPublic(ch))
+                if (!shouldEmitMethod(ch))
                     return false;
             }
             return true;
@@ -691,11 +703,17 @@ if (process) {
         var outputDir_1 = process.argv[2];
         var fileNames = process.argv.slice(3);
         fileNames.forEach(function (fileName) {
-            if (!fs.existsSync(fileName)) {
+            try {
+                if (!fs.existsSync(fileName)) {
+                    console.error("File not found: " + fileName);
+                }
+                else {
+                    var code = (0, fs_1.readFileSync)(fileName).toString();
+                    compile(code, fileName, outputDir_1);
+                }
             }
-            else {
-                var code = (0, fs_1.readFileSync)(fileName).toString();
-                compile(code, fileName, outputDir_1);
+            catch (e) {
+                console.error(e);
             }
         });
     }

package/src/component-compiler.ts

@@ -110,7 +110,9 @@ class ExportContext {
     }
 
     flush(): string {
-        if (this.textBuffer.length <= 0) return;
+        if (this.textBuffer.length <= 0) {
+            return;
+        }
         this.textBuffer = CODEGEN_MARKER_START + "\n" + this.textBuffer + "\n" + CODEGEN_MARKER_END;
         let code = this.textBuffer;
         if (this.outputDir !== null) {
@@ -123,6 +125,9 @@ class ExportContext {
                 console.log("Write to " + path);
             fs.writeFileSync(path, code);
         }
+        else {
+            console.log("No output dir specified");
+        }
         this.reset();
         return code;
     }
@@ -275,7 +280,7 @@ export function run(program: ts.Program, outputDir: string | null, sourceFile: t
                 const meth = node as ts.MethodDeclaration;
                 // const isCoroutine = func.asteriskToken;
                 if (!skip && meth.name) {
-                    const pub = isPublic(meth);
+                    const pub = shouldEmitMethod(meth);
                     if (!pub) return;
 
                     let paramsStr = "";
@@ -307,7 +312,7 @@ export function run(program: ts.Program, outputDir: string | null, sourceFile: t
                 const vardec = node as ts.VariableDeclaration;
 
                 const varName = "@" + vardec.name.getText();
-                const pub = isPublic(vardec);
+                const pub = shouldEmitMethod(vardec);
                 const visibility = pub ? "public" : "private";
                 let isAccessible = pub;
                 dontSerialize = false;
@@ -517,16 +522,24 @@ export function run(program: ts.Program, outputDir: string | null, sourceFile: t
             return str;
         }
 
-        function isPublic(node: ts.Node): boolean {
+        function shouldEmitMethod(node: ts.Node): boolean {
             if (node.kind === ts.SyntaxKind.PublicKeyword) {
                 return true;
             }
             else if (node.kind === ts.SyntaxKind.PrivateKeyword || node.kind === ts.SyntaxKind.ProtectedKeyword) {
                 return false;
             }
+            // check if its static
+            else if (node.kind === ts.SyntaxKind.StaticKeyword) {
+                return false;
+            }
+            // check if its abstract
+            else if (node.kind === ts.SyntaxKind.AbstractKeyword) {
+                return false;
+            }
 
             for (const ch of node.getChildren()) {
-                if (!isPublic(ch)) return false;
+                if (!shouldEmitMethod(ch)) return false;
             }
             return true;
         }
@@ -725,12 +738,17 @@ if (process) {
         const outputDir = process.argv[2];
         const fileNames = process.argv.slice(3);
         fileNames.forEach(fileName => {
-            if (!fs.existsSync(fileName)) {
-
+            try {
+                if (!fs.existsSync(fileName)) {
+                    console.error("File not found: " + fileName);
+                }
+                else {
+                    const code = readFileSync(fileName).toString();
+                    compile(code, fileName, outputDir);
+                }
             }
-            else {
-                const code = readFileSync(fileName).toString();
-                compile(code, fileName, outputDir);
+            catch (e) {
+                console.error(e);
             }
         });
     }

package/src/test.js

@@ -20,7 +20,7 @@ var MyTestComponent = /** @class */ (function (_super) {
     __extends(MyTestComponent, _super);
     function MyTestComponent() {
         var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.myVecgfdsgtor2 = new Vector2(1, .5);
+        _this.myVector2 = new Vector2(1, .5);
         return _this;
     }
     MyTestComponent.prototype.myMethod = function () {

package/src/test.ts

@@ -1,7 +1,7 @@
 import { ThisExpression } from "typescript";
 
 export class MyTestComponent extends Behaviour {
-    public myVecgfdsgtor2: Vector2 = new Vector2(1, .5);
+    public myVector2: Vector2 = new Vector2(1, .5);
     private myMethod(){
         
     }

package/src/types.js

@@ -12,7 +12,7 @@ const dict = {
     "Behaviour" : "UnityEngine.Behaviour",
     "Component" : "UnityEngine.Component",
     "GameObject" : "UnityEngine.GameObject",
-    "Object3D" : "UnityEngine.Transform",
+    "Object3D" : "UnityEngine.GameObject",
     // Addressables
     "AssetReference" : "UnityEngine.Transform",
     // events

package/test/component.basic.test.ts

@@ -33,7 +33,7 @@ describe('Basic typescript', () => {
 
 
 
-  
+
   it('should ignore abstract type', () => {
     compareCodegen("basic-no-export",
       // INPUT
@@ -46,8 +46,12 @@ describe('Basic typescript', () => {
       ``
     );
   });
+  
 
 
-});
 
 
+
+
+});
+

package/test/component.primitives.test.js

@@ -44,4 +44,18 @@ describe('Typescript with fields', function () {
         // EXPECTED
         "public partial class MyComponent : UnityEngine.MonoBehaviour\n\t{\n    public float @myField = 42f;\n    public string @myField2 = \"hello\";\n    public bool @myField3 = true;\n    public UnityEngine.Object @myField4;\n\t\tpublic UnityEngine.Vector2 @myVector2 = new UnityEngine.Vector2(1f, .5f);\n\t}");
     });
+    it('should generate component with GameObject reference', function () {
+        (0, helpers_1.compareCodegenWithDefaultContext)("object", 
+        // INPUT
+        "export class MyComponent extends Behaviour {\n    public myObject: Object3D;\n}\n", 
+        // EXPECTED
+        "public partial class MyComponent : UnityEngine.MonoBehaviour\n\t{\n    public UnityEngine.GameObject @myObject;\n\t}");
+    });
+    it('should generate component with RectTransform reference', function () {
+        (0, helpers_1.compareCodegenWithDefaultContext)("object", 
+        // INPUT
+        "export class MyComponent extends Behaviour {\n    public myRect: RectTransform;\n}\n", 
+        // EXPECTED
+        "public partial class MyComponent : UnityEngine.MonoBehaviour\n\t{\n    public UnityEngine.RectTransform @myRect;\n\t}");
+    });
 });

package/test/component.primitives.test.ts

@@ -120,4 +120,39 @@ describe('Typescript with fields', () => {
 
 
 
+  it('should generate component with GameObject reference', () => {
+    compareCodegenWithDefaultContext("object",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    public myObject: Object3D;
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public UnityEngine.GameObject @myObject;
+	}`
+    );
+  });
+
+
+
+
+  it('should generate component with RectTransform reference', () => {
+    compareCodegenWithDefaultContext("object",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    public myRect: RectTransform;
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public UnityEngine.RectTransform @myRect;
+	}`
+    );
+  });
+
+
+
 });

package/schemes/MyNew.component.json

@@ -1 +0,0 @@
-{
    "MyNew": {
    }

package/schemes/MyTest.component.json

@@ -1 +0,0 @@
-{
    "MyTest": {
        "myMethod": {
            "type": "fn"
        }
    }

package/test/blender/codegen/basic/expected.component.json

@@ -1,4 +0,0 @@
-{
-            "BasicComponent": {
-            }
-        }

package/test/blender/codegen/basic/input.js

@@ -1,26 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-exports.__esModule = true;
-exports.BasicComponent = void 0;
-var BasicComponent = /** @class */ (function (_super) {
-    __extends(BasicComponent, _super);
-    function BasicComponent() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    return BasicComponent;
-}(Behaviour));
-exports.BasicComponent = BasicComponent;

package/test/blender/codegen/basic/input.ts

@@ -1,3 +0,0 @@
-export class BasicComponent extends Behaviour {
-  }
-  

package/test/blender/codegen/basic/output.component.json

@@ -1 +0,0 @@
-{
    "BasicComponent": {
    }

package/test/blender/codegen/float field/expected.component.json

@@ -1,8 +0,0 @@
-{
-            "BasicComponent": {
-                "myFloat": {
-                    "type": "float",
-                    "value": 42
-                }
-            }
-        }

package/test/blender/codegen/float field/input.js

@@ -1,28 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-exports.__esModule = true;
-exports.BasicComponent = void 0;
-var BasicComponent = /** @class */ (function (_super) {
-    __extends(BasicComponent, _super);
-    function BasicComponent() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.myFloat = 42;
-        return _this;
-    }
-    return BasicComponent;
-}(Behaviour));
-exports.BasicComponent = BasicComponent;

package/test/blender/codegen/float field/input.ts

@@ -1,4 +0,0 @@
-export class BasicComponent extends Behaviour {
-            myFloat:number = 42;
-  }
-  

package/test/blender/codegen/float field/output.component.json

@@ -1 +0,0 @@
-{
    "BasicComponent": {
        "myFloat": {
            "type": "float",
            "value": 42
        }
    }

package/test/blender/codegen/reference_animation/expected.component.json

@@ -1,7 +0,0 @@
-{
-        "BasicComponent": {
-            "animation": {
-                "type": "comp"
-            }
-        }
-    }

package/test/blender/codegen/reference_animation/input.js

@@ -1,35 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-exports.__esModule = true;
-exports.BasicComponent = void 0;
-var BasicComponent = /** @class */ (function (_super) {
-    __extends(BasicComponent, _super);
-    function BasicComponent() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    __decorate([
-        serializable(Behaviour)
-    ], BasicComponent.prototype, "animation");
-    return BasicComponent;
-}(Behaviour));
-exports.BasicComponent = BasicComponent;

package/test/blender/codegen/reference_animation/input.ts

@@ -1,4 +0,0 @@
-export class BasicComponent extends Behaviour {
-        @serializable(Behaviour)
-        animation : Animation;
-}

package/test/blender/codegen/reference_animation/output.component.json

@@ -1 +0,0 @@
-{
    "BasicComponent": {
        "animation": {
            "type": "animation"
        }
    }

package/test/blender/codegen/reference_behaviour/expected.component.json

@@ -1,7 +0,0 @@
-{
-          "BasicComponent": {
-              "basicComponent": {
-                  "type": "comp"
-              }
-          }
-      }

package/test/blender/codegen/reference_behaviour/input.js

@@ -1,35 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-exports.__esModule = true;
-exports.BasicComponent = void 0;
-var BasicComponent = /** @class */ (function (_super) {
-    __extends(BasicComponent, _super);
-    function BasicComponent() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    __decorate([
-        serializable(Behaviour)
-    ], BasicComponent.prototype, "basicComponent");
-    return BasicComponent;
-}(Behaviour));
-exports.BasicComponent = BasicComponent;

package/test/blender/codegen/reference_behaviour/input.ts

@@ -1,5 +0,0 @@
-export class BasicComponent extends Behaviour {
-          @serializable(Behaviour)
-          basicComponent : Behaviour;
-  }
-  

package/test/blender/codegen/reference_behaviour/output.component.json

@@ -1 +0,0 @@
-{
    "BasicComponent": {
        "basicComponent": {
            "type": "comp"
        }
    }

package/test/csharp/codegen/abstract method/expected.cs

@@ -1,14 +0,0 @@
-// NEEDLE_CODEGEN_START
-    // auto generated code - do not edit directly
-    
-    #pragma warning disable
-    
-    namespace Needle.Typescript.GeneratedComponents
-    {
-    	public partial class MyComponent : UnityEngine.MonoBehaviour
-	{
-    public void OnDisable(){}
-	}
-    }
-    
-    // NEEDLE_CODEGEN_END

package/test/csharp/codegen/abstract method/input.js

@@ -1,27 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-exports.__esModule = true;
-exports.MyComponent = void 0;
-var MyComponent = /** @class */ (function (_super) {
-    __extends(MyComponent, _super);
-    function MyComponent() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    MyComponent.prototype.onDisable = function () { };
-    return MyComponent;
-}(Behaviour));
-exports.MyComponent = MyComponent;

package/test/csharp/codegen/abstract method/input.ts

@@ -1,4 +0,0 @@
-export class MyComponent extends Behaviour {
-      onDisable() {}
-    }
-}

package/test/csharp/codegen/abstract method/output.cs

@@ -1,14 +0,0 @@
-// NEEDLE_CODEGEN_START
-// auto generated code - do not edit directly
-
-#pragma warning disable
-
-namespace Needle.Typescript.GeneratedComponents
-{
-	public partial class MyComponent : UnityEngine.MonoBehaviour
-	{
-		public void OnDisable(){}
-	}
-}
-
-// NEEDLE_CODEGEN_END

package/test/csharp/codegen/basic/expected.cs

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

package/test/csharp/codegen/basic/input.js

@@ -1,26 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-exports.__esModule = true;
-exports.BasicComponet = void 0;
-var BasicComponet = /** @class */ (function (_super) {
-    __extends(BasicComponet, _super);
-    function BasicComponet() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    return BasicComponet;
-}(Behaviour));
-exports.BasicComponet = BasicComponet;

package/test/csharp/codegen/basic/input.ts

@@ -1,2 +0,0 @@
-export class BasicComponet extends Behaviour {
-}