@needle-tools/needle-component-compiler 1.0.1 → 1.1.0

package/Changelog.md

@@ -4,6 +4,12 @@ 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.1.0] - 2022-06-13
+- add ``@type(MyNamespace.MyType)`` decorator for fields to specifiy C# type
+- add minimal docs to readme
+- dont emit comments anymore
+- make created classes partial
+
 ## [1.0.1] - 2022-05-29
 - disable all warnings for generated scripts
 - add mesh and texture types

package/Readme.md

@@ -4,4 +4,11 @@ Little helper package to transpile typescript files to Unity C# components.
 Please run ``npm install`` first before using.
 
 ### Usage
-``node <path to>/component-compiler.js <output_directory> <path_to/my_script.ts>``
+``node <path to>/component-compiler.js <output_directory> <path_to/my_script.ts>``
+
+
+### Command decorators
+- ``@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)`` field decorator, specifiy C# type of field

package/dist/PointOfInterest.cs

@@ -0,0 +1,14 @@
+// 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/package.json

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

package/src/component-compiler.js

@@ -11,6 +11,7 @@ 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>.+)\)");
 // will be set to true when e.g. a comment for export is found
 var exportNextClass = false;
 var dontExportNextClass = false;
@@ -65,6 +66,7 @@ var ExportContext = /** @class */ (function () {
     return ExportContext;
 }());
 var contexts = [];
+var lastTypeFound = null;
 function run(program, outputDir, sourceFile) {
     if (!fs.existsSync(outputDir)) {
         console.error("Output directory does not exist: \"" + outputDir + "\"");
@@ -105,8 +107,21 @@ function run(program, outputDir, sourceFile) {
                     }
                     else if (comment.includes(serializeCommand))
                         serializeField = true;
-                    else
-                        context.appendLine(comment);
+                    else {
+                        console.log(comment);
+                        var match = typePattern.exec(comment);
+                        if (match && match.groups) {
+                            // for some reason our regex does also match surrounding ( ) even tho: https://regex101.com/r/PoWK6V/1
+                            // so we remove them
+                            var type = match.groups["type"];
+                            if (type.startsWith("("))
+                                type = type.slice(1);
+                            if (type.endsWith(")"))
+                                type = type.slice(0, -1);
+                            console.log("found type: ", type);
+                            lastTypeFound = type;
+                        }
+                    }
                 }
                 if (comment.includes(exportNextClassCommand))
                     exportNextClass = true;
@@ -122,6 +137,7 @@ function run(program, outputDir, sourceFile) {
             case ts.SyntaxKind.Decorator:
                 break;
             case ts.SyntaxKind.MethodDeclaration:
+                lastTypeFound = null;
                 serializeField = false;
                 resetExportNextClass();
                 if (!context)
@@ -158,7 +174,7 @@ function run(program, outputDir, sourceFile) {
                 console.log(name_1);
                 if (name_1.startsWith("\"@") || name_1.startsWith("\"$") || name_1.startsWith("$"))
                     break;
-                var typeString = tryResolveTypeRecursive(node);
+                var typeString = lastTypeFound !== null && lastTypeFound !== void 0 ? lastTypeFound : tryResolveTypeRecursive(node);
                 if (typeString === undefined) {
                     context.append("// Could not resolve type \"" + ((_c = vardec.type) === null || _c === void 0 ? void 0 : _c.getText()) + "\"\n");
                 }
@@ -197,9 +213,11 @@ function run(program, outputDir, sourceFile) {
                     context.appendLine("[UnityEngine.SerializeField]");
                 }
                 context.append(prefix + visibility + " " + typeString + " " + varName + assignment + ";\n");
+                lastTypeFound = null;
                 break;
             case ts.SyntaxKind.ClassDeclaration:
                 serializeField = false;
+                lastTypeFound = null;
                 var dec = node;
                 // a class must inherit a component
                 if (!dontExportNextClass && (exportNextClass || testInheritsComponent(node))) {
@@ -207,7 +225,7 @@ function run(program, outputDir, sourceFile) {
                     var name_2 = dec.name.escapedText;
                     console.log("Found class: ", name_2);
                     var newContext = new ExportContext(outputDir, name_2 + ".cs");
-                    newContext.appendLine("// auto generated code - do not edit");
+                    newContext.appendLine("// auto generated code - do not edit directly");
                     newContext.appendLine("");
                     newContext.appendLine("#pragma warning disable");
                     newContext.appendLine("");
@@ -215,7 +233,7 @@ function run(program, outputDir, sourceFile) {
                     newContext.appendLine("{");
                     newContext.indentLevel += 1;
                     // newContext.appendLine("// source: " + path.resolve(sourceFile.fileName));
-                    newContext.appendLine("public class " + name_2 + " : UnityEngine.MonoBehaviour");
+                    newContext.appendLine("public partial class " + name_2 + " : UnityEngine.MonoBehaviour");
                     newContext.appendLine("{");
                     newContext.indentLevel += 1;
                     newContext.classEnd = dec.end;

package/src/component-compiler.ts

@@ -11,6 +11,7 @@ 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>.+)\)");
 
 // will be set to true when e.g. a comment for export is found
 let exportNextClass: boolean = false;
@@ -80,6 +81,8 @@ class ExportContext {
 
 const contexts: ExportContext[] = [];
 
+let lastTypeFound : string | null = null;
+
 export function run(program: ts.Program, outputDir: string, sourceFile: ts.SourceFile) {
 
     if (!fs.existsSync(outputDir)) {
@@ -125,8 +128,19 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     }
                     else if (comment.includes(serializeCommand))
                         serializeField = true;
-                    else
-                        context.appendLine(comment);
+                    else {
+                        console.log(comment);
+                        const match = typePattern.exec(comment);
+                        if(match && match.groups){
+                            // for some reason our regex does also match surrounding ( ) even tho: https://regex101.com/r/PoWK6V/1
+                            // so we remove them
+                            let type = match.groups["type"];
+                            if(type.startsWith("(")) type = type.slice(1);
+                            if(type.endsWith(")")) type = type.slice(0, -1);
+                            console.log("found type: ", type);
+                            lastTypeFound = type;
+                        }
+                    }
                 }
                 if (comment.includes(exportNextClassCommand))
                     exportNextClass = true;
@@ -143,6 +157,7 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
             case ts.SyntaxKind.Decorator:
                 break;
             case ts.SyntaxKind.MethodDeclaration:
+                lastTypeFound = null;
                 serializeField = false;
                 resetExportNextClass();
                 if (!context) break;
@@ -174,7 +189,7 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                 const name = vardec.name.getText();
                 console.log(name);
                 if (name.startsWith("\"@") || name.startsWith("\"$") || name.startsWith("$")) break;
-                let typeString = tryResolveTypeRecursive(node);
+                let typeString = lastTypeFound ?? tryResolveTypeRecursive(node);
                 if (typeString === undefined) {
                     context.append("// Could not resolve type \"" + vardec.type?.getText() + "\"\n");
                 }
@@ -212,10 +227,12 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     context.appendLine("[UnityEngine.SerializeField]");
                 }
                 context.append(prefix + visibility + " " + typeString + " " + varName + assignment + ";\n");
+                lastTypeFound = null;
                 break;
 
             case ts.SyntaxKind.ClassDeclaration:
                 serializeField = false;
+                lastTypeFound = null;
                 const dec = <ts.ClassDeclaration>node;
                 // a class must inherit a component
                 if (!dontExportNextClass && (exportNextClass || testInheritsComponent(node))) {
@@ -231,7 +248,7 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     newContext.appendLine("{");
                     newContext.indentLevel += 1;
                     // newContext.appendLine("// source: " + path.resolve(sourceFile.fileName));
-                    newContext.appendLine("public class " + name + " : UnityEngine.MonoBehaviour");
+                    newContext.appendLine("public partial class " + name + " : UnityEngine.MonoBehaviour");
                     newContext.appendLine("{");
                     newContext.indentLevel += 1;
                     newContext.classEnd = dec.end;
@@ -278,7 +295,7 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
             if (!node) return undefined;
 
             // skip decorators (e.g. @serializable() may break array generation)
-            if(node.kind === ts.SyntaxKind.Decorator) 
+            if (node.kind === ts.SyntaxKind.Decorator)
                 return undefined;
 
             let typeName = node?.getText();
@@ -326,12 +343,11 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                 console.log("Child type: " + ts.SyntaxKind[child.kind]);
                 res = tryResolveTypeRecursive(child);
             }
-            
-            if(ts.isTypeReferenceNode(node)){
+
+            if (ts.isTypeReferenceNode(node)) {
                 const typeRef = node as ts.TypeReferenceNode;
                 const typeName = typeRef.typeName.getText();
-                switch(typeName)
-                {
+                switch (typeName) {
                     case "Array":
                         res += "[]";
                         return res;

package/src/test.ts

@@ -2,12 +2,27 @@
 // @generate-component
 
 
-export class MaterialColorHandler extends Behaviour {
+export class PointOfInterest extends Behaviour {
 
-    @serializeable(Renderer)
-    renderer?: Renderer[];
+    myVal:number = 12;
+    
+    // @type(HELLO)
+    myFunction(){
+
+    }
+
+    // @type(UnityEngine.Camera)
+    view?:Camera;
+    test:string = "123";
+    // test
 }
 
+// export class MaterialColorHandler extends Behaviour {
+
+//     @serializeable(Renderer)
+//     renderer?: Renderer[];
+// }
+
 // export class MyArray extends Behaviour {
     
 //     arr? : Array<number> = [1,2,3];