feat: add experimental yaml support

fix #167

Author: HerringtonDarkholme

src/extension/search.ts

@@ -2,7 +2,7 @@ import { type ChildProcessWithoutNullStreams, spawn } from 'node:child_process'
 import path from 'node:path'
 import { commands, type ExtensionContext, window, workspace } from 'vscode'
 
-import type { DisplayResult, SearchQuery, SgSearch } from '../types'
+import type { DisplayResult, SearchQuery, SgSearch, YAMLConfig } from '../types'
 import { normalizeCommandForWindows, parentPort, resolveBinary, streamedPromise } from './common'
 
 /**
@@ -160,6 +160,41 @@ function getPatternRes(query: SearchQuery, handlers: Handlers) {
   return uniqueCommand(proc, handlers.onData)
 }
 
+function buildYAMLCommand(config: YAMLConfig) {
+  const { yaml, includeFile } = config
+  if (!yaml) {
+    return
+  }
+  const command = resolveBinary()
+  const { normalizedCommand, shell } = normalizeCommandForWindows(command)
+  const uris = workspace.workspaceFolders?.map(i => i.uri?.fsPath) ?? []
+  const args = ['scan', '--inline-rules', yaml, '--json=stream']
+  const validIncludeFile = includeFile.split(',').filter(Boolean)
+  const hasGlobPattern = validIncludeFile.some(i => i.includes('*'))
+  if (hasGlobPattern) {
+    args.push(...validIncludeFile.map(i => `--globs=${i}`))
+  } else {
+    args.push(...validIncludeFile)
+  }
+  console.debug('scanning', config, normalizedCommand, args)
+  // TODO: multi-workspaces support
+  return spawn(normalizedCommand, args, {
+    shell,
+    cwd: uris[0],
+  })
+}
+
+function getYAMLRes(config: YAMLConfig, handlers: Handlers) {
+  const proc = buildYAMLCommand(config)
+  if (proc) {
+    proc.on('error', error => {
+      console.debug('ast-grep CLI runs error')
+      handlers.onError(error)
+    })
+  }
+  return uniqueCommand(proc, handlers.onData)
+}
+
 parentPort.onMessage('search', async payload => {
   const onData = (ret: SgSearch[]) => {
     parentPort.postMessage('searchResultStreaming', {
@@ -179,6 +214,25 @@ parentPort.onMessage('search', async payload => {
   parentPort.postMessage('searchEnd', payload)
 })
 
+parentPort.onMessage('yaml', async payload => {
+  const onData = (ret: SgSearch[]) => {
+    parentPort.postMessage('searchResultStreaming', {
+      ...payload,
+      searchResult: ret.map(splitByHighLightToken),
+    })
+  }
+  await getYAMLRes(payload, {
+    onData,
+    onError(error) {
+      parentPort.postMessage('error', {
+        error,
+        ...payload,
+      })
+    },
+  })
+  parentPort.postMessage('searchEnd', payload)
+})
+
 function searchByCode() {
   const editor = window.activeTextEditor
   if (!editor) {

src/types.ts

@@ -78,8 +78,14 @@ export interface Diff {
   range: RangeInfo
 }
 
+export interface YAMLConfig {
+  yaml: string
+  includeFile: string
+}
+
 export interface ChildToParent {
   search: WithId<SearchQuery>
+  yaml: WithId<YAMLConfig>
   reload: unknown
   openFile: {
     filePath: string

src/webview/SearchSidebar/SearchWidgetContainer/YamlWidget.tsx

@@ -1,6 +1,7 @@
 import * as stylex from '@stylexjs/stylex'
 import { VSCodeButton, VSCodeTextArea } from '@vscode/webview-ui-toolkit/react'
 import { useState } from 'react'
+import { postYAML } from '../../hooks/useSearch'
 
 const styles = stylex.create({
   yaml: {
@@ -36,7 +37,7 @@ export default function YamlWidget() {
         appearance="primary"
         onClick={() => {
           // Handle save or apply logic here
-          console.log('YAML Config:', value)
+          postYAML({ yaml: value, includeFile: '' })
         }}
       >
         Search

src/webview/hooks/useSearch.tsx

@@ -1,4 +1,5 @@
 import { useSyncExternalStore } from 'react'
+import { YAMLConfig } from '../../types'
 import {
   childPort,
   commitChange,
@@ -67,6 +68,15 @@ function postSearch(searchQuery: SearchQuery) {
   notify()
 }
 
+export function postYAML(config: YAMLConfig) {
+  id = (id + 1) % MOD
+  childPort.postMessage('yaml', { id, ...config })
+  searching = true
+  hasStaleResult = true
+  searchError = null
+  notify()
+}
+
 childPort.onMessage('searchResultStreaming', event => {
   const { id: eventId, ...query } = event
   if (eventId !== id) {