Add JSDoc comment to runCliJson

mario-campos · mario-campos · commit b48cc643544d · 2026-07-01T11:18:02.000-05:00
diff --git a/src/codeql.ts b/src/codeql.ts
@@ -1131,6 +1131,12 @@ async function runCli(
   }
 }
 
+/**
+ * Wraps the command executor {@link runCli} and parses the JSON output.
+ * @param cmd The command to run.
+ * @param args The arguments to pass to the command.
+ * @param opts Options for running the command.
+ */
 async function runCliJson<T>(
   cmd: string,
   args: string[] = [],

Original file line number	Diff line number	Diff line change
`@@ -1131,6 +1131,12 @@ async function runCli(`
`1131`	`1131`	`}`
`1132`	`1132`	`}`
`1133`	`1133`
	`1134`	`+/**`
	`1135`	`+ * Wraps the command executor {@link runCli} and parses the JSON output.`
	`1136`	`+ * @param cmd The command to run.`
	`1137`	`+ * @param args The arguments to pass to the command.`
	`1138`	`+ * @param opts Options for running the command.`
	`1139`	`+ */`
`1134`	`1140`	`async function runCliJson<T>(`
`1135`	`1141`	`cmd: string,`
`1136`	`1142`	`args: string[] = [],`