add --format jsonl to npx convex data (#40674)

GitOrigin-RevId: 1b615e20356a7244ada1876c7653e4471e147a51

Author: thomasballinger

src/cli/lib/command.ts

@@ -124,6 +124,7 @@ declare module "@commander-js/extra-typings" {
         limit: number;
         order: "asc" | "desc";
         component?: string;
+        format?: "json" | "jsonArray" | "jsonLines" | "jsonl" | "pretty";
       }
     >;
 
@@ -393,8 +394,7 @@ Command.prototype.addRunOptions = function () {
       .addOption(
         new Option(
           "--component <path>",
-          "Path to the component in the component tree defined in convex.config.ts. " +
-            "Components are a beta feature. This flag is unstable and may change in subsequent releases.",
+          "Path to the component in the component tree defined in convex.config.ts.",
         ),
       )
       .addOption(new Option("--live-component-sources").hideHelp())
@@ -449,7 +449,7 @@ Command.prototype.addImportOptions = function () {
     .addOption(
       new Option(
         "--component <path>",
-        "Path to the component in the component tree defined in convex.config.ts",
+        "Path to the component in the component tree defined in convex.config.ts.",
       ),
     );
 };
@@ -486,9 +486,17 @@ Command.prototype.addDataOptions = function () {
     .addOption(
       new Option(
         "--component <path>",
-        "Path to the component in the component tree defined in convex.config.ts.\n" +
-          "  By default, inspects data in the root component",
-      ).hideHelp(),
+        "Path to the component in the component tree defined in convex.config.ts.",
+      ),
+    )
+    .addOption(
+      new Option(
+        "--format <format>",
+        "Format to print the data in. This flag is only required if the filename is missing an extension.\n" +
+          "- jsonArray (aka json): print the data as a JSON array of objects.\n" +
+          "- jsonLines (aka jsonl): print the data as a JSON object per line.\n" +
+          "- pretty: print the data in a human-readable format.",
+      ).choices(["jsonArray", "json", "jsonLines", "jsonl", "pretty"]),
     )
     .argument("[table]", "If specified, list documents in this table.");
 };

src/cli/lib/data.ts

@@ -15,6 +15,7 @@ export async function dataInDeployment(
     limit: number;
     order: "asc" | "desc";
     component?: string;
+    format?: "json" | "jsonArray" | "jsonLines" | "jsonl" | "pretty";
   },
 ) {
   if (options.tableName !== undefined) {
@@ -27,6 +28,7 @@ export async function dataInDeployment(
         limit: options.limit,
         order: options.order as "asc" | "desc",
         componentPath: options.component ?? "",
+        format: options.format,
       },
     );
   } else {
@@ -72,6 +74,7 @@ async function listDocuments(
     limit: number;
     order: "asc" | "desc";
     componentPath: string;
+    format?: "json" | "jsonArray" | "jsonLines" | "jsonl" | "pretty";
   },
 ) {
   const data = (await runSystemPaginatedQuery(ctx, {
@@ -91,26 +94,39 @@ async function listDocuments(
     return;
   }
 
-  logDocumentsTable(
-    ctx,
-    data.slice(0, options.limit).map((document) => {
-      const printed: Record<string, string> = {};
-      for (const key in document) {
-        printed[key] = stringify(document[key]);
-      }
-      return printed;
-    }),
-  );
-  if (data.length > options.limit) {
-    logWarning(
-      chalk.yellow(
-        `Showing the ${options.limit} ${
-          options.order === "desc" ? "most recently" : "oldest"
-        } created document${
-          options.limit > 1 ? "s" : ""
-        }. Use the --limit option to see more.`,
-      ),
+  if (options.format === "json" || options.format === "jsonArray") {
+    logOutput(
+      "[\n" + data.slice(0, options.limit).map(stringify).join(",\n") + "\n]",
+    );
+  } else if (options.format === "jsonLines" || options.format === "jsonl") {
+    logOutput(
+      data
+        .slice(0, options.limit)
+        .map((document) => stringify(document))
+        .join("\n"),
+    );
+  } else {
+    logDocumentsTable(
+      ctx,
+      data.slice(0, options.limit).map((document) => {
+        const printed: Record<string, string> = {};
+        for (const key in document) {
+          printed[key] = stringify(document[key]);
+        }
+        return printed;
+      }),
     );
+    if (data.length > options.limit) {
+      logWarning(
+        chalk.yellow(
+          `Showing the ${options.limit} ${
+            options.order === "desc" ? "most recently" : "oldest"
+          } created document${
+            options.limit > 1 ? "s" : ""
+          }. Use the --limit option to see more.`,
+        ),
+      );
+    }
   }
 }