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

package/Changelog.md

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

package/package.json

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

package/src/component-compiler.js

@@ -242,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 = "";
@@ -280,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;
@@ -501,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;

package/src/component-compiler.ts

@@ -280,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 = "";
@@ -312,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;
@@ -522,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;
         }

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,6 +46,11 @@ 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;
+	}`
+    );
+  });
+
+
+
 });