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

package/test/codegen/public method with multiple args/output.cs

@@ -0,0 +1,14 @@
+// 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 myMethod(float @myNumber, float @myOtherNumber){}
+	}
+}
+
+// NEEDLE_CODEGEN_END

package/test/codegen/public.methods/expected.cs

@@ -0,0 +1,14 @@
+// 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 myMethod(){}
+	}
+    }
+    
+    // NEEDLE_CODEGEN_END

package/test/codegen/public.methods/input.js

@@ -0,0 +1,27 @@
+"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.myMethod = function () { };
+    return MyComponent;
+}(Behaviour));
+exports.MyComponent = MyComponent;

package/test/codegen/public.methods/input.ts

@@ -0,0 +1,3 @@
+export class MyComponent extends Behaviour {
+    public myMethod(): void {}
+}

package/test/codegen/public.methods/output.cs

@@ -0,0 +1,14 @@
+// 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 myMethod(){}
+	}
+}
+
+// NEEDLE_CODEGEN_END

package/test/codegen/static method/expected.cs

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

package/test/codegen/static method/input.js

@@ -0,0 +1,27 @@
+"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.myMethod = function () { };
+    return MyComponent;
+}(Behaviour));
+exports.MyComponent = MyComponent;

package/test/codegen/static method/input.ts

@@ -0,0 +1,3 @@
+export class MyComponent extends Behaviour {
+    public static myMethod(): void {}
+}

package/test/codegen/static method/output.cs

@@ -0,0 +1,14 @@
+// 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 myMethod(){}
+	}
+}
+
+// NEEDLE_CODEGEN_END

package/test/codegen/string/expected.cs

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

package/test/codegen/string/input.js

@@ -0,0 +1,26 @@
+"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;
+    }
+    return MyComponent;
+}(Behaviour));
+exports.MyComponent = MyComponent;

package/test/codegen/string/input.ts

@@ -0,0 +1,3 @@
+export class MyComponent extends Behaviour {
+    public myField: string;
+}

package/test/codegen/string/output.cs

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

package/test/codegen/stringArray/expected.cs

@@ -0,0 +1,14 @@
+// NEEDLE_CODEGEN_START
+    // auto generated code - do not edit directly
+    
+    #pragma warning disable
+    
+    namespace Needle.Typescript.GeneratedComponents
+    {
+    	public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public string[] @myField;
+	}
+    }
+    
+    // NEEDLE_CODEGEN_END

package/test/codegen/stringArray/input.js

@@ -0,0 +1,26 @@
+"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;
+    }
+    return MyComponent;
+}(Behaviour));
+exports.MyComponent = MyComponent;

package/test/codegen/stringArray/input.ts

@@ -0,0 +1,3 @@
+export class MyComponent extends Behaviour {
+    public myField: string[];
+}

package/test/codegen/stringArray/output.cs

@@ -0,0 +1,14 @@
+// NEEDLE_CODEGEN_START
+// auto generated code - do not edit directly
+
+#pragma warning disable
+
+namespace Needle.Typescript.GeneratedComponents
+{
+	public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+		public string[] @myField;
+	}
+}
+
+// NEEDLE_CODEGEN_END

package/test/component.basic.test.ts

@@ -0,0 +1,52 @@
+import { compareCodegen, compareCodegenWithDefaultContext } from './helpers';
+
+
+describe('Basic typescript', () => {
+
+  it('should generate component', () => {
+    compareCodegenWithDefaultContext("basic",
+      // INPUT
+      `export class BasicComponet extends Behaviour {
+}
+`,
+      // EXPECTED
+      `public partial class BasicComponet : UnityEngine.MonoBehaviour
+	{
+	}`
+    );
+  });
+
+
+
+  it('should not generate component', () => {
+    compareCodegen("basic-no-export",
+      // INPUT
+      `
+      //@dont-generate-component
+      export class BasicComponet extends Behaviour {
+}
+`,
+      // EXPECTED
+      ``
+    );
+  });
+
+
+
+  
+  it('should ignore abstract type', () => {
+    compareCodegen("basic-no-export",
+      // INPUT
+      `
+      //@dont-generate-component
+      export abstract class BasicComponet extends Behaviour {
+}
+`,
+      // EXPECTED
+      ``
+    );
+  });
+
+
+});
+

package/test/component.methods.test.ts

@@ -0,0 +1,185 @@
+import { compareCodegen, compareCodegenWithDefaultContext } from './helpers';
+
+
+describe('Typescript with public methods', () => {
+
+
+  it('should generate component with public method', () => {
+    compareCodegenWithDefaultContext("public.methods",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    public myMethod(): void {}
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public void myMethod(){}
+	}`
+    );
+  });
+
+
+
+  it('should generate component method and number args', () => {
+    compareCodegenWithDefaultContext("public method with args",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    public myMethod(myNumber: number): void {}
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public void myMethod(float @myNumber){}
+	}`
+    );
+  });
+
+
+
+  it('should generate component method and multiple number args', () => {
+    compareCodegenWithDefaultContext("public method with multiple args",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    public myMethod(myNumber: number, myOtherNumber : number): void {}
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public void myMethod(float @myNumber, float @myOtherNumber){}
+	}`
+    );
+  });
+
+
+
+  // https://github.com/needle-tools/needle-tiny-component-compiler/issues/11
+  it('should generate component method but ignore inline type declaration', () => {
+    compareCodegenWithDefaultContext("method ignore inline type declaration",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    public myMethod(myNumber: { x : number, y:number, z : number}): void {}
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public void myMethod(object @myNumber){}
+	}`
+    );
+  });
+
+
+});
+
+
+
+
+describe('Typescript with private or protected methods', () => {
+
+
+  // https://github.com/needle-tools/needle-tiny-component-compiler/issues/13
+  it('should ignore private method', () => {
+    compareCodegenWithDefaultContext("private.methods",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    private myMethod(): void {}
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+	}`
+    );
+  });
+
+
+  // https://github.com/needle-tools/needle-tiny-component-compiler/issues/13
+  it('should ignore protected method', () => {
+    compareCodegenWithDefaultContext("protected.methods",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    protected myMethod(): void {}
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+	}`
+    );
+  });
+
+});
+
+
+
+describe('Typescript with methods', () => {
+
+
+  it('should not generate static method', () => {
+    compareCodegenWithDefaultContext("static method",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    public static myMethod(): void {}
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+	}`
+    );
+  });
+
+
+  it('should not generate abstract method', () => {
+    compareCodegenWithDefaultContext("abstract method",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    public abstract myMethod(): void {}
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+	}`
+    );
+  });
+
+
+
+  it('should convert onEnable to OnEnable', () => {
+    compareCodegenWithDefaultContext("abstract method",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+      onEnable() {}
+    }
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public void OnEnable(){}
+	}`
+    );
+  });
+
+
+  it('should convert onDisable to OnDisable', () => {
+    compareCodegenWithDefaultContext("abstract method",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+      onDisable() {}
+    }
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public void OnDisable(){}
+	}`
+    );
+  });
+
+});

package/test/component.nonserialized.test.ts

@@ -0,0 +1,45 @@
+import { compareCodegen, compareCodegenWithDefaultContext } from './helpers';
+
+
+describe('Typescript with nonSerialized', () => {
+
+
+  it('should ignore field', () => {
+    compareCodegenWithDefaultContext("nonserialized ignore field",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+        //@nonSerialized
+    public myField: number;
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+	}`
+    );
+  });
+
+
+// https://github.com/needle-tools/needle-tiny-component-compiler/issues/14
+  it('should not affect next method', () => {
+    compareCodegenWithDefaultContext("nonserialized on property does not affect method",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+        //@nonSerialized
+    public get myField(): number { return 0; }
+
+    public myMethod() {
+
+    }
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public void myMethod() {}
+	}`
+    );
+  });
+
+
+});

package/test/component.primitives.test.ts

@@ -0,0 +1,121 @@
+import { compareCodegen, compareCodegenWithDefaultContext } from './helpers';
+
+
+describe('Typescript with fields', () => {
+
+
+  it('should generate component with number', () => {
+    compareCodegenWithDefaultContext("number",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    public myField: number;
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public float @myField;
+	}`
+    );
+  });
+
+
+
+  it('should generate component with string', () => {
+    compareCodegenWithDefaultContext("string",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    public myField: string;
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public string @myField;
+	}`
+    );
+  });
+
+
+
+
+  it('should generate component with string array', () => {
+    compareCodegenWithDefaultContext("stringArray",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    public myField: string[];
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public string[] @myField;
+	}`
+    );
+  });
+
+
+
+
+  it('should generate component with boolean', () => {
+    compareCodegenWithDefaultContext("bool",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    public myField: boolean;
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public bool @myField;
+	}`
+    );
+  });
+
+
+
+
+  it('should generate component with object', () => {
+    compareCodegenWithDefaultContext("object",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    public myField: object;
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public UnityEngine.Object @myField;
+	}`
+    );
+  });
+
+
+  
+
+  it('should generate component with default values', () => {
+    compareCodegenWithDefaultContext("fields with default values",
+      // INPUT
+      `export class MyComponent extends Behaviour {
+    public myField: number = 42;
+    public myField2: string = "hello";
+    public myField3: boolean = true;
+    public myField4: object = null;
+}
+`,
+      // EXPECTED
+      `public partial class MyComponent : UnityEngine.MonoBehaviour
+	{
+    public float @myField = 42f;
+    public string @myField2 = "hello";
+    public bool @myField3 = true;
+    public UnityEngine.Object @myField4 = null;
+	}`
+    );
+  });
+
+
+
+
+
+});