refactor: reorganize api-related utils

Author: 9romise

eslint.config.js eslint.config.tseslint.config.js renamed to eslint.config.ts

@@ -7,3 +7,6 @@ export const PNPM_WORKSPACE_PATTERN = `**/${PNPM_WORKSPACE_BASENAME}`
 export const VERSION_TRIGGER_CHARACTERS = ['.', '^', '~', ...Array.from({ length: 10 }).map((_, i) => `${i}`)]
 
 export const CACHE_TTL_ONE_DAY = 1000 * 60 * 60 * 24
+
+export const NPM_REGISTRY = 'https://registry.npmjs.org'
+export const NPMX_DEV_API = 'https://npmx.dev/api'

src/constants.ts

@@ -1,8 +1,8 @@
 import type { Extractor } from '#types/extractor'
 import type { CompletionItemProvider, Position, TextDocument } from 'vscode'
 import { config } from '#state'
-import { getPackageInfo } from '#utils/npm'
-import { extractVersionPrefix } from '#utils/version'
+import { getPackageInfo } from '#utils/api/package'
+import { extractVersionPrefix } from '#utils/package'
 import { CompletionItem, CompletionItemKind } from 'vscode'
 
 export class VersionCompletionItemProvider<T extends Extractor> implements CompletionItemProvider {

src/providers/completion-item/version.ts

@@ -1,10 +1,10 @@
 import type { DependencyInfo, Extractor, ValidNode } from '#types/extractor'
-import type { ResolvedPackument } from '#utils/npm'
+import type { ResolvedPackument } from '#utils/api/package'
 import type { Awaitable } from 'reactive-vscode'
 import type { Diagnostic, TextDocument } from 'vscode'
 import { basename } from 'node:path'
 import { config, logger } from '#state'
-import { getPackageInfo } from '#utils/npm'
+import { getPackageInfo } from '#utils/api/package'
 import { useActiveTextEditor, useDocumentText, watch } from 'reactive-vscode'
 import { languages } from 'vscode'
 import { displayName } from '../../generated-meta'

src/providers/diagnostics/index.ts

@@ -1,5 +1,5 @@
 import type { DiagnosticRule } from '..'
-import { extractVersion } from '#utils/version'
+import { extractVersion } from '#utils/package'
 import { DiagnosticSeverity } from 'vscode'
 
 export const checkDeprecation: DiagnosticRule = (dep, pkg) => {

src/providers/diagnostics/rules/deprecation.ts

@@ -1,6 +1,6 @@
-import type { ModuleReplacement } from 'module-replacements'
+import type { ModuleReplacement } from '#utils/api/replacement'
 import type { DiagnosticRule } from '..'
-import { getReplacement } from '#utils/npmx'
+import { getReplacement } from '#utils/api/replacement'
 import { DiagnosticSeverity } from 'vscode'
 
 // https://github.com/npmx-dev/npmx.dev/blob/main/app/components/PackageReplacement.vue#L8-L30

src/providers/diagnostics/rules/replacement.ts

@@ -1,7 +1,7 @@
-import type { OsvSeverityLevel } from '#utils/npmx'
+import type { OsvSeverityLevel } from '#utils/api/vulnerability'
 import type { DiagnosticRule } from '..'
-import { getVulnerability, SEVERITY_LEVELS } from '#utils/npmx'
-import { extractVersion } from '#utils/version'
+import { getVulnerability, SEVERITY_LEVELS } from '#utils/api/vulnerability'
+import { extractVersion } from '#utils/package'
 import { DiagnosticSeverity } from 'vscode'
 
 const DIAGNOSTIC_MAPPING: Record<Exclude<OsvSeverityLevel, 'unknown'>, DiagnosticSeverity> = {

src/providers/diagnostics/rules/vulnerability.ts

@@ -1,7 +1,7 @@
 import type { Extractor } from '#types/extractor'
 import type { HoverProvider, Position, TextDocument } from 'vscode'
-import { getPackageInfo } from '#utils/npm'
-import { extractVersion } from '#utils/version'
+import { getPackageInfo } from '#utils/api/package'
+import { extractVersion } from '#utils/package'
 import { Hover, MarkdownString } from 'vscode'
 
 export class NpmxHoverProvider<T extends Extractor> implements HoverProvider {

src/providers/hover/npmx.ts

@@ -1,9 +1,9 @@
 import type { Packument, PackumentVersion } from '@npm/types'
+import { NPM_REGISTRY } from '#constants'
 import { logger } from '#state'
+import { encodePackageName } from '#utils/package'
 import { ofetch } from 'ofetch'
-import { memoize } from './memoize'
-
-const NPM_REGISTRY = 'https://registry.npmjs.org'
+import { memoize } from '../memoize'
 
 interface ResolvedPackumentVersion extends Pick<PackumentVersion, 'version'> {
   tag?: string
@@ -15,17 +15,6 @@ export interface ResolvedPackument {
   versions: Record<string, ResolvedPackumentVersion>
 }
 
-/**
- * Encode a package name for use in npm registry URLs.
- * Handles scoped packages (e.g., @scope/name -> @scope%2Fname).
- */
-export function encodePackageName(name: string): string {
-  if (name.startsWith('@')) {
-    return `@${encodeURIComponent(name.slice(1))}`
-  }
-  return encodeURIComponent(name)
-}
-
 export const getPackageInfo = memoize<string, Promise<ResolvedPackument>>(async (name) => {
   logger.info(`Fetching package info for ${name}`)
   const encodedName = encodePackageName(name)

src/utils/npm.ts src/utils/api/package.tssrc/utils/npm.ts renamed to src/utils/api/package.ts

@@ -0,0 +1,20 @@
+import type { ModuleReplacement } from 'module-replacements'
+import { NPMX_DEV_API } from '#constants'
+import { logger } from '#state'
+import { ofetch } from 'ofetch'
+import { memoize } from '../memoize'
+import { encodePackageName } from '../package'
+
+export type {
+  ModuleReplacement,
+}
+
+export const getReplacement = memoize<string, Promise<ModuleReplacement>>(async (name) => {
+  logger.info(`Fetching replacements for ${name}`)
+  const encodedName = encodePackageName(name)
+
+  const result = await ofetch<ModuleReplacement>(`${NPMX_DEV_API}/replacements/${encodedName}`)
+  logger.info(`Fetched replacements for ${name}`)
+
+  return result
+})