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

package/Changelog.md

@@ -4,6 +4,10 @@ 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
+- add CODEGEN_START and END sections to allow adding code before or after a generated componnet
+- add ``@ifdef`` to ifdef fields 
+
 ## [1.3.0] - 2022-06-27
 - add support for typescript namespace
 

package/dist/MyClass.cs

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

package/dist/OtherClass.cs

@@ -1,3 +1,8 @@
+
+// I can edit this
+
+
+// NEEDLE_CODEGEN_START
 // auto generated code - do not edit directly
 
 #pragma warning disable
@@ -8,3 +13,5 @@ namespace Needle.Typescript.GeneratedComponents
 	{
 	}
 }
+
+// NEEDLE_CODEGEN_END

package/package.json

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

package/src/component-compiler.js

@@ -12,6 +12,9 @@ var dontExportNextClassCommand = "@dont-generate-component";
 // add above field to add [SerializeField] attribute
 var serializeCommand = "@serializeField";
 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";
 // will be set to true when e.g. a comment for export is found
 var exportNextClass = false;
 var dontExportNextClass = false;
@@ -51,10 +54,8 @@ var ExportContext = /** @class */ (function () {
         if (this.textBuffer.length <= 0)
             return;
         var dir = this.outputDir + "/";
-        if (!fs.existsSync(dir)) {
-            fs.mkdirSync(dir);
-        }
         var path = dir + this.fileName;
+        this.replaceGeneratedCodeSection(path);
         console.log("Write to " + path);
         fs.writeFileSync(path, this.textBuffer);
         this.reset();
@@ -63,10 +64,25 @@ var ExportContext = /** @class */ (function () {
         this.textBuffer = "";
         this.classEnd = -1;
     };
+    ExportContext.prototype.replaceGeneratedCodeSection = function (path) {
+        this.textBuffer = CODEGEN_MARKER_START + "\n" + this.textBuffer + "\n" + CODEGEN_MARKER_END;
+        if (fs.existsSync(path)) {
+            var existing = fs.readFileSync(path, "utf8");
+            var regex = new RegExp("(?<before>.*?)\/\/ ?NEEDLE_CODEGEN_START.+\/\/ ?NEEDLE_CODEGEN_END(?<after>.*)", "s");
+            var matches = regex.exec(existing);
+            if (matches === null || matches === void 0 ? void 0 : matches.groups) {
+                console.log("Found codegen sections");
+                var before = matches.groups.before;
+                var after = matches.groups.after;
+                this.textBuffer = before + this.textBuffer + after;
+            }
+        }
+    };
     return ExportContext;
 }());
 var contexts = [];
 var lastTypeFound = null;
+var ifdefSections = [];
 function run(program, outputDir, sourceFile) {
     if (!fs.existsSync(outputDir)) {
         console.error("Output directory does not exist: \"" + outputDir + "\"");
@@ -114,15 +130,21 @@ function run(program, outputDir, sourceFile) {
                     exportNextClass = true;
                 if (comment.includes(dontExportNextClassCommand))
                     dontExportNextClass = true;
-                var match = typePattern.exec(comment);
-                if (match && match.groups) {
+                var typeMatch = typePattern.exec(comment);
+                if (typeMatch && typeMatch.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"];
+                    var type = typeMatch.groups["type"];
                     type = type.replace(/\(/, "").replace(/\)/, "");
                     console.log("found type: ", type);
                     lastTypeFound = type;
                 }
+                var ifdefMatch = ifdefPattern.exec(comment);
+                if (ifdefMatch && ifdefMatch.groups) {
+                    var ifdef = ifdefMatch.groups["ifdef"];
+                    if (ifdef)
+                        ifdefSections.push(ifdef);
+                }
             }
         }
         switch (node.kind) {
@@ -217,8 +239,16 @@ function run(program, outputDir, sourceFile) {
                     console.log("SERIALIZE");
                     context.appendLine("[UnityEngine.SerializeField]");
                 }
+                var requireEndIf = false;
+                if (ifdefSections.length > 0) {
+                    requireEndIf = true;
+                    context.appendLine("#ifdef " + ifdefSections.pop());
+                }
                 context.append(prefix + visibility + " " + typeString + " " + varName + assignment + ";\n");
                 lastTypeFound = null;
+                if (requireEndIf) {
+                    context.appendLine("#endif");
+                }
                 break;
             case ts.SyntaxKind.ClassDeclaration:
                 serializeField = false;

package/src/component-compiler.ts

@@ -13,6 +13,10 @@ const dontExportNextClassCommand = "@dont-generate-component";
 // add above field to add [SerializeField] attribute
 const serializeCommand = "@serializeField";
 const typePattern = new RegExp("@type ?\((?<type>.+)\)");
+const ifdefPattern = new RegExp("@ifdef ?(?<ifdef>.+)")
+
+const CODEGEN_MARKER_START = "// NEEDLE_CODEGEN_START";
+const CODEGEN_MARKER_END = "// NEEDLE_CODEGEN_END";
 
 // will be set to true when e.g. a comment for export is found
 let exportNextClass: boolean = false;
@@ -65,10 +69,8 @@ class ExportContext {
     flush() {
         if (this.textBuffer.length <= 0) return;
         const dir = this.outputDir + "/";
-        if (!fs.existsSync(dir)) {
-            fs.mkdirSync(dir);
-        }
         const path = dir + this.fileName;
+        this.replaceGeneratedCodeSection(path);
         console.log("Write to " + path);
         fs.writeFileSync(path, this.textBuffer);
         this.reset();
@@ -78,11 +80,27 @@ class ExportContext {
         this.textBuffer = "";
         this.classEnd = -1;
     }
+
+    private replaceGeneratedCodeSection(path: string) {
+        this.textBuffer = CODEGEN_MARKER_START + "\n" + this.textBuffer + "\n" + CODEGEN_MARKER_END;
+        if (fs.existsSync(path)) {
+            const existing = fs.readFileSync(path, "utf8");
+            const regex = new RegExp("(?<before>.*?)\/\/ ?NEEDLE_CODEGEN_START.+\/\/ ?NEEDLE_CODEGEN_END(?<after>.*)", "s");
+            const matches = regex.exec(existing);
+            if (matches?.groups) {
+                console.log("Found codegen sections")
+                const before = matches.groups.before;
+                const after = matches.groups.after;
+                this.textBuffer = before + this.textBuffer + after;
+            }
+        }
+    }
 }
 
 const contexts: ExportContext[] = [];
 
 let lastTypeFound: string | null = null;
+let ifdefSections: string[] = [];
 
 export function run(program: ts.Program, outputDir: string, sourceFile: ts.SourceFile) {
 
@@ -136,15 +154,22 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     exportNextClass = true;
                 if (comment.includes(dontExportNextClassCommand))
                     dontExportNextClass = true;
-                const match = typePattern.exec(comment);
-                if (match && match.groups) {
+                const typeMatch = typePattern.exec(comment);
+                if (typeMatch && typeMatch.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"];
+                    let type = typeMatch.groups["type"];
                     type = type.replace(/\(/, "").replace(/\)/, "");
                     console.log("found type: ", type);
                     lastTypeFound = type;
                 }
+
+                const ifdefMatch = ifdefPattern.exec(comment);
+                if (ifdefMatch && ifdefMatch.groups) {
+                    const ifdef = ifdefMatch.groups["ifdef"];
+                    if (ifdef)
+                        ifdefSections.push(ifdef);
+                }
             }
         }
 
@@ -234,8 +259,16 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                     console.log("SERIALIZE");
                     context.appendLine("[UnityEngine.SerializeField]");
                 }
+                let requireEndIf = false;
+                if(ifdefSections.length > 0){
+                    requireEndIf = true;
+                    context.appendLine("#ifdef " + ifdefSections.pop());
+                }
                 context.append(prefix + visibility + " " + typeString + " " + varName + assignment + ";\n");
                 lastTypeFound = null;
+                if(requireEndIf){
+                    context.appendLine("#endif");
+                }
                 break;
 
             case ts.SyntaxKind.ClassDeclaration:
@@ -313,7 +346,7 @@ export function run(program: ts.Program, outputDir: string, sourceFile: ts.Sourc
                             case ts.SyntaxKind.Identifier:
                                 const id = ch as ts.Identifier;
                                 if (id.text) {
-                                    if(!namespace) namespace = "";
+                                    if (!namespace) namespace = "";
                                     namespace = id.text + (namespace ? "." : "") + namespace;
                                 }
                                 break;

package/src/test.ts

@@ -7,7 +7,8 @@ namespace Hello.World
 {
     namespace Deep {
         export class MyClass extends Behaviour {
-    
+            //@ifdef TEST
+            public myFloat :number;
         }
     }
 }