refactor: extract shared files, move test files, prepare for lsp (#80)

9romise · web-flow · commit 0e1a17d7e885 · 2026-03-14T08:02:13.000Z
* refactor: move test &amp; shared files, prepare for lsp

* update

* update
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,7 @@
 .DS_Store
 node_modules
 dist
-src/generated-meta.ts
+shared/meta.ts
 
 # local env files
 .env.local
diff --git a/package.json b/package.json
@@ -200,12 +200,12 @@
     "dev": "tsdown --watch",
     "build": "tsdown",
     "postinstall": "npm run update",
-    "update": "vscode-ext-gen --scope npmx",
+    "update": "vscode-ext-gen --scope npmx --output ./shared/meta.ts",
     "check": "npm run lint:fix && npm run typecheck",
     "test": "vitest",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "typecheck": "tsgo --noEmit",
+    "typecheck": "tsgo -b --noEmit",
     "vscode:prepublish": "npm run build",
     "publish": "npx @vscode/vsce publish --no-dependencies",
     "package": "npx @vscode/vsce package --no-dependencies",
diff --git a/shared/constants.ts b/shared/constants.ts
diff --git a/shared/types.ts b/shared/types.ts
@@ -1,8 +1,10 @@
-import type { ConfigKey } from '../generated-meta'
+import type { ConfigKey } from './meta'
 
 type StripPrefix<T, Prefix extends string>
   = T extends `${Prefix}${infer Rest}`
     ? Rest
     : never
 
 export type DiagnosticsCode = StripPrefix<ConfigKey, 'npmx.diagnostics.'>
+
+export type PackageManager = 'npm' | 'pnpm' | 'yarn'
diff --git a/src/api/package.ts b/src/api/package.ts
@@ -1,5 +1,5 @@
 import type { MaybeError, PackageVersionsInfoWithMetadata } from 'fast-npm-meta'
-import { CACHE_MAX_AGE_ONE_DAY } from '#constants'
+import { CACHE_MAX_AGE_ONE_DAY } from '#shared/constants'
 import { logger } from '#state'
 import { createBatchRunner } from '#utils/batch'
 import { getVersionsBatch } from 'fast-npm-meta'
diff --git a/src/api/replacement.ts b/src/api/replacement.ts
@@ -1,5 +1,5 @@
 import type { ModuleReplacement } from 'module-replacements'
-import { CACHE_MAX_AGE_ONE_DAY, NPMX_DEV_API } from '#constants'
+import { CACHE_MAX_AGE_ONE_DAY, NPMX_DEV_API } from '#shared/constants'
 import { logger } from '#state'
 import { encodePackageName } from '#utils/package'
 import { defineCachedFunction } from 'ocache'
diff --git a/src/api/vulnerability.ts b/src/api/vulnerability.ts
@@ -1,4 +1,4 @@
-import { CACHE_MAX_AGE_ONE_DAY, NPMX_DEV_API } from '#constants'
+import { CACHE_MAX_AGE_ONE_DAY, NPMX_DEV_API } from '#shared/constants'
 import { logger } from '#state'
 import { encodePackageName, formatPackageId } from '#utils/package'
 import { defineCachedFunction } from 'ocache'
diff --git a/src/commands/add-to-ignore.ts b/src/commands/add-to-ignore.ts
@@ -1,7 +1,7 @@
 import type { ConfigurationTarget } from 'vscode'
+import { scopedConfigs } from '#shared/meta'
 import { checkIgnored } from '#utils/ignore'
 import { workspace } from 'vscode'
-import { scopedConfigs } from '../generated-meta'
 
 export async function addToIgnore(scope: string, name: string, target: ConfigurationTarget) {
   const ignoreScope = `ignore.${scope}`
diff --git a/src/commands/open-file-in-npmx.ts b/src/commands/open-file-in-npmx.ts
@@ -1,4 +1,4 @@
-import { PACKAGE_JSON_BASENAME } from '#constants'
+import { PACKAGE_JSON_BASENAME } from '#shared/constants'
 import { logger } from '#state'
 import { readPackageManifest } from '#utils/file'
 import { npmxFileUrl } from '#utils/links'
diff --git a/src/commands/open-in-browser.ts b/src/commands/open-in-browser.ts
@@ -1,4 +1,4 @@
-import { NPMX_DEV } from '#constants'
+import { NPMX_DEV } from '#shared/constants'
 import { env, Uri } from 'vscode'
 
 export function openInBrowser() {
diff --git a/src/composables/workspace-context.ts b/src/composables/workspace-context.ts
@@ -1,6 +1,6 @@
 import type { Uri } from 'vscode'
-import { SUPPORTED_DOCUMENT_PATTERN } from '#constants'
 import { deleteWorkspaceContextCache, getWorkspaceContext } from '#core/workspace'
+import { SUPPORTED_DOCUMENT_PATTERN } from '#shared/constants'
 import { logger } from '#state'
 import { isSupportedDependencyDocument, isWorkspaceLevelFile } from '#utils/file'
 import { useDisposable, useFileSystemWatcher } from 'reactive-vscode'
diff --git a/src/core/workspace.ts b/src/core/workspace.ts
@@ -1,9 +1,10 @@
-import type { CatalogsInfo, PackageManager, ResolvedDependencyInfo } from '#types/context'
+import type { PackageManager } from '#shared/types'
+import type { CatalogsInfo, ResolvedDependencyInfo } from '#types/context'
 import type { DependencyInfo, PackageManifestInfo, WorkspaceCatalogInfo } from '#types/extractor'
 import type { CacheOptions } from 'ocache'
 import type { WorkspaceFolder } from 'vscode'
 import { getPackageInfo } from '#api/package'
-import { PNPM_WORKSPACE_BASENAME, YARN_WORKSPACE_BASENAME } from '#constants'
+import { PNPM_WORKSPACE_BASENAME, YARN_WORKSPACE_BASENAME } from '#shared/constants'
 import { logger } from '#state'
 import { isOffsetInRange } from '#utils/ast'
 import { resolveDependencySpec } from '#utils/dependency'
@@ -29,7 +30,7 @@ async function getPackageManager(uri: Uri): Promise<PackageManager> {
     const result = await commands.executeCommand<PackageManager>('npm.packageManager', uri)
     return result || 'npm'
   } catch (error) {
-    console.error('Error getting package manager:', error)
+    logger.error('Error getting package manager:', error)
     window.showErrorMessage('Failed to detect package manager. Defaulting to npm.')
     return 'npm'
   }
diff --git a/src/index.ts b/src/index.ts
@@ -1,8 +1,8 @@
 import { useWorkspaceContext } from '#composables/workspace-context'
+import { commands, displayName, version } from '#shared/meta'
 import { defineExtension, useCommands } from 'reactive-vscode'
 import { openFileInNpmx } from './commands/open-file-in-npmx'
 import { openInBrowser } from './commands/open-in-browser'
-import { commands, displayName, version } from './generated-meta'
 import { useCodeActions } from './providers/code-actions'
 import { useCompletionItem } from './providers/completion-item'
 import { useDecorators } from './providers/decorators'
diff --git a/src/providers/code-actions/index.ts b/src/providers/code-actions/index.ts
@@ -1,4 +1,4 @@
-import { SUPPORTED_DOCUMENT_PATTERN } from '#constants'
+import { SUPPORTED_DOCUMENT_PATTERN } from '#shared/constants'
 import { config, internalCommands } from '#state'
 import { computed, useCommand, watch } from 'reactive-vscode'
 import { CodeActionKind, languages } from 'vscode'
diff --git a/src/providers/code-actions/quick-fix.test.ts b/src/providers/code-actions/quick-fix.test.ts
@@ -1,7 +1,7 @@
 import type { CodeActionContext, TextDocument } from 'vscode'
 import { describe, expect, it } from 'vitest'
 import { CodeActionKind, ConfigurationTarget, Diagnostic, DiagnosticSeverity, Range, Uri } from 'vscode'
-import { QuickFixProvider } from '../../src/providers/code-actions/quick-fix'
+import { QuickFixProvider } from './quick-fix'
 
 const provider = new QuickFixProvider()
 
diff --git a/src/providers/code-actions/quick-fix.ts b/src/providers/code-actions/quick-fix.ts
@@ -1,4 +1,4 @@
-import type { DiagnosticsCode } from '#types/meta'
+import type { DiagnosticsCode } from '#shared/types'
 import type { CodeActionContext, CodeActionProvider, Diagnostic, Range, TextDocument } from 'vscode'
 import { internalCommands } from '#state'
 import { CodeAction, CodeActionKind, ConfigurationTarget, WorkspaceEdit } from 'vscode'
diff --git a/src/providers/completion-item/index.ts b/src/providers/completion-item/index.ts
@@ -1,4 +1,4 @@
-import { PACKAGE_JSON_BASENAME, SUPPORTED_DOCUMENT_PATTERN } from '#constants'
+import { PACKAGE_JSON_BASENAME, SUPPORTED_DOCUMENT_PATTERN } from '#shared/constants'
 import { config } from '#state'
 import { watchEffect } from 'reactive-vscode'
 import { languages } from 'vscode'
diff --git a/src/providers/completion-item/version.ts b/src/providers/completion-item/version.ts
@@ -1,6 +1,6 @@
 import type { CompletionItemProvider, Position, TextDocument } from 'vscode'
-import { PRERELEASE_PATTERN } from '#constants'
 import { getResolvedDependencyByOffset } from '#core/workspace'
+import { PRERELEASE_PATTERN } from '#shared/constants'
 import { config } from '#state'
 import { offsetRangeToRange } from '#utils/ast'
 import { formatUpgradeVersion } from '#utils/version'
@@ -25,7 +25,7 @@ export class VersionCompletionItemProvider implements CompletionItemProvider {
     const items: CompletionItem[] = []
 
     for (const version in pkg.versionsMeta) {
-      const meta = pkg.versionsMeta[version]
+      const meta = pkg.versionsMeta[version]!
 
       if (meta.deprecated != null)
         continue
diff --git a/src/providers/definition/index.ts b/src/providers/definition/index.ts
@@ -1,4 +1,4 @@
-import { PACKAGE_JSON_BASENAME } from '#constants'
+import { PACKAGE_JSON_BASENAME } from '#shared/constants'
 import { useDisposable } from 'reactive-vscode'
 import { languages } from 'vscode'
 import { CatalogDefinitionProvider } from './catalog'
diff --git a/src/providers/diagnostics/index.ts b/src/providers/diagnostics/index.ts
@@ -2,15 +2,15 @@ import type { ResolvedDependencyInfo } from '#types/context'
 import type { OffsetRange } from '#types/extractor'
 import type { Awaitable } from 'reactive-vscode'
 import type { Diagnostic, TextDocument, Uri } from 'vscode'
-import { SUPPORTED_DOCUMENT_PATTERN } from '#constants'
 import { getResolvedDependencies } from '#core/workspace'
+import { SUPPORTED_DOCUMENT_PATTERN } from '#shared/constants'
+import { displayName } from '#shared/meta'
 import { config, logger } from '#state'
 import { offsetRangeToRange } from '#utils/ast'
 import { isSupportedDependencyDocument } from '#utils/file'
 import { debounce } from 'perfect-debounce'
 import { computed, nextTick, useActiveTextEditor, useDisposable, useDocumentText, useFileSystemWatcher, watch } from 'reactive-vscode'
 import { languages, TabInputText, window, workspace } from 'vscode'
-import { displayName } from '../../generated-meta'
 import { checkDeprecation } from './rules/deprecation'
 import { checkDistTag } from './rules/dist-tag'
 import { checkEngineMismatch } from './rules/engine-mismatch'
diff --git a/src/providers/diagnostics/rules/deprecation.test.ts b/src/providers/diagnostics/rules/deprecation.test.ts
@@ -1,6 +1,6 @@
+import { createContext } from '#test-utils/diagnostics'
 import { describe, expect, it } from 'vitest'
-import { checkDeprecation } from '../../src/providers/diagnostics/rules/deprecation'
-import { createContext } from './context'
+import { checkDeprecation } from './deprecation'
 
 function createDeprecationContext(version: string) {
   return createContext({
diff --git a/src/providers/diagnostics/rules/dist-tag.test.ts b/src/providers/diagnostics/rules/dist-tag.test.ts
@@ -1,6 +1,6 @@
+import { createContext } from '#test-utils/diagnostics'
 import { describe, expect, it } from 'vitest'
-import { checkDistTag } from '../../src/providers/diagnostics/rules/dist-tag'
-import { createContext } from './context'
+import { checkDistTag } from './dist-tag'
 
 describe('checkDistTag', () => {
   it('should flag when version matches a dist tag', async () => {
diff --git a/src/providers/diagnostics/rules/engine-mismatch.test.ts b/src/providers/diagnostics/rules/engine-mismatch.test.ts
@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { resolveEngineMismatches } from '../../src/providers/diagnostics/rules/engine-mismatch'
+import { resolveEngineMismatches } from './engine-mismatch'
 
 describe('resolveEngineMismatches', () => {
   it('should flag when engine ranges do not overlap', () => {
diff --git a/src/providers/diagnostics/rules/replacement.test.ts b/src/providers/diagnostics/rules/replacement.test.ts
@@ -1,6 +1,6 @@
+import { createContext } from '#test-utils/diagnostics'
 import { describe, expect, it } from 'vitest'
-import { checkReplacement } from '../../src/providers/diagnostics/rules/replacement'
-import { createContext } from './context'
+import { checkReplacement } from './replacement'
 
 function createReplacementContext(name: string) {
   return createContext({ name, version: '^1.0.0' })
diff --git a/src/providers/diagnostics/rules/upgrade.test.ts b/src/providers/diagnostics/rules/upgrade.test.ts
@@ -1,8 +1,8 @@
 import type { PackageInfo } from '#api/package'
 import type { ResolvedDependencyInfo } from '#types/context'
+import { createContext } from '#test-utils/diagnostics'
 import { describe, expect, it } from 'vitest'
-import { resolveUpgrade } from '../../src/providers/diagnostics/rules/upgrade'
-import { createContext } from './context'
+import { resolveUpgrade } from './upgrade'
 
 const distTags: Record<string, string> = {
   latest: '2.7.0',
diff --git a/src/providers/diagnostics/rules/vulnerability.test.ts b/src/providers/diagnostics/rules/vulnerability.test.ts
@@ -1,6 +1,6 @@
+import { createContext } from '#test-utils/diagnostics'
 import { describe, expect, it } from 'vitest'
-import { checkVulnerability } from '../../src/providers/diagnostics/rules/vulnerability'
-import { createContext } from './context'
+import { checkVulnerability } from './vulnerability'
 
 function createVulnerabilityContext(name: string) {
   return createContext({ name, version: '1.0.0', versionsMeta: { '1.0.0': {} } })
diff --git a/src/providers/document-link/index.ts b/src/providers/document-link/index.ts
@@ -1,4 +1,4 @@
-import { SUPPORTED_DOCUMENT_PATTERN } from '#constants'
+import { SUPPORTED_DOCUMENT_PATTERN } from '#shared/constants'
 import { config } from '#state'
 import { watchEffect } from 'reactive-vscode'
 import { languages } from 'vscode'
diff --git a/src/providers/hover/index.ts b/src/providers/hover/index.ts
@@ -1,4 +1,4 @@
-import { SUPPORTED_DOCUMENT_PATTERN } from '#constants'
+import { SUPPORTED_DOCUMENT_PATTERN } from '#shared/constants'
 import { config } from '#state'
 import { watchEffect } from 'reactive-vscode'
 import { languages } from 'vscode'
diff --git a/src/providers/hover/npmx.ts b/src/providers/hover/npmx.ts
@@ -1,6 +1,6 @@
 import type { HoverProvider, Position, TextDocument } from 'vscode'
-import { SPACER } from '#constants'
 import { getResolvedDependencyByOffset } from '#core/workspace'
+import { SPACER } from '#shared/constants'
 import { jsrPackageUrl, npmxDocsUrl, npmxPackageUrl } from '#utils/links'
 import { Hover, MarkdownString } from 'vscode'
 
diff --git a/src/state.ts b/src/state.ts
@@ -1,6 +1,6 @@
-import type { NestedScopedConfigs } from './generated-meta'
+import type { NestedScopedConfigs } from '#shared/meta'
+import { displayName, scopedConfigs } from '#shared/meta'
 import { defineConfig, defineLogger } from 'reactive-vscode'
-import { displayName, scopedConfigs } from './generated-meta'
 
 export const config = defineConfig<NestedScopedConfigs>(scopedConfigs.scope)
 
diff --git a/src/types/context.ts b/src/types/context.ts
@@ -1,8 +1,6 @@
 import type { PackageInfo } from '#api/package'
 import type { DependencyInfo } from '#types/extractor'
 
-export type PackageManager = 'npm' | 'pnpm' | 'yarn'
-
 export type DependencyProtocol
   = | 'npm'
     | 'jsr'
diff --git a/src/utils/batch.test.ts b/src/utils/batch.test.ts
diff --git a/src/utils/dependency.test.ts b/src/utils/dependency.test.ts
diff --git a/src/utils/file.ts b/src/utils/file.ts
@@ -1,6 +1,6 @@
 import type { PackageManifestInfo } from '#types/extractor'
 import type { TextDocument, Uri } from 'vscode'
-import { PACKAGE_JSON_BASENAME, PNPM_WORKSPACE_BASENAME, YARN_WORKSPACE_BASENAME } from '#constants'
+import { PACKAGE_JSON_BASENAME, PNPM_WORKSPACE_BASENAME, YARN_WORKSPACE_BASENAME } from '#shared/constants'
 import { basename } from 'pathe'
 import { workspace } from 'vscode'
 
diff --git a/src/utils/ignore.test.ts b/src/utils/ignore.test.ts
diff --git a/src/utils/links.ts b/src/utils/links.ts
@@ -1,4 +1,4 @@
-import { NPMX_DEV } from '#constants'
+import { NPMX_DEV } from '#shared/constants'
 
 const SPACES = /\s+/g
 
diff --git a/src/utils/package.test.ts b/src/utils/package.test.ts
diff --git a/src/utils/package.ts b/src/utils/package.ts
@@ -96,7 +96,7 @@ export function resolveExactVersion(pkg: PackageInfo, version: string) {
     version = 'latest'
 
   if (Object.hasOwn(pkg.distTags, version))
-    return pkg.distTags[version]
+    return pkg.distTags[version]!
 
   const versions = Object.keys(pkg.versionsMeta)
   if (versions.length === 0)
diff --git a/src/utils/version.test.ts b/src/utils/version.test.ts
diff --git a/tests/__setup__/msw.ts b/tests/__setup__/msw.ts
@@ -1,4 +1,4 @@
-import { NPMX_DEV_API } from '#constants'
+import { NPMX_DEV_API } from '#shared/constants'
 import { all } from 'module-replacements'
 import { http, HttpResponse } from 'msw'
 import { setupServer } from 'msw/node'
diff --git a/tests/utils/diagnostics.ts b/tests/utils/diagnostics.ts
@@ -1,9 +1,9 @@
-import type { PackageInfo } from '#api/package'
 import type { Engines } from 'fast-npm-meta'
+import type { PackageInfo } from '../../src/api/package'
 import type { DiagnosticContext } from '../../src/providers/diagnostics'
-import { resolveDependencySpec } from '#utils/dependency'
-import { resolveExactVersion } from '#utils/package'
 import { Uri } from 'vscode'
+import { resolveDependencySpec } from '../../src/utils/dependency'
+import { resolveExactVersion } from '../../src/utils/package'
 
 interface CreateContextOptions {
   name: string
diff --git a/tsconfig.app.json b/tsconfig.app.json
@@ -0,0 +1,21 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tsbuildinfo/app",
+    "paths": {
+      "#shared/*": ["./shared/*"],
+      "#state": ["./src/state.ts"],
+      "#api/*": ["./src/api/*"],
+      "#types/*": ["./src/types/*"],
+      "#utils/*": ["./src/utils/*"],
+      "#core/*": ["./src/core/*"],
+      "#composables/*": ["./src/composables/*"],
+      "#test-utils/*": ["./tests/utils/*"]
+    }
+  },
+  "include": [
+    "src/**/*",
+    "shared",
+    "tests"
+  ]
+}
diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "lib": ["ESNext"],
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "types": ["node"],
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitThis": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noEmit": true,
+    "skipLibCheck": true
+  }
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,24 +1,6 @@
 {
-  "compilerOptions": {
-    "target": "ESNext",
-    "lib": ["ESNext"],
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "paths": {
-      "#constants": ["./src/constants.ts"],
-      "#state": ["./src/state.ts"],
-      "#types/*": ["./src/types/*"],
-      "#api/*": ["./src/api/*"],
-      "#utils/*": ["./src/utils/*"],
-      "#core/*": ["./src/core/*"],
-      "#composables/*": ["./src/composables/*"]
-    },
-    "resolveJsonModule": true,
-    "strict": true,
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitThis": true,
-    "noUnusedLocals": true,
-    "noEmit": true,
-    "skipLibCheck": true
-  }
+  "references": [
+    { "path": "./tsconfig.app.json" }
+  ],
+  "files": []
 }
diff --git a/vitest.config.ts b/vitest.config.ts
@@ -4,7 +4,7 @@ import { defineConfig } from 'vitest/config'
 export default defineConfig({
   plugins: [tsconfigPaths()],
   test: {
-    include: ['tests/**/*.test.ts'],
+    include: ['**/*.test.ts'],
     setupFiles: ['tests/__setup__/index.ts'],
     server: {
       deps: {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { CACHE_MAX_AGE_ONE_DAY, NPMX_DEV_API } from '#constants'`
	`1`	`+import { CACHE_MAX_AGE_ONE_DAY, NPMX_DEV_API } from '#shared/constants'`
`2`	`2`	`import { logger } from '#state'`
`3`	`3`	`import { encodePackageName, formatPackageId } from '#utils/package'`
`4`	`4`	`import { defineCachedFunction } from 'ocache'`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { PACKAGE_JSON_BASENAME } from '#constants'`
	`1`	`+import { PACKAGE_JSON_BASENAME } from '#shared/constants'`
`2`	`2`	`import { logger } from '#state'`
`3`	`3`	`import { readPackageManifest } from '#utils/file'`
`4`	`4`	`import { npmxFileUrl } from '#utils/links'`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { NPMX_DEV } from '#constants'`
	`1`	`+import { NPMX_DEV } from '#shared/constants'`
`2`	`2`	`import { env, Uri } from 'vscode'`
`3`	`3`
`4`	`4`	`export function openInBrowser() {`