@needle-tools/needle-component-compiler 1.4.0 → 1.6.1

package/Changelog.md

@@ -4,7 +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.3.0] - 2022-07-06
+## [1.6.1] - 2022-07-10
+- add using ``types.json`` json file that will be generated from Unity
+- change ``@type`` annotiation to only work without braces to be consistent
+
+## [1.5.0] - 2022-07-07
+- change ``@type`` annotation to work with and without braces (e.g. ``@type My.Type`` or ``@type (My.Type)``)
+
+## [1.4.0] - 2022-07-06
 - add CODEGEN_START and END sections to allow adding code before or after a generated componnet
 - add ``@ifdef`` to ifdef fields 
 

package/Readme.md

@@ -11,4 +11,5 @@ Please run ``npm install`` first before using.
 - ``@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]``
-- ``@type(MyNamespace.MyType)`` decorator for fields or classes, specifiy C# type of field or class
+- ``@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.4.0",
+    "version": "1.6.1",
     "description": "Compile mock unity components from typescript",
     "main": "index.js",
     "scripts": {

package/src/component-compiler.js

@@ -4,6 +4,7 @@ exports.run = void 0;
 var fs_1 = require("fs");
 var ts = require("typescript");
 var fs = require("fs");
+var path = require("path");
 var types = require("./types");
 var dict = types.dict;
 // add either of these two comments above a class to enforce code gen or disable it for the next class
@@ -11,7 +12,8 @@ var exportNextClassCommand = "@generate-component";
 var dontExportNextClassCommand = "@dont-generate-component";
 // add above field to add [SerializeField] attribute
 var serializeCommand = "@serializeField";
-var typePattern = new RegExp("@type ?\((?<type>.+)\)");
+// https://regex101.com/r/ltpcKT/2
+var typePattern = new RegExp("@type ?(?<type>.+)");
 var ifdefPattern = new RegExp("@ifdef ?(?<ifdef>.+)");
 var CODEGEN_MARKER_START = "// NEEDLE_CODEGEN_START";
 var CODEGEN_MARKER_END = "// NEEDLE_CODEGEN_END";
@@ -23,6 +25,24 @@ function resetExportNextClass() {
     dontExportNextClass = false;
     exportNextClass = false;
 }
+var typesFileContent = undefined;
+function tryGetKnownType(str) {
+    if (typesFileContent === undefined) {
+        typesFileContent = null;
+        var filePath = path.dirname(__dirname) + "/src/types.json";
+        if (fs.existsSync(filePath)) {
+            console.log("Reading types file");
+            var content = fs.readFileSync(filePath, "utf8");
+            typesFileContent = JSON.parse(content);
+        }
+    }
+    if (typesFileContent) {
+        var fullType = typesFileContent[str];
+        console.log(fullType);
+        return fullType;
+    }
+    return null;
+}
 // https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API
 // const exportDir = "../dist";
 var commentStarts = [];
@@ -136,7 +156,7 @@ function run(program, outputDir, sourceFile) {
                     // so we remove them
                     var type = typeMatch.groups["type"];
                     type = type.replace(/\(/, "").replace(/\)/, "");
-                    console.log("found type: ", type);
+                    console.log("Found type: ", type);
                     lastTypeFound = type;
                 }
                 var ifdefMatch = ifdefPattern.exec(comment);
@@ -254,7 +274,8 @@ function run(program, outputDir, sourceFile) {
                 serializeField = false;
                 var dec = node;
                 // a class must inherit a component
-                if (!dontExportNextClass && (lastTypeFound || exportNextClass || testInheritsComponent(node))) {
+                var inheritsComponent = testInheritsComponent(node);
+                if (!dontExportNextClass && (lastTypeFound || exportNextClass || inheritsComponent)) {
                     resetExportNextClass();
                     var name_2 = (_d = dec.name) === null || _d === void 0 ? void 0 : _d.escapedText;
                     console.log("Found class: ", name_2);
@@ -270,6 +291,8 @@ function run(program, outputDir, sourceFile) {
                     newContext.indentLevel += 1;
                     // newContext.appendLine("// source: " + path.resolve(sourceFile.fileName));
                     var typeName = lastTypeFound !== null && lastTypeFound !== void 0 ? lastTypeFound : "UnityEngine.MonoBehaviour";
+                    if (typeof inheritsComponent === "string")
+                        typeName = inheritsComponent;
                     console.log(name_2 + " inherits " + typeName);
                     newContext.appendLine("public partial class " + name_2 + " : " + typeName);
                     newContext.appendLine("{");
@@ -293,10 +316,14 @@ function run(program, outputDir, sourceFile) {
                                 var type = _c[_b];
                                 // const symbol = program.getTypeChecker().getSymbolAtLocation(type.expression);
                                 // console.log(symbol);
-                                if (type.expression.getText() === "Component")
+                                var text = type.expression.getText();
+                                if (text === "Component")
                                     return true;
-                                if (type.expression.getText() === "Behaviour")
+                                if (text === "Behaviour")
                                     return true;
+                                var known = tryGetKnownType(text);
+                                if (known)
+                                    return known;
                             }
                         }
                     }
@@ -361,6 +388,9 @@ function run(program, outputDir, sourceFile) {
                 // console.log(node);
                 return res;
             }
+            var knownType = tryGetKnownType(typeName);
+            if (knownType)
+                return knownType;
             // console.log("Unknown type: " + typeName);
             switch (node.kind) {
                 case ts.SyntaxKind.SyntaxList:

package/src/component-compiler.ts

@@ -1,10 +1,9 @@
 import { readFileSync } from "fs";
 import * as ts from "typescript";
 import * as fs from "fs";
-import * as path from "path";
+import * as path from 'path';
 
 import * as types from "./types";
-import { traceDeprecation } from "process";
 const dict = types.dict;
 
 // add either of these two comments above a class to enforce code gen or disable it for the next class
@@ -12,7 +11,8 @@ const exportNextClassCommand = "@generate-component";
 const dontExportNextClassCommand = "@dont-generate-component";
 // add above field to add [SerializeField] attribute
 const serializeCommand = "@serializeField";
-const typePattern = new RegExp("@type ?\((?<type>.+)\)");
+// https://regex101.com/r/ltpcKT/2
+const typePattern = new RegExp("@type ?(?<type>.+)");
 const ifdefPattern = new RegExp("@ifdef ?(?<ifdef>.+)")
 
 const CODEGEN_MARKER_START = "// NEEDLE_CODEGEN_START";
@@ -28,6 +28,27 @@ function resetExportNextClass() {
 }
 
 
+let typesFileContent: object | undefined | null = undefined;
+function tryGetKnownType(str: string): string | null {
+
+    if (typesFileContent === undefined) {
+        typesFileContent = null;
+        const filePath = path.dirname(__dirname) + "/src/types.json";
+        if (fs.existsSync(filePath)) {
+            console.log("Reading types file");
+            const content = fs.readFileSync(filePath, "utf8");
+            typesFileContent = JSON.parse(content);
+        }
+    }
+
+    if (typesFileContent) {
+        const fullType = typesFileContent[str];
+        console.log(fullType);
+        return fullType;
+    }
+    return null;
+}
+
 // https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API
 
 // const exportDir = "../dist";
@@ -160,7 +181,7 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     // so we remove them
                     let type = typeMatch.groups["type"];
                     type = type.replace(/\(/, "").replace(/\)/, "");
-                    console.log("found type: ", type);
+                    console.log("Found type: ", type);
                     lastTypeFound = type;
                 }
 
@@ -260,13 +281,13 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     context.appendLine("[UnityEngine.SerializeField]");
                 }
                 let requireEndIf = false;
-                if(ifdefSections.length > 0){
+                if (ifdefSections.length > 0) {
                     requireEndIf = true;
                     context.appendLine("#ifdef " + ifdefSections.pop());
                 }
                 context.append(prefix + visibility + " " + typeString + " " + varName + assignment + ";\n");
                 lastTypeFound = null;
-                if(requireEndIf){
+                if (requireEndIf) {
                     context.appendLine("#endif");
                 }
                 break;
@@ -275,7 +296,8 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                 serializeField = false;
                 const dec = <ts.ClassDeclaration>node;
                 // a class must inherit a component
-                if (!dontExportNextClass && (lastTypeFound || exportNextClass || testInheritsComponent(node))) {
+                const inheritsComponent = testInheritsComponent(node);
+                if (!dontExportNextClass && (lastTypeFound || exportNextClass || inheritsComponent)) {
                     resetExportNextClass();
                     const name = dec.name?.escapedText;
                     console.log("Found class: ", name);
@@ -290,7 +312,8 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     newContext.appendLine("{");
                     newContext.indentLevel += 1;
                     // newContext.appendLine("// source: " + path.resolve(sourceFile.fileName));
-                    const typeName = lastTypeFound ?? "UnityEngine.MonoBehaviour";
+                    let typeName = lastTypeFound ?? "UnityEngine.MonoBehaviour";
+                    if (typeof inheritsComponent === "string") typeName = inheritsComponent;
                     console.log(name + " inherits " + typeName);
                     newContext.appendLine("public partial class " + name + " : " + typeName);
                     newContext.appendLine("{");
@@ -302,7 +325,7 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                 break;
         }
 
-        function testInheritsComponent(node: ts.Node): boolean {
+        function testInheritsComponent(node: ts.Node): boolean | string {
             switch (node.kind) {
                 case ts.SyntaxKind.ClassDeclaration:
                     const dec = <ts.ClassDeclaration>node;
@@ -312,8 +335,11 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                             for (const type of h.types) {
                                 // const symbol = program.getTypeChecker().getSymbolAtLocation(type.expression);
                                 // console.log(symbol);
-                                if (type.expression.getText() === "Component") return true;
-                                if (type.expression.getText() === "Behaviour") return true;
+                                const text = type.expression.getText();
+                                if (text === "Component") return true;
+                                if (text === "Behaviour") return true;
+                                const known = tryGetKnownType(text);
+                                if (known) return known;
                             }
                         }
                     }
@@ -380,6 +406,9 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                 // console.log(node);
                 return res;
             }
+            const knownType = tryGetKnownType(typeName);
+            if (knownType)
+                return knownType;
             // console.log("Unknown type: " + typeName);
 
             switch (node.kind) {

package/src/test.ts

@@ -2,20 +2,27 @@
 // import { Behaviour } from "needle.tiny.engine/engine-components/Component";
 // import { RoomEntity } from "./Room";
 
+import { Behaviour } from "needle.tiny.engine/engine-components/Component";
 
-namespace Hello.World
+export class MyNewScript extends DriveClient
 {
-    namespace Deep {
-        export class MyClass extends Behaviour {
-            //@ifdef TEST
-            public myFloat :number;
-        }
-    }
-}
+    //@type test
+    texture : RenderTexture;  
+}    
+
+// namespace Hello.World
+// {
+//     namespace Deep {
+//         export class MyClass extends Behaviour {
+//             //@ifdef TEST
+//             public myFloat :number;
+//         }
+//     }
+// }
 
-class OtherClass extends Behaviour {
+// class OtherClass extends Behaviour {
 
-}
+// }
 
 //@type (RoomEntity) 
 // export class NavigationManager extends RoomEntity {

package/dist/GltfExport.cs

@@ -1,11 +0,0 @@
-// auto generated code - do not edit
-namespace Needle.Typescript.GeneratedComponents
-{
-	// source: C:\git\needle-tiny-playground\modules\needle-tiny\component-compiler\src\test.ts
-	public class GltfExport : UnityEngine.MonoBehaviour
-	{
-		public bool @binary = true;
-		[UnityEngine.ContextMenu("enable this")]
-		public void test(){}
-	}
-}

package/dist/GltfExportBox.cs

@@ -1,11 +0,0 @@
-// auto generated code - do not edit
-namespace Needle.Typescript.GeneratedComponents
-{
-	// source: C:\git\needle-tiny-playground\modules\needle-tiny\component-compiler\src\test.ts
-	public class GltfExportBox : UnityEngine.MonoBehaviour
-	{
-		public UnityEngine.Transform @sceneRoot;
-		public void start(){}
-		public void updateGltfBox(){}
-	}
-}

package/dist/MaterialColorHandler.cs

@@ -1,11 +0,0 @@
-// auto generated code - do not edit
-
-#pragma warning disable
-
-namespace Needle.Typescript.GeneratedComponents
-{
-	public class MaterialColorHandler : UnityEngine.MonoBehaviour
-	{
-		public UnityEngine.Renderer[] @renderer;
-	}
-}

package/dist/MyArray.cs

@@ -1,8 +0,0 @@
-// auto generated code - do not edit
-namespace Needle.Typescript.GeneratedComponents
-{
-	public class MyArray : UnityEngine.MonoBehaviour
-	{
-		public float[] @arr = new float[]{ 1, 2, 3 };
-	}
-}

package/dist/MyClass.cs

@@ -1,16 +0,0 @@
-// NEEDLE_CODEGEN_START
-// auto generated code - do not edit directly
-
-#pragma warning disable
-
-namespace Hello.World.Deep
-{
-	public partial class MyClass : UnityEngine.MonoBehaviour
-	{
-		#ifdef TEST
-		public float @myFloat;
-		#endif
-	}
-}
-
-// NEEDLE_CODEGEN_END

package/dist/MyClassWithAFloat.cs

@@ -1,10 +0,0 @@
-// auto generated code - do not edit
-namespace Needle.Typescript.GeneratedComponents
-{
-	// source: C:\git\needle-tiny-playground\modules\needle-tiny\component-compiler\src\test.ts
-	public class MyClassWithAFloat : UnityEngine.MonoBehaviour
-	{
-		public float @myfloat = 0.5f;
-		private string @myString;
-	}
-}

package/dist/NavComponent.cs

@@ -1,13 +0,0 @@
-// auto generated code - do not edit directly
-
-#pragma warning disable
-
-namespace Needle.Typescript.GeneratedComponents
-{
-	public partial class NavComponent : UnityEngine.MonoBehaviour
-	{
-		public void next(){}
-		public void prev(){}
-		public void isAtEnd(){}
-	}
-}

package/dist/NavigationManager.cs

@@ -1,13 +0,0 @@
-// auto generated code - do not edit directly
-
-#pragma warning disable
-
-namespace Needle.Typescript.GeneratedComponents
-{
-	public partial class NavigationManager : RoomEntity 
-	{
-		public float @fl = 1f;
-		public void nav_forward(){}
-		public void nav_backward(){}
-	}
-}

package/dist/OtherClass.cs

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

package/dist/PointOfInterest.cs

@@ -1,14 +0,0 @@
-// auto generated code - do not edit directly
-
-#pragma warning disable
-
-namespace Needle.Typescript.GeneratedComponents
-{
-	public partial class PointOfInterest : UnityEngine.MonoBehaviour
-	{
-		public float @myVal = 12f;
-		public void myFunction(){}
-		public UnityEngine.Camera @view;
-		public string @test = "123";
-	}
-}

package/dist/PrivateSerializedField.cs

@@ -1,9 +0,0 @@
-// auto generated code - do not edit
-namespace Needle.Typescript.GeneratedComponents
-{
-	public class PrivateSerializedField : UnityEngine.MonoBehaviour
-	{
-		[UnityEngine.SerializeField]
-		private UnityEngine.Color @color;
-	}
-}

package/dist/Test.cs

@@ -1,8 +0,0 @@
-// auto generated code - do not edit
-namespace Needle.Typescript.GeneratedComponents
-{
-	// source: C:\git\needle-tiny-playground\projects\Compiled_Export\myProject\src\scripts\SomeTestComponent.ts
-	public class Test : UnityEngine.MonoBehaviour
-	{
-	}
-}

package/src/component.cs

@@ -1 +0,0 @@
-public class MyClass : MonoBehaviour {