@foxglove/schemas 0.2.0 → 0.5.0

package/src/generateRos.ts

@@ -36,10 +36,12 @@ function primitiveToRos(
 
 export function generateRosMsg(def: RosMsgDefinitionWithDescription): string {
   let source = "";
-  source += `# Generated from ${def.originalName} by @foxglove/schemas\n`;
+  source += `# ${def.rosFullInterfaceName}\n`;
   if (def.description != undefined) {
     source += `# ${def.description}\n`;
   }
+  source += `\n# Generated by https://github.com/foxglove/schemas\n`;
+
   let prevFieldHadComment = true; // start true because of top-of-file comment
   for (const field of def.fields) {
     if (prevFieldHadComment || field.description != undefined) {
@@ -187,6 +189,7 @@ export function generateRosMsgDefinition(
     rosMsgInterfaceName: `foxglove_msgs/${schema.name}`,
     rosFullInterfaceName:
       rosVersion === 2 ? `foxglove_msgs/msg/${schema.name}` : `foxglove_msgs/${schema.name}`,
+    description: schema.description,
     fields,
   };
 }

package/src/generateTypeScript.test.ts

@@ -4,7 +4,7 @@ import { exampleEnum, exampleMessage } from "./testFixtures";
 describe("generateTypeScript", () => {
   it("generates .d.ts files", () => {
     expect(generateTypeScript(exampleEnum)).toMatchInlineSnapshot(`
-      "// Generated from ExampleEnum by @foxglove/schemas
+      "// Generated by https://github.com/foxglove/schemas
 
       /** An example enum */
       export enum ExampleEnum {
@@ -17,7 +17,7 @@ describe("generateTypeScript", () => {
       "
     `);
     expect(generateTypeScript(exampleMessage)).toMatchInlineSnapshot(`
-      "// Generated from ExampleMessage by @foxglove/schemas
+      "// Generated by https://github.com/foxglove/schemas
 
       import { Duration } from \\"./Duration\\";
       import { ExampleEnum } from \\"./ExampleEnum\\";

package/src/generateTypeScript.ts

@@ -92,7 +92,7 @@ export function generateTypeScript(schema: FoxgloveSchema): string {
   }
 
   const outputSections = [
-    `// Generated from ${schema.name} by @foxglove/schemas`,
+    `// Generated by https://github.com/foxglove/schemas`,
 
     Array.from(imports)
       .sort()

package/src/schemas.test.ts

@@ -1,4 +1,5 @@
 import { foxgloveEnumSchemas, foxgloveMessageSchemas } from "./schemas";
+import { FoxgloveMessageSchema } from "./types";
 
 describe("schemas", () => {
   it("has matching names", () => {
@@ -11,6 +12,24 @@ describe("schemas", () => {
     }
   });
 
+  const allSchemas = new Set<FoxgloveMessageSchema>();
+  function addNestedSchemas(schema: FoxgloveMessageSchema, schemas: Set<FoxgloveMessageSchema>) {
+    if (schemas.has(schema)) {
+      return;
+    }
+    schemas.add(schema);
+    for (const field of schema.fields) {
+      if (field.type.type === "nested") {
+        addNestedSchemas(field.type.schema, schemas);
+      }
+    }
+  }
+  const exportedSchemas = Object.values(foxgloveMessageSchemas);
+  exportedSchemas.forEach((schema) => addNestedSchemas(schema, allSchemas));
+  it.each([...allSchemas])("exports nested schemas - $name", (nestedSchema) => {
+    expect(exportedSchemas).toContain(nestedSchema);
+  });
+
   it("has valid descriptions", () => {
     for (const schema of Object.values(foxgloveMessageSchemas)) {
       // Multi-line descriptions are supported for fields, but not currently for schemas