chore(optic): add a comment about commandSplitter()'s usage (#2771)

opticdev · Mar 4, 2024 · f3ac543 · f3ac543
1 parent 2043823
commit f3ac543
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/projects/optic/src/utils/capture.ts b/projects/optic/src/utils/capture.ts
@@ -6,6 +6,10 @@ export type SpawnCommand = {
   args: string[];
 };
 
+// commandSplitter() splits a command and its args into a SpawnCommand--in a naive fashion. it
+// assumes that `command` contains a single command, rather than something more complex. since
+// there is no validation or safety checks performed on `command` exercise caution where you
+// use this.
 export function commandSplitter(command: string): SpawnCommand {
   return {
     cmd: command.split(' ')[0],