Fix_typescript_generator_imports

Author: vvezre

generator/mavgen_typescript.py

@@ -9,6 +9,7 @@
 from . import mavtemplate
 
 t = mavtemplate.MAVTemplate()
+NODE_MAVLINK_PACKAGE = "@ifrunistuttgart/node-mavlink"
 
 
 def camelcase(str):
@@ -47,7 +48,7 @@ def generate_classes(dir, registry, msgs, xml):
         os.mkdir(dir)
 
     with open(registry, "w") as registry_f:
-        registry_f.write("import {MAVLinkMessage} from 'node-mavlink';\n")
+        registry_f.write(f"import {{MAVLinkMessage}} from '{NODE_MAVLINK_PACKAGE}';\n")
         for m in msgs:
             filename = m.name.replace('_', '-')
             filename = filename.lower()
@@ -60,8 +61,8 @@ def generate_classes(dir, registry, msgs, xml):
                 if xml.wire_protocol_version == '1.0':
                     raise Exception('WireProtocolException', 'Please use WireProtocol = 2.0 only.')
 
-                f.write("import {MAVLinkMessage} from 'node-mavlink';\n")
-                f.write("import {readInt64LE, readUInt64LE} from 'node-mavlink';\n")
+                f.write(f"import {{MAVLinkMessage}} from '{NODE_MAVLINK_PACKAGE}';\n")
+                f.write(f"import {{readInt64LE, readUInt64LE}} from '{NODE_MAVLINK_PACKAGE}';\n")
                 registry_f.write("import {{{}}} from './messages/{}';\n".format(camelcase(m.name), filename))
                 imported_enums = []
                 for enum in [field.enum for field in m.fields if field.enum != '']:

tests/test_mavgen_typescript.py

@@ -0,0 +1,41 @@
+#!/usr/bin/env python3
+"""
+Tests for the TypeScript generator.
+"""
+
+from pathlib import Path
+import shutil
+import sys
+
+try:
+    from pymavlink.generator import mavgen
+except ModuleNotFoundError:
+    sys.path.insert(0, str(Path(__file__).resolve().parents[1]))
+    from generator import mavgen
+
+
+def test_typescript_generator_uses_scoped_node_mavlink_package():
+    xml_filepath = Path(__file__).parent / "snapshottests" / "resources" / "common.xml"
+    output_dir = Path(__file__).resolve().parents[1] / ".tmp" / "typescript-generator"
+    shutil.rmtree(output_dir, ignore_errors=True)
+    output_dir.mkdir(parents=True, exist_ok=True)
+
+    ok = mavgen.mavgen(
+        mavgen.Opts(
+            output=str(output_dir),
+            language="TypeScript",
+            wire_protocol="2.0",
+            validate=False,
+        ),
+        [str(xml_filepath)],
+    )
+
+    assert ok is True
+
+    heartbeat = (output_dir / "messages" / "heartbeat.ts").read_text(encoding="utf-8")
+    registry = (output_dir / "message-registry.ts").read_text(encoding="utf-8")
+
+    assert "@ifrunistuttgart/node-mavlink" in heartbeat
+    assert "from 'node-mavlink'" not in heartbeat
+    assert "@ifrunistuttgart/node-mavlink" in registry
+    assert "from 'node-mavlink'" not in registry