refactor(code-actions): unify quick fix providers with strategy pattern

.vscode/settings.json

@@ -1,5 +1,8 @@
 {
   "cSpell.words": [
     "npmx"
+  ],
+  "typescript.preferences.autoImportSpecifierExcludeRegexes": [
+    "tests/__mocks__"
   ]
 }

src/composables/active-extractor.ts

@@ -1,14 +1,7 @@
 import type { Extractor } from '#types/extractor'
-import { PACKAGE_JSON_BASENAME, PNPM_WORKSPACE_BASENAME } from '#constants'
 import { computed, useActiveTextEditor } from 'reactive-vscode'
 import { languages } from 'vscode'
-import { PackageJsonExtractor } from '../extractors/package-json'
-import { PnpmWorkspaceYamlExtractor } from '../extractors/pnpm-workspace-yaml'
-
-export const extractorEntries = [
-  { pattern: `**/${PACKAGE_JSON_BASENAME}`, extractor: new PackageJsonExtractor() },
-  { pattern: `**/${PNPM_WORKSPACE_BASENAME}`, extractor: new PnpmWorkspaceYamlExtractor() },
-]
+import { extractorEntries } from '../extractors'
 
 export function useActiveExtractor() {
   const activeEditor = useActiveTextEditor()

src/constants.ts

@@ -10,5 +10,3 @@ export const NPMX_DEV = 'https://npmx.dev'
 export const NPMX_DEV_API = `${NPMX_DEV}/api`
 
 export const SPACER = ' '
-
-export const UPGRADE_MESSAGE_PREFIX = 'New version available: '

src/extractors/index.ts

@@ -0,0 +1,8 @@
+import { PACKAGE_JSON_BASENAME, PNPM_WORKSPACE_BASENAME } from '#constants'
+import { PackageJsonExtractor } from './package-json'
+import { PnpmWorkspaceYamlExtractor } from './pnpm-workspace-yaml'
+
+export const extractorEntries = [
+  { pattern: `**/${PACKAGE_JSON_BASENAME}`, extractor: new PackageJsonExtractor() },
+  { pattern: `**/${PNPM_WORKSPACE_BASENAME}`, extractor: new PnpmWorkspaceYamlExtractor() },
+]

src/index.ts

@@ -1,12 +1,11 @@
-import { extractorEntries } from '#composables/active-extractor'
 import { VERSION_TRIGGER_CHARACTERS } from '#constants'
 import { defineExtension, useCommands, watchEffect } from 'reactive-vscode'
-import { CodeActionKind, Disposable, languages } from 'vscode'
+import { Disposable, languages } from 'vscode'
 import { openFileInNpmx } from './commands/open-file-in-npmx'
 import { openInBrowser } from './commands/open-in-browser'
+import { extractorEntries } from './extractors'
 import { commands, displayName, version } from './generated-meta'
-import { UpgradeProvider } from './providers/code-actions/upgrade'
-import { VulnerabilityCodeActionProvider } from './providers/code-actions/vulnerability'
+import { useCodeActions } from './providers/code-actions'
 import { VersionCompletionItemProvider } from './providers/completion-item/version'
 import { useDiagnostics } from './providers/diagnostics'
 import { NpmxHoverProvider } from './providers/hover/npmx'
@@ -41,34 +40,10 @@ export const { activate, deactivate } = defineExtension(() => {
     onCleanup(() => Disposable.from(...disposables).dispose())
   })
 
-  watchEffect((onCleanup) => {
-    if (!config.diagnostics.upgrade)
-      return
-
-    const provider = new UpgradeProvider()
-    const options = { providedCodeActionKinds: [CodeActionKind.QuickFix] }
-    const disposables = extractorEntries.map(({ pattern }) =>
-      languages.registerCodeActionsProvider({ pattern }, provider, options),
-    )
-
-    onCleanup(() => Disposable.from(...disposables).dispose())
-  })
-
-  watchEffect((onCleanup) => {
-    if (!config.diagnostics.vulnerability)
-      return
-
-    const provider = new VulnerabilityCodeActionProvider()
-    const options = { providedCodeActionKinds: [CodeActionKind.QuickFix] }
-    const disposables = extractorEntries.map(({ pattern }) =>
-      languages.registerCodeActionsProvider({ pattern }, provider, options),
-    )
-
-    onCleanup(() => Disposable.from(...disposables).dispose())
-  })
-
   useDiagnostics()
 
+  useCodeActions()
+
   useCommands({
     [commands.openInBrowser]: openInBrowser,
     [commands.openFileInNpmx]: openFileInNpmx,

src/providers/code-actions/index.ts

@@ -0,0 +1,22 @@
+import { extractorEntries } from '#extractors'
+import { config } from '#state'
+import { computed, watch } from 'reactive-vscode'
+import { CodeActionKind, Disposable, languages } from 'vscode'
+import { QuickFixProvider } from './quick-fix'
+
+export function useCodeActions() {
+  const hasQuickFix = computed(() => config.diagnostics.upgrade || config.diagnostics.vulnerability)
+
+  watch(hasQuickFix, (enabled, _, onCleanup) => {
+    if (!enabled)
+      return
+
+    const provider = new QuickFixProvider()
+    const options = { providedCodeActionKinds: [CodeActionKind.QuickFix] }
+    const disposables = extractorEntries.map(({ pattern }) =>
+      languages.registerCodeActionsProvider({ pattern }, provider, options),
+    )
+
+    onCleanup(() => Disposable.from(...disposables).dispose())
+  }, { immediate: true })
+}

src/providers/code-actions/quick-fix.ts

@@ -0,0 +1,53 @@
+import type { CodeActionContext, CodeActionProvider, Diagnostic, Range, TextDocument } from 'vscode'
+import { CodeAction, CodeActionKind, WorkspaceEdit } from 'vscode'
+
+interface QuickFixRule {
+  pattern: RegExp
+  title: (target: string) => string
+  isPreferred?: boolean
+}
+
+const quickFixRules: Record<string, QuickFixRule> = {
+  upgrade: {
+    pattern: /^New version available: (?<target>\S+)$/,
+    title: (target) => `Update to ${target}`,
+  },
+  vulnerability: {
+    pattern: / Upgrade to (?<target>\S+) to fix\.$/,
+    title: (target) => `Update to ${target} to fix vulnerabilities`,
+    isPreferred: true,
+  },
+}
+
+function getDiagnosticCodeValue(diagnostic: Diagnostic): string | undefined {
+  if (typeof diagnostic.code === 'string')
+    return diagnostic.code
+
+  if (typeof diagnostic.code === 'object' && typeof diagnostic.code.value === 'string')
+    return diagnostic.code.value
+}
+
+export class QuickFixProvider implements CodeActionProvider {
+  provideCodeActions(document: TextDocument, _range: Range, context: CodeActionContext): CodeAction[] {
+    return context.diagnostics.flatMap((diagnostic) => {
+      const code = getDiagnosticCodeValue(diagnostic)
+      if (!code)
+        return []
+
+      const rule = quickFixRules[code]
+      if (!rule)
+        return []
+
+      const target = rule.pattern.exec(diagnostic.message)?.groups?.target
+      if (!target)
+        return []
+
+      const action = new CodeAction(rule.title(target), CodeActionKind.QuickFix)
+      action.isPreferred = rule.isPreferred ?? false
+      action.diagnostics = [diagnostic]
+      action.edit = new WorkspaceEdit()
+      action.edit.replace(document.uri, diagnostic.range, target)
+      return [action]
+    })
+  }
+}

src/providers/diagnostics/rules/upgrade.ts

@@ -1,7 +1,6 @@
 import type { DependencyInfo } from '#types/extractor'
 import type { ParsedVersion } from '#utils/version'
 import type { DiagnosticRule, NodeDiagnosticInfo } from '..'
-import { UPGRADE_MESSAGE_PREFIX } from '#constants'
 import { formatVersion, getPrereleaseId, isSupportedProtocol, lt, parseVersion } from '#utils/version'
 import { DiagnosticSeverity } from 'vscode'
 
@@ -10,7 +9,8 @@ function createUpgradeDiagnostic(dep: DependencyInfo, parsed: ParsedVersion, upg
   return {
     node: dep.versionNode,
     severity: DiagnosticSeverity.Hint,
-    message: `${UPGRADE_MESSAGE_PREFIX}${target}`,
+    message: `New version available: ${target}`,
+    code: 'upgrade',
   }
 }
 

tests/__mocks__/vscode.ts

@@ -21,6 +21,7 @@ export const {
   CodeAction,
   CodeActionKind,
   WorkspaceEdit,
+  Diagnostic,
   DiagnosticSeverity,
   DiagnosticTag,
   window,

tests/code-actions/quick-fix.test.ts

@@ -0,0 +1,60 @@
+import type { CodeActionContext, TextDocument } from 'vscode'
+import { describe, expect, it } from 'vitest'
+import { Diagnostic, DiagnosticSeverity, Range, Uri } from 'vscode'
+import { QuickFixProvider } from '../../src/providers/code-actions/quick-fix'
+
+const provider = new QuickFixProvider()
+
+const uri = Uri.file('/package.json')
+const range = new Range(0, 0, 0, 6)
+const document = { uri } as TextDocument
+
+function createDiagnostic(code: string | { value: string, target: Uri }, message: string) {
+  const diagnostic = new Diagnostic(range, message, DiagnosticSeverity.Hint)
+  diagnostic.code = code
+  return diagnostic
+}
+
+function provideCodeActions(diagnostics: Diagnostic[]) {
+  return provider.provideCodeActions(
+    document,
+    diagnostics[0]!.range,
+    { diagnostics } as unknown as CodeActionContext,
+  )
+}
+
+describe('quick fix provider', () => {
+  it('upgrade', () => {
+    const diagnostic = createDiagnostic('upgrade', 'New version available: ^2.0.0')
+    const actions = provideCodeActions([diagnostic])
+
+    expect(actions).toHaveLength(1)
+    expect(actions[0]!.title).toMatchInlineSnapshot('"Update to ^2.0.0"')
+  })
+
+  it('vulnerability', () => {
+    const diagnostic = createDiagnostic(
+      { value: 'vulnerability', target: Uri.parse('https://npmx.dev') },
+      'This version has 1 high vulnerability. Upgrade to ^1.2.3 to fix.',
+    )
+    const actions = provideCodeActions([diagnostic])
+
+    expect(actions).toHaveLength(1)
+    expect(actions[0]!.title).toMatchInlineSnapshot('"Update to ^1.2.3 to fix vulnerabilities"')
+  })
+
+  it('mixed diagnostics', () => {
+    const diagnostics = [
+      createDiagnostic('upgrade', 'New version available: ^2.0.0'),
+      createDiagnostic(
+        { value: 'vulnerability', target: Uri.parse('https://npmx.dev') },
+        'This version has 1 high vulnerability. Upgrade to ^1.2.3 to fix.',
+      ),
+    ]
+    const actions = provideCodeActions(diagnostics)
+
+    expect(actions).toHaveLength(2)
+    expect(actions[0]!.title).toMatchInlineSnapshot('"Update to ^2.0.0"')
+    expect(actions[1]!.title).toMatchInlineSnapshot('"Update to ^1.2.3 to fix vulnerabilities"')
+  })
+})