feat: ✨ add JSON5 parsing and stringifying utilities

microsoft · Dec 22, 2024 · 482f484 · 482f484
1 parent 69a412b
commit 482f484
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 1 deletion.
diff --git a/packages/core/src/globals.ts b/packages/core/src/globals.ts
@@ -17,6 +17,7 @@ import { GitClient } from "./git"
 import { estimateTokens, truncateTextToTokens } from "./tokens"
 import { chunk, resolveTokenEncoder } from "./encoders"
 import { runtimeHost } from "./host"
+import { JSON5Stringify, JSON5TryParse } from "./json5"
 
 /**
  * This file defines global utilities and installs them into the global context.
@@ -86,6 +87,11 @@ export function installGlobals() {
         stringify: JSONLStringify, // Convert objects to JSONL string
     })
 
+    glb.JSON5 = Object.freeze<JSON5>({
+        parse: JSON5TryParse,
+        stringify: JSON5Stringify
+    })
+
     // Freeze AICI utilities with a generation function
     glb.AICI = Object.freeze<AICI>({
         gen: (options: AICIGenOptions) => {

diff --git a/packages/core/src/types/prompt_template.d.ts b/packages/core/src/types/prompt_template.d.ts
@@ -2184,6 +2184,20 @@ interface INI {
     stringify(value: any): string
 }
 
+interface JSON5 {
+    /**
+     * Parses a JSON/YAML/XML string to an object
+     * @param text
+     */
+    parse(text: string | WorkspaceFile): any
+
+    /**
+     * Renders an object to a JSON5-LLM friendly string
+     * @param value
+     */
+    stringify(value: any): string
+}
+
 interface CSVStringifyOptions {
     delimiter?: string
     header?: boolean
@@ -2604,7 +2618,7 @@ interface McpServerConfig {
 
 type McpServersConfig = Record<string, Omit<McpServerConfig, "id" | "options">>
 
-type ZodTypeLike = { _def: any, safeParse: any, refine: any }
+type ZodTypeLike = { _def: any; safeParse: any; refine: any }
 
 interface ChatGenerationContext extends ChatTurnGenerationContext {
     defSchema(

diff --git a/packages/core/src/types/prompt_type.d.ts b/packages/core/src/types/prompt_type.d.ts
@@ -198,6 +198,11 @@ declare var MD: MD
  */
 declare var JSONL: JSONL
 
+/**
+ * JSON5 parsing
+ */
+declare var JSON5: JSON5
+
 /**
  * AICI operations
  */

diff --git a/packages/sample/genaisrc/globals.genai.mjs b/packages/sample/genaisrc/globals.genai.mjs
@@ -0,0 +1,17 @@
+script({
+    tests: {},
+    model: "small",
+})
+
+const data = {
+    name: "foo",
+    items: [1, 2, 3],
+}
+
+const json5 = JSON5.parse(JSON5.stringify(data))
+
+if (JSON.stringify(json5) !== JSON.stringify(data)) {
+    throw new Error(
+        "JSON5.stringify(JSON5.parse(JSON5.stringify(data))) !== data"
+    )
+}