refactor: migrate updateVersion to internal replaceText command

Author: 9romise

README.md

@@ -46,7 +46,7 @@
 | `npmx.diagnostics.replacement`      | Show suggestions for package replacements                                               | `boolean` | `true`              |
 | `npmx.diagnostics.vulnerability`    | Show warnings for packages with known vulnerabilities                                   | `boolean` | `true`              |
 | `npmx.diagnostics.distTag`          | Show warnings when a dependency uses a dist tag                                         | `boolean` | `true`              |
-| `npmx.versionLens.enabled`          | Show version lens (CodeLens) for package dependencies                                   | `boolean` | `true`              |
+| `npmx.versionLens.enabled`          | Show version lens (CodeLens) for package dependencies                                   | `boolean` | `false`             |
 
 <!-- configs -->
 

eslint.config.ts

@@ -7,10 +7,13 @@ export default defineConfig(
   },
   {
     files: ['src/commands/**'],
+    ignores: ['**/index.ts'],
     rules: {
       'no-restricted-imports': ['error', {
         paths: [{
           name: 'reactive-vscode',
+          allowImportNames: ['useCommand', 'useCommands', 'useTextEditorCommand', 'useTextEditorCommands'],
+          allowTypeImports: true,
           message: 'Do not use reactive-vscode composables in command handlers. Use vscode API directly.',
         }],
       }],

package.json

@@ -111,11 +111,6 @@
         "command": "npmx.openFileInNpmx",
         "title": "Open file on npmx.dev",
         "category": "npmx"
-      },
-      {
-        "command": "npmx.updateVersion",
-        "title": "Update package version",
-        "category": "npmx"
       }
     ],
     "menus": {

src/commands/internal/index.ts

@@ -0,0 +1,9 @@
+import { internalCommands } from '#state'
+import { useTextEditorCommands } from 'reactive-vscode'
+import { replaceText } from './replace-text'
+
+export function useInternalCommands() {
+  useTextEditorCommands({
+    [internalCommands.replaceText]: replaceText,
+  })
+}

src/commands/internal/replace-text.ts

@@ -0,0 +1,9 @@
+import type { TextEditorCommandCallback } from 'reactive-vscode'
+import type { Range, TextEditor, TextEditorEdit } from 'vscode'
+
+export const replaceText: TextEditorCommandCallback = (_: TextEditor, edit: TextEditorEdit, range?: Range, text?: string) => {
+  if (!range || !text)
+    return
+
+  edit.replace(range, text)
+}

src/commands/update-version.ts

@@ -1,9 +1,9 @@
 import { VERSION_TRIGGER_CHARACTERS } from '#constants'
 import { defineExtension, useCommands, watchEffect } from 'reactive-vscode'
 import { Disposable, languages } from 'vscode'
+import { useInternalCommands } from './commands/internal'
 import { openFileInNpmx } from './commands/open-file-in-npmx'
 import { openInBrowser } from './commands/open-in-browser'
-import { updateVersion } from './commands/update-version'
 import { extractorEntries } from './extractors'
 import { commands, displayName, version } from './generated-meta'
 import { useCodeActions } from './providers/code-actions'
@@ -42,13 +42,13 @@ export const { activate, deactivate } = defineExtension(() => {
     onCleanup(() => Disposable.from(...disposables).dispose())
   })
 
+  useInternalCommands()
   useDiagnostics()
   useCodeActions()
   useCodeLens()
 
   useCommands({
     [commands.openInBrowser]: openInBrowser,
     [commands.openFileInNpmx]: openFileInNpmx,
-    [commands.updateVersion]: updateVersion,
   })
 })

src/index.ts

@@ -1,19 +1,13 @@
 import type { DependencyInfo, Extractor } from '#types/extractor'
-import type { CodeLensProvider, Range, TextDocument } from 'vscode'
+import type { CodeLensProvider, TextDocument } from 'vscode'
+import { internalCommands } from '#state'
 import { getPackageInfo } from '#utils/api/package'
 import { getUpdateType } from '#utils/semver'
 import { formatVersion, isSupportedProtocol, parseVersion } from '#utils/version'
 import { debounce } from 'perfect-debounce'
 import { CodeLens, EventEmitter } from 'vscode'
-import { commands } from '../../generated-meta'
 
-interface LensData {
-  dep: DependencyInfo
-  versionRange: Range
-  uri: TextDocument['uri']
-}
-
-const dataMap = new WeakMap<CodeLens, LensData>()
+const dataMap = new WeakMap<CodeLens, DependencyInfo>()
 
 export class VersionCodeLensProvider<T extends Extractor> implements CodeLensProvider {
   extractor: T
@@ -42,19 +36,18 @@ export class VersionCodeLensProvider<T extends Extractor> implements CodeLensPro
 
       const versionRange = this.extractor.getNodeRange(document, dep.versionNode)
       const lens = new CodeLens(versionRange)
-      dataMap.set(lens, { dep, versionRange, uri: document.uri })
+      dataMap.set(lens, dep)
       lenses.push(lens)
     }
 
     return lenses
   }
 
   resolveCodeLens(lens: CodeLens) {
-    const data = dataMap.get(lens)
-    if (!data)
+    const dep = dataMap.get(lens)
+    if (!dep)
       return lens
 
-    const { dep, versionRange, uri } = data
     const parsed = parseVersion(dep.version)
     if (!parsed) {
       lens.command = { title: '$(question) unknown', command: '' }
@@ -82,8 +75,8 @@ export class VersionCodeLensProvider<T extends Extractor> implements CodeLensPro
       const newVersion = formatVersion({ ...parsed, semver: latest })
       lens.command = {
         title: `$(arrow-up) ${newVersion} (${updateType})`,
-        command: commands.updateVersion,
-        arguments: [uri, versionRange, newVersion],
+        command: internalCommands.replaceText,
+        arguments: [lens.range, newVersion],
       }
     }
 

src/providers/code-lens/version.ts

@@ -5,3 +5,7 @@ import { displayName, scopedConfigs } from './generated-meta'
 export const config = defineConfig<NestedScopedConfigs>(scopedConfigs.scope)
 
 export const logger = defineLogger(displayName)
+
+export const internalCommands = {
+  replaceText: 'npmx.internal.replaceText',
+}