Update VSCode extension with genaiscript annotations (#712)

* Add genaiscript annotations and problem matcher to VSCode extension * Update constants, add VSCode tasks, enhance problem matchers, and modify task provider * Add task provider options for msCompile, lessCompile, and jshint * Update vision model identifier from gpt-4-turbo-v to gpt-4o in business card scanner guide * Normalize severity case and update nullish coalescing in annotations and promptrunner.
microsoft · Sep 16, 2024 · b9f59f4 · b9f59f4
1 parent 42067d3
commit b9f59f4
Show file tree

Hide file tree

Showing 8 changed files with 56 additions and 11 deletions.
diff --git a/docs/src/content/docs/guides/business-card-scanner.mdx b/docs/src/content/docs/guides/business-card-scanner.mdx
@@ -12,13 +12,13 @@ This guide shows how to use vision and image variables to scan business card inf
 
 ## Vision model
 
-You will need access to a deployment of the OpenAI vision model. In this example, it is identifier by `gpt-4-turbo-v`.
+You will need access to a deployment of the OpenAI vision model. In this example, it is identifier by `gpt-4o`.
 Also set the `maxTokens` to 4000 to ensure the model can process the entire business card.
 
-```js "gpt-4-turbo-v"
+```js "gpt-4o"
 script({
     ...
-    model: "openai:gpt-4-turbo-v",
+    model: "openai:gpt-4o",
     maxTokens: 4000,
 })
 ```

diff --git a/packages/core/src/annotations.ts b/packages/core/src/annotations.ts
@@ -27,7 +27,7 @@ export function parseAnnotations(text: string): Diagnostic[] {
     const addAnnotation = (m: RegExpMatchArray) => {
         const { file, line, endLine, severity, code, message } = m.groups
         const annotation: Diagnostic = {
-            severity: sevMap[severity] ?? "info",
+            severity: sevMap[severity?.toLowerCase()] ?? "info",
             filename: file,
             range: [
                 [parseInt(line) - 1, 0],

diff --git a/packages/core/src/constants.ts b/packages/core/src/constants.ts
@@ -40,8 +40,9 @@ export const CLIENT_RECONNECT_DELAY = 3000
 export const CLIENT_RECONNECT_MAX_ATTEMPTS = 20
 export const RETRIEVAL_PERSIST_DIR = "retrieval"
 export const HIGHLIGHT_LENGTH = 4000
-export const DEFAULT_MODEL = "openai:gpt-4-turbo"
+export const DEFAULT_MODEL = "openai:gpt-4o"
 export const DEFAULT_MODEL_CANDIDATES = [
+    "azure:gpt-4o",
     "azure:gpt-4-turbo",
     DEFAULT_MODEL,
     "github:gpt-4o",

diff --git a/packages/core/src/promptrunner.ts b/packages/core/src/promptrunner.ts
@@ -382,8 +382,8 @@ export async function runTemplate(
                     annotations.map((a) => ({
                         ...a,
                         line: a.range?.[0]?.[0],
-                        endLine: a.range?.[1]?.[0] || "",
-                        code: a.code || "",
+                        endLine: a.range?.[1]?.[0] ?? "",
+                        code: a.code ?? "",
                     })),
                     {
                         headers: [

diff --git a/packages/sample/.vscode/tasks.json b/packages/sample/.vscode/tasks.json
@@ -0,0 +1,12 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "echo",
+            "type": "shell",
+            "command": "echo \"::error file=src/fib.ts,line=1,endLine=5,code=concatenation_override::hello\""
+        }
+    ]
+}
diff --git a/packages/sample/genaisrc/annotations.genai.mts b/packages/sample/genaisrc/annotations.genai.mts
@@ -0,0 +1,5 @@
+script({ model: "gpt-4o", system: ["annotations"] })
+def("FILE", env.files, { ignoreEmpty: true })
+
+$`Review FILE and report errors and warnings using annotation format.
+Answer in plain text.`
diff --git a/packages/vscode/package.json b/packages/vscode/package.json
@@ -53,6 +53,26 @@
     },
     "contributes": {
         "markdown.markdownItPlugins": true,
+        "problemMatchers": [
+            {
+                "name": "genaiscript",
+                "label": "GenAIScript annotations",
+                "source": "Generated by a LLM.",
+                "applyTo": "allDocuments",
+                "fileLocation": [
+                    "relative",
+                    "${workspaceFolder}"
+                ],
+                "pattern": {
+                    "regexp": "^\\s*::(info|notice|warning|error)\\s+file=([^,]+),\\s*line=(\\d+)(,\\s*endLine=(\\d+)\\s*)?(,\\s*code=([^,:]+)?\\s*)?::(.*)$",
+                    "severity": 1,
+                    "file": 2,
+                    "line": 3,
+                    "code": 7,
+                    "message": 8
+                }
+            }
+        ],
         "taskDefinitions": [
             {
                 "type": "genaiscript",

diff --git a/packages/vscode/src/taskprovider.ts b/packages/vscode/src/taskprovider.ts
@@ -16,7 +16,7 @@ export async function activeTaskProvider(state: ExtensionState) {
                 : `npx --yes genaiscript@${cliVersion}`
             const scripts = state.project.templates.filter((t) => !t.isSystem)
             const tasks = scripts.map((script) => {
-                const scriptp = host.path.relative(
+                const scriptName = host.path.relative(
                     host.projectFolder(),
                     script.filename
                 )
@@ -27,12 +27,19 @@ export async function activeTaskProvider(state: ExtensionState) {
                     TOOL_ID,
                     new vscode.ShellExecution(exec, [
                         "run",
-                        scriptp,
+                        scriptName,
                         "${relativeFile}",
                     ])
                 )
-                task.detail = `${script.title ?? script.description} - ${scriptp}`
-                task.problemMatchers = ["$tsc"]
+                task.detail = `${script.title ?? script.description} - ${scriptName}`
+                task.problemMatchers = [
+                    "$genaiscript",
+                    "$eslint-compact",
+                    "$tsc",
+                    "$msCompile",
+                    "$lessCompile",
+                    "$jshint",
+                ]
                 task.presentationOptions = {
                     echo: true,
                     focus: true,