Add ts-no-import-ext flag (#7748)

Co-authored-by: Derek Bailey <[email protected]>

Author: ink-su

include/flatbuffers/idl.h

@@ -659,6 +659,7 @@ struct IDLOptions {
   bool json_nested_flexbuffers;
   bool json_nested_legacy_flatbuffers;
   bool ts_flat_file;
+  bool ts_no_import_ext;
   bool no_leak_private_annotations;
   bool require_json_eof;
 
@@ -763,6 +764,7 @@ struct IDLOptions {
         json_nested_flexbuffers(true),
         json_nested_legacy_flatbuffers(false),
         ts_flat_file(false),
+        ts_no_import_ext(false),
         no_leak_private_annotations(false),
         require_json_eof(true),
         mini_reflect(IDLOptions::kNone),

src/flatc.cpp

@@ -613,6 +613,8 @@ int FlatCompiler::Compile(int argc, const char **argv) {
         opts.json_nested_legacy_flatbuffers = true;
       } else if (arg == "--ts-flat-files") {
         opts.ts_flat_file = true;
+      } else if (arg == "--ts-no-import-ext") {
+        opts.ts_no_import_ext = true;
       } else if (arg == "--no-leak-private-annotation") {
         opts.no_leak_private_annotations = true;
       } else if (arg == "--annotate") {

src/idl_gen_ts.cpp

@@ -256,15 +256,16 @@ class TsGenerator : public BaseGenerator {
           // specified here? Should we always be adding the "./" for a relative
           // path or turn it off if --include-prefix is specified, or something
           // else?
+          std::string import_extension = parser_.opts.ts_no_import_ext ? "" : ".js";
           std::string include_name =
-              "./" + flatbuffers::StripExtension(include_file);
+              "./" + flatbuffers::StripExtension(include_file) + import_extension;
           code += "import {";
           for (const auto &pair : it.second) {
             code += namer_.EscapeKeyword(pair.first) + " as " +
                     namer_.EscapeKeyword(pair.second) + ", ";
           }
           code.resize(code.size() - 2);
-          code += "} from '" + include_name + ".js';\n";
+          code += "} from '" + include_name + "';\n";
         }
         code += "\n";
       }
@@ -883,10 +884,11 @@ class TsGenerator : public BaseGenerator {
     import.object_name = object_name;
     import.bare_file_path = bare_file_path;
     import.rel_file_path = rel_file_path;
+    std::string import_extension = parser_.opts.ts_no_import_ext ? "" : ".js";
     import.import_statement = "import { " + symbols_expression + " } from '" +
-                              rel_file_path + ".js';";
+                              rel_file_path + import_extension + "';";
     import.export_statement = "export { " + symbols_expression + " } from '." +
-                              bare_file_path + ".js';";
+                              bare_file_path + import_extension + "';";
     import.dependency = &dependency;
     import.dependent = &dependent;
 

tests/ts/TypeScriptTest.py

@@ -84,6 +84,12 @@ def flatc(options, schema, prefix=None, include=None, data=None, cwd=tests_path)
     schema="../optional_scalars.fbs",
 )
 
+flatc(
+    options=["--ts", "--reflect-names", "--gen-name-strings", "--ts-no-import-ext"],
+    schema="../optional_scalars.fbs",
+    prefix="no_import_ext",
+)
+
 flatc(
     options=["--ts", "--reflect-names", "--gen-name-strings", "--gen-mutable", "--gen-object-api"],
     schema=[

tests/ts/no_import_ext/optional-scalars/optional-byte.js

@@ -0,0 +1,7 @@
+// automatically generated by the FlatBuffers compiler, do not modify
+export var OptionalByte;
+(function (OptionalByte) {
+    OptionalByte[OptionalByte["None"] = 0] = "None";
+    OptionalByte[OptionalByte["One"] = 1] = "One";
+    OptionalByte[OptionalByte["Two"] = 2] = "Two";
+})(OptionalByte || (OptionalByte = {}));

tests/ts/no_import_ext/optional-scalars/optional-byte.ts

@@ -0,0 +1,7 @@
+// automatically generated by the FlatBuffers compiler, do not modify
+
+export enum OptionalByte {
+  None = 0,
+  One = 1,
+  Two = 2
+}