feat: support fig deprecated flag

CyanSalt · CyanSalt · commit 109ca46d61a7 · 2025-03-13T21:27:38.000+08:00
diff --git a/src/main/utils/completion.ts b/src/main/utils/completion.ts
@@ -102,19 +102,25 @@ function getFigSuggestionType(spec: Fig.Suggestion): CommandCompletion['type'] {
   }
 }
 
-function transformFigSuggestion(raw: string | Fig.Suggestion, query: string) {
+function transformFigSuggestion(raw: string | Fig.Suggestion, query: string, strict?: boolean) {
   const spec = typeof raw === 'string' ? { name: raw } : raw
-  const values = getFigValues(spec)
+  if (spec.hidden) return []
+  let values = getFigValues(spec)
+  if (strict) {
+    values = values.filter(value => value.startsWith(query))
+  }
   return values.map<CommandCompletion>(value => ({
     type: getFigSuggestionType(spec),
     query: spec._internal?.commasCompletionQuery as string | undefined ?? query,
     value,
     label: spec.displayName,
     description: spec.description,
+    deprecated: Boolean(spec.deprecated),
   }))
 }
 
 function transformFigSubcommand(spec: Fig.Subcommand, query: string) {
+  if (spec.hidden) return []
   const values = getFigValues(spec)
   return values.map<CommandCompletion>(value => ({
     type: 'command',
@@ -124,10 +130,12 @@ function transformFigSubcommand(spec: Fig.Subcommand, query: string) {
       spec.insertValue ? undefined : getFigArgsLabel(spec, value)
     ),
     description: spec.description,
+    deprecated: Boolean(spec.deprecated),
   }))
 }
 
 function transformFigOption(spec: Fig.Option, query: string) {
+  if (spec.hidden) return []
   const values = getFigValues(spec)
   return values.map<CommandCompletion>(value => ({
     type: 'command',
@@ -137,6 +145,7 @@ function transformFigOption(spec: Fig.Option, query: string) {
       spec.insertValue ? undefined : getFigArgsLabel(spec, value)
     ),
     description: spec.description,
+    deprecated: Boolean(spec.deprecated),
   }))
 }
 
@@ -164,16 +173,16 @@ async function getFigCompletions(
   if (!('name' in spec)) return []
   const asyncCompletions: (CommandCompletion[] | Promise<CommandCompletion[]>)[] = []
   const options = spec.options ?? []
-  // Suggestions or args (suggestions if no argv, args else)
-  if (!args.length || args.length === 1 && args[0] === '') {
-    const suggestions = [
-      ...normalizeArray(spec.args).flatMap(arg => arg.suggestions ?? []),
-      ...(spec.additionalSuggestions ?? []),
-    ]
-    asyncCompletions.push(
-      suggestions.flatMap(suggestion => transformFigSuggestion(suggestion, query)),
-    )
-  } else {
+  // Suggestions
+  const suggestions = [
+    ...normalizeArray(spec.args).flatMap(arg => arg.suggestions ?? []),
+    ...(spec.additionalSuggestions ?? []),
+  ]
+  asyncCompletions.push(
+    suggestions.flatMap(suggestion => transformFigSuggestion(suggestion, query, true)),
+  )
+  // Option args
+  if (args.length > 1) {
     // Option args since option spec will not pass to `getFigCompletions`
     const previousArg = args[args.length - 2]
     const inputtingOption = options.find(item => {
diff --git a/src/renderer/components/TerminalTeletype.vue b/src/renderer/components/TerminalTeletype.vue
@@ -218,11 +218,11 @@ function scrollToStickyCommand() {
             </span>
             <span
               v-else
-              :class="['completion-item-label', { 'is-pending': item.state === 'pending' }]"
+              class="completion-item-label"
             >
               <span
                 v-if="item.value"
-                class="completion-item-value"
+                :class="['completion-item-value', { 'is-deprecated': item.deprecated }]"
                 v-html="highlight(item.value, item.query)"
               ></span>
               <span v-if="item.label" class="completion-item-suffix">{{ suffix(item.label, item.value) }}</span>
@@ -424,6 +424,11 @@ function scrollToStickyCommand() {
   text-overflow: ellipsis;
   overflow: hidden;
 }
+.completion-item-value {
+  &.is-deprecated {
+    text-decoration: line-through;
+  }
+}
 .completion-item-suffix {
   flex: 1;
   min-width: 0;
diff --git a/src/renderer/utils/shell-integration.ts b/src/renderer/utils/shell-integration.ts
@@ -80,29 +80,15 @@ function updateDecorationElement(decoration: IDecoration, callback: (el: HTMLEle
   }
 }
 
-const completionTypePriority: Record<NonNullable<CommandCompletion['type']>, number> = {
-  'third-party': 0,
-  recommendation: 1,
-  history: 2,
-  directory: 3,
-  file: 4,
-  command: 5,
-  default: Infinity,
-}
-
-const completionTypeOrder = Object.entries(completionTypePriority)
-  .sort((a, b) => a[1] - b[1])
-  .map(([type, priority]) => type)
-
-function determineCompletionType(
-  a: CommandCompletion['type'],
-  b: CommandCompletion['type'],
-): NonNullable<CommandCompletion['type']> {
-  for (const type of completionTypeOrder) {
-    if (a === type || b === type) return type
-  }
-  return 'default'
-}
+const orderedCompletionTypes = [
+  'third-party',
+  'recommendation',
+  'history',
+  'directory',
+  'file',
+  'command',
+  'default',
+] as const
 
 function filterAndSortCompletions(completions: CommandCompletion[]) {
   const duplicatedTimes: (Pick<CommandCompletion, 'value' | 'query'> & { times: number })[] = []
@@ -132,10 +118,12 @@ function filterAndSortCompletions(completions: CommandCompletion[]) {
         })
       }
       const existingItem = deduplicatedCompletions[existingIndex]
-      const replacement = {
+      const replacement: CommandCompletion = {
         ...existingItem,
-        type: determineCompletionType(existingItem.type, completion.type),
-        description: existingItem.description || completion.description,
+        type: orderedCompletionTypes.find(type => (existingItem.type === type || completion.type === type)) ?? 'default',
+        label: existingItem.label ?? completion.label,
+        description: existingItem.description ?? completion.description,
+        deprecated: existingItem.deprecated ?? completion.deprecated,
       }
       deduplicatedCompletions.splice(existingIndex, 1, replacement)
     }
diff --git a/src/types/terminal.ts b/src/types/terminal.ts
@@ -88,6 +88,7 @@ export interface CommandCompletion {
   description?: string,
   state?: 'pending' | 'loading',
   key?: string,
+  deprecated?: boolean,
 }
 
 export interface TerminalTabPosition {

Original file line number	Diff line number	Diff line change
`@@ -88,6 +88,7 @@ export interface CommandCompletion {`
`88`	`88`	`description?: string,`
`89`	`89`	`state?: 'pending' \| 'loading',`
`90`	`90`	`key?: string,`
	`91`	`+ deprecated?: boolean,`
`91`	`92`	`}`
`92`	`93`
`93`	`94`	`export interface TerminalTabPosition {`