fix: add run YAML rule

Author: HerringtonDarkholme

src/extension/preview.ts

@@ -20,13 +20,22 @@ import {
   window,
   workspace,
 } from 'vscode'
-import type { ChildToParent, Diff, DisplayResult, SearchQuery, SgSearch } from '../types'
+import type {
+  ChildToParent,
+  Diff,
+  DisplayResult,
+  PatternQuery,
+  SearchQuery,
+  SgSearch,
+  YAMLQuery,
+} from '../types'
 import { parentPort, streamedPromise } from './common'
 import { buildCommand, splitByHighLightToken } from './search'
 
 const SCHEME = 'sgpreview'
 let lastPattern = ''
 let lastRewrite = ''
+let lastYAML = ''
 
 /**
  * NB A file will only have one preview at a time
@@ -169,7 +178,15 @@ function closeAllDiffs() {
   }
 }
 
-function refreshDiff(query: SearchQuery) {
+function refreshYAMLDiff(query: YAMLQuery) {
+  if (query.yaml === lastYAML) {
+    return
+  }
+  previewContents.clear()
+  closeAllDiffs()
+}
+
+function refreshPatternDiff(query: PatternQuery) {
   try {
     // Clear cache if pattern/rewrite changed
     if (query.pattern !== lastPattern || query.rewrite !== lastRewrite) {
@@ -190,6 +207,15 @@ function refreshDiff(query: SearchQuery) {
     lastRewrite = query.rewrite
   }
 }
+
+function refreshDiff(query: SearchQuery) {
+  if ('yaml' in query) {
+    return refreshYAMLDiff(query)
+  } else {
+    return refreshPatternDiff(query)
+  }
+}
+
 parentPort.onMessage('openFile', openFile)
 parentPort.onMessage('previewDiff', previewDiff)
 parentPort.onMessage('dismissDiff', dismissDiff)
@@ -206,34 +232,25 @@ async function onReplaceAll(payload: ChildToParent['replaceAll']) {
   if (confirmed !== 'Replace') {
     return
   }
-  const { id, pattern, rewrite, selector, strictness, lang } = payload
-  for (const change of payload.changes) {
+  const { changes, ...other } = payload
+  for (const change of changes) {
     // TODO: chunk change
     await onCommitChange({
-      id,
-      pattern,
-      rewrite,
-      selector,
-      strictness,
-      lang,
+      ...other,
       ...change,
     })
   }
 }
 
 async function onCommitChange(payload: ChildToParent['commitChange']) {
-  const { filePath, pattern, rewrite, strictness, selector, lang } = payload
+  const { filePath, ...fields } = payload
   const fileUri = workspaceUriFromFilePath(filePath)
   if (!fileUri) {
     return
   }
   await doChange(fileUri, payload)
   await refreshSearchResult(payload.id, fileUri, {
-    pattern,
-    rewrite,
-    strictness,
-    selector,
-    lang,
+    ...fields,
     includeFile: filePath,
   })
 }

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, YAMLConfig } from '../types'
+import type { DisplayResult, PatternQuery, SearchQuery, SgSearch, YAMLConfig } from '../types'
 import { normalizeCommandForWindows, parentPort, resolveBinary, streamedPromise } from './common'
 
 /**
@@ -109,6 +109,14 @@ async function uniqueCommand(
 
 // TODO: add unit test for commandBuilder
 export function buildCommand(query: SearchQuery) {
+  if ('yaml' in query) {
+    return buildYAMLCommand(query)
+  } else {
+    return buildPatternCommand(query)
+  }
+}
+
+function buildPatternCommand(query: PatternQuery) {
   const { pattern, includeFile, strictness } = query
   if (!pattern) {
     return

src/types.ts

@@ -27,18 +27,30 @@ export interface DisplayResult {
   language: string
 }
 
-interface SearchQueryBasic {
+interface PatternhQueryBasic {
   pattern: string
   rewrite: string
   strictness: string
   selector: string
   lang: string
 }
 
-export interface SearchQuery extends SearchQueryBasic {
+export type PatternQuery = PatternhQueryBasic & {
   includeFile: string
 }
 
+interface YAMLQueryBasic {
+  yaml: string
+}
+
+export type YAMLQuery = YAMLQueryBasic & {
+  includeFile: string
+}
+
+export type SearchQueryBasic = PatternhQueryBasic | YAMLQueryBasic
+
+export type SearchQuery = PatternQuery | YAMLQuery
+
 export type SgSearch = {
   text: string
   range: RangeInfo
@@ -82,6 +94,7 @@ export interface Diff {
 export interface YAMLConfig {
   yaml: string
   includeFile: string
+  rewrite?: boolean
 }
 
 export interface ChildToParent {

src/webview/SearchSidebar/SearchProviderMessage/index.tsx

@@ -20,10 +20,15 @@ const codeStyle = {
 } as const
 
 function Empty({ query }: { query: SearchQuery }) {
-  const { pattern, includeFile } = query
-  if (!pattern) {
-    return null
+  if ('yaml' in query) {
+    const id = /id:\s*([^,\n]+)/.exec(query.yaml)?.[1]
+    return (
+      <div style={style}>
+        No results found for YAML <code style={codeStyle}>{id}</code>
+      </div>
+    )
   }
+  const { pattern, includeFile } = query
   return (
     <div style={style}>
       No results found for <code style={codeStyle}>{pattern}</code>

src/webview/SearchSidebar/SearchWidgetContainer/YamlWidget.tsx

@@ -1,7 +1,4 @@
 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: {
@@ -19,7 +16,6 @@ const styles = stylex.create({
 })
 
 export default function YamlWidget() {
-  const [value, setValue] = useState('')
   return (
     <div {...stylex.props(styles.yaml)}>
     </div>

src/webview/hooks/useQuery.tsx

@@ -1,13 +1,13 @@
 import { useEffect, useState } from 'react'
 import { useBoolean, useDebounce, useLocalStorage } from 'react-use'
-import { SearchQuery } from '../../types'
+import { PatternQuery, SearchQuery } from '../../types'
 import { childPort } from '../postMessage'
 export { SearchQuery }
 // this is the single sole point of communication
 // between search query and search result
 import { postSearch } from './useSearch'
 
-const searchQuery: Record<keyof SearchQuery, string> = {
+const searchQuery: Record<keyof PatternQuery, string> = {
   pattern: '',
   strictness: 'smart',
   selector: '',
@@ -18,7 +18,7 @@ const searchQuery: Record<keyof SearchQuery, string> = {
 
 type PatternKeys = 'selector'
 
-const LS_KEYS: Record<Exclude<keyof SearchQuery, PatternKeys>, string> = {
+const LS_KEYS: Record<Exclude<keyof PatternQuery, PatternKeys>, string> = {
   pattern: 'ast-grep-search-panel-input-value',
   includeFile: 'ast-grep-search-panel-include-value',
   rewrite: 'ast-grep-search-panel-rewrite-value',

src/webview/hooks/useSearch.tsx

@@ -20,7 +20,7 @@ const MOD = 1e9 + 7
 // maintain the latest search task id and callback
 let id = 0
 let grouped: [string, DisplayResult[]][] = []
-let queryInFlight: SearchQuery = {
+let queryInFlight: SearchQuery | YAMLConfig = {
   pattern: '',
   includeFile: '',
   rewrite: '',
@@ -175,11 +175,18 @@ function getSnapshot() {
   return version // symbolic snapshot for react
 }
 
+function queryHasRewrite() {
+  if ('yaml' in queryInFlight) {
+    return /^fix:/.test(queryInFlight.yaml)
+  }
+  return !!queryInFlight.rewrite
+}
+
 /**
  * Either open a file or preview the diff
  */
 export function openAction(payload: OpenPayload) {
-  if (!queryInFlight.rewrite) {
+  if (!queryHasRewrite()) {
     openFile(payload)
     return
   }