feat: turn function text | split(separator) into a standalone function split(text, separator)

josdejong · josdejong · commit 7bcff0f77fd1 · 2024-12-02T16:08:29.000+01:00
diff --git a/reference/functions.md b/reference/functions.md
@@ -510,19 +510,25 @@ jsonquery(data, 'map(.name) | join(", ")')
 
 ## split
 
-Divide a string into an array substrings, separated by a separator.
+Divide a string into an array substrings, separated by a separator. When no separator is provided, the string is split in words separated by one or multiple whitespaces, and the words are trimmed so they do not contain whitespace at the start or the end. When the separator is an empty string, the text will be split into a list with its individual characters.
 
 ```text
-split()
-split(separator)
+split(text)
+split(text, separator)
 ```
 
-Example:
+Examples:
 
 ```js
-const data = "hi there how are you doing?"
-jsonquery(data, 'split(" ")')
+const data = {
+  "message": "hi there how are you doing?"
+}
+jsonquery(data, 'split(.message)')
 // ["hi", "there", "how", "are", "you", "doing?"]
+
+
+jsonquery(data, 'split("a,b,c", ",")') 
+// ["a", "b", "c"]
 ```
 
 ## uniq
diff --git a/src/functions.ts b/src/functions.ts
@@ -206,10 +206,9 @@ export const functions: FunctionBuildersMap = {
     (data: T[]) =>
       data.join(separator),
 
-  split: (separator?: string) =>
-    separator !== undefined
-      ? (data: string) => data.split(separator)
-      : (data: string) => data.trim().split(/\s+/),
+  split: buildFunction((text: string, separator?: string) =>
+    separator !== undefined ? text.split(separator) : text.trim().split(/\s+/)
+  ),
 
   substring: (start: number, end: number) => (data: string) => data.slice(Math.max(start, 0), end),
 
diff --git a/test-suite/compile.test.json b/test-suite/compile.test.json
@@ -505,30 +505,37 @@
 
     {
       "category": "split",
-      "description": "should split a string",
-      "input": "start with a b c",
-      "query": ["split"],
+      "description": "should split a string (1)",
+      "input": null,
+      "query": ["split", "start with a b c"],
+      "output": ["start", "with", "a", "b", "c"]
+    },
+    {
+      "category": "split",
+      "description": "should split a string (2)",
+      "input": { "message": "start with a b c" },
+      "query": ["split", ["get", "message"]],
       "output": ["start", "with", "a", "b", "c"]
     },
     {
       "category": "split",
       "description": "should split a string with multiple whitespaces between the words",
-      "input": " \n\n\t start   with  a   b \n\r\t  c \n\n\t ",
-      "query": ["split"],
+      "input": null,
+      "query": ["split", " \n\n\t start   with  a   b \n\r\t  c \n\n\t "],
       "output": ["start", "with", "a", "b", "c"]
     },
     {
       "category": "split",
       "description": "should split a string by individual characters",
-      "input": "abc",
-      "query": ["split", ""],
+      "input": null,
+      "query": ["split", "abc", ""],
       "output": ["a", "b", "c"]
     },
     {
       "category": "split",
       "description": "should split a string with a separator",
-      "input": "a,b,c",
-      "query": ["split", ","],
+      "input": null,
+      "query": ["split", "a,b,c", ","],
       "output": ["a", "b", "c"]
     },
 
