Add ts_flat_file implemented using esbuild automation

google · Oct 4, 2022 · 6a38fce · 6a38fce
1 parent 7cd67b5
commit 6a38fce
Show file tree

Hide file tree

Showing 7 changed files with 1,690 additions and 7 deletions.
diff --git a/include/flatbuffers/idl.h b/include/flatbuffers/idl.h
@@ -632,6 +632,7 @@ struct IDLOptions {
   bool json_nested_flatbuffers;
   bool json_nested_flexbuffers;
   bool json_nested_legacy_flatbuffers;
+  bool ts_flat_file;
   bool ts_entry_points;
   bool no_leak_private_annotations;
 
@@ -732,6 +733,7 @@ struct IDLOptions {
         json_nested_flatbuffers(true),
         json_nested_flexbuffers(true),
         json_nested_legacy_flatbuffers(false),
+        ts_flat_file(false),
         ts_entry_points(false),
         no_leak_private_annotations(false),
         mini_reflect(IDLOptions::kNone),

diff --git a/src/flatc.cpp b/src/flatc.cpp
@@ -217,8 +217,10 @@ const static FlatCOption options[] = {
   { "", "json-nested-bytes", "",
     "Allow a nested_flatbuffer field to be parsed as a vector of bytes"
     "in JSON, which is unsafe unless checked by a verifier afterwards." },
-  { "", "ts-flat-files", "",
-    "Only generated one typescript file per .fbs file." },
+  { "", "ts_flat_file", "",
+    "Generate a single typescript file per .fbs file. Implies ts_entry_points." },
+  { "", "ts_entry_points", "",
+    "Generate entry point typescript per namespace. Implies gen-all." },
   { "", "annotate", "SCHEMA",
     "Annotate the provided BINARY_FILE with the specified SCHEMA file." },
   { "", "no-leak-private-annotation", "",
@@ -597,6 +599,10 @@ int FlatCompiler::Compile(int argc, const char **argv) {
         opts.cs_global_alias = true;
       } else if (arg == "--json-nested-bytes") {
         opts.json_nested_legacy_flatbuffers = true;
+      } else if (arg == "--ts_flat_file") {
+        opts.ts_flat_file = true;
+        opts.ts_entry_points = true;
+        opts.generate_all = true;
       } else if (arg == "--ts_entry_points") {
         opts.ts_entry_points = true;
         opts.generate_all = true;

diff --git a/src/idl_gen_ts.cpp b/src/idl_gen_ts.cpp
@@ -109,6 +109,7 @@ class TsGenerator : public BaseGenerator {
     generateEnums();
     generateStructs();
     generateEntry();
+    generateBundle();
     return true;
   }
 
@@ -271,6 +272,33 @@ class TsGenerator : public BaseGenerator {
     }
   }
 
+  void generateBundle() {
+    if (parser_.opts.ts_flat_file) {
+      std::string inputpath;
+      std::string symbolic_name = file_name_;
+      if (parser_.current_namespace_->components.size() > 0) {
+        std::string path = namer_.Directories(*parser_.current_namespace_,
+                                  SkipDir::OutputPathAndTrailingPathSeparator);
+        inputpath = path + ".ts";
+        symbolic_name = parser_.current_namespace_->components.back();
+      } else {
+        inputpath = file_name_ + ".ts";
+      }
+      const std::string bundlepath =
+            GeneratedFileName(path_, file_name_, parser_.opts);
+      std::string cmd = "esbuild";
+      cmd += " ";
+      cmd += inputpath;
+      cmd += " --minify";
+      cmd += " --bundle --outfile=";
+      cmd += bundlepath;
+      cmd += " --global-name=";
+      cmd += symbolic_name;
+      cmd += " --external:flatbuffers";
+      system(cmd.c_str());
+    }
+  }
+
   // Generate a documentation comment, if available.
   static void GenDocComment(const std::vector<std::string> &dc,
                             std::string *code_ptr,

diff --git a/tests/ts/TypeScriptTest.py b/tests/ts/TypeScriptTest.py
@@ -61,7 +61,7 @@ def flatc(options, schema, prefix=None, include=None, data=None, cwd=tests_path)
 
 print("Invoking flatc...")
 flatc(
-    options=["--ts", "--reflect-names", "--gen-name-strings", "--gen-mutable", "--gen-object-api", '--ts_entry_points'],
+    options=["--ts", "--reflect-names", "--gen-name-strings", "--gen-mutable", "--gen-object-api", '--ts_entry_points', '--ts_flat_file'],
     schema="../monster_test.fbs",
     include="../include_test",
 )
@@ -85,7 +85,7 @@ def flatc(options, schema, prefix=None, include=None, data=None, cwd=tests_path)
 )
 
 flatc(
-    options=["--ts", "--reflect-names", "--gen-name-strings", "--gen-mutable", "--gen-object-api", '--ts_entry_points'],
+    options=["--ts", "--reflect-names", "--gen-name-strings", "--gen-mutable", "--gen-object-api"],
     schema=[
         "typescript_keywords.fbs",
         "test_dir/typescript_include.fbs",
@@ -102,7 +102,6 @@ def flatc(options, schema, prefix=None, include=None, data=None, cwd=tests_path)
         "--gen-name-strings",
         "--gen-mutable",
         "--gen-object-api",
-        "--ts_entry_points"
     ],
     schema=[
         "typescript_keywords.fbs",

diff --git a/tests/ts/monster_test_generated.ts b/tests/ts/monster_test_generated.ts
diff --git a/tests/ts/reflection.ts b/tests/ts/reflection.ts
@@ -4,11 +4,11 @@ export { Schema } from './reflection/schema.js';
 export { SchemaFile } from './reflection/schema-file.js';
 export { Service } from './reflection/service.js';
 export { RPCCall } from './reflection/rpccall.js';
-export { Field } from './reflection/field.js';
 export { Object } from './reflection/object.js';
+export { Enum } from './reflection/enum.js';
 export { EnumVal } from './reflection/enum-val.js';
 export { KeyValue } from './reflection/key-value.js';
-export { Enum } from './reflection/enum.js';
+export { Field } from './reflection/field.js';
 export { Type } from './reflection/type.js';
 export { AdvancedFeatures } from './reflection/advanced-features.js';
 export { BaseType } from './reflection/base-type.js';