feat: provide definition for catalogs (#78)

* feat: provide definition for catalogs

* fix

* fix: normalize catalog names

Author: 9romise

playground/package.json

@@ -14,7 +14,7 @@
     "ofetch": "^2.0.0-alpha.1",
     "array-includes": "latest",
     "axios": "",
-    "is-number": "catalog:",
+    "is-number": "catalog:dev",
     "lodash": "catalog:"
   }
 }

src/core/extractors/yaml.ts

@@ -1,5 +1,6 @@
 import type { BaseExtractor, DependencyInfo, OffsetRange, WorkspaceCatalogExtractor, WorkspaceCatalogInfo, YamlNode } from '#types/extractor'
 import type { Pair, Scalar, YAMLMap } from 'yaml'
+import { normalizeCatalogName } from '#utils/dependency'
 import { isMap, isPair, isScalar, parseDocument } from 'yaml'
 
 const CATALOG_SECTION = 'catalog'
@@ -48,7 +49,7 @@ export class YamlExtractor implements WorkspaceCatalogExtractor, BaseExtractor<Y
 
   #traverseCatalogs(root: YAMLMap, callback: CatalogEntryVisitor): boolean {
     const catalog = root.items.find((i) => isScalar(i.key) && i.key.value === CATALOG_SECTION)
-    if (this.#traverseCatalog(catalog, { category: 'catalog' }, callback))
+    if (this.#traverseCatalog(catalog, { category: 'catalog', categoryName: '' }, callback))
       return true
 
     const catalogs = root.items.find((i) => isScalar(i.key) && i.key.value === CATALOGS_SECTION)
@@ -92,7 +93,7 @@ export class YamlExtractor implements WorkspaceCatalogExtractor, BaseExtractor<Y
     const catalogs: Record<string, Record<string, string>> = {}
 
     for (const dependency of dependencies) {
-      const categoryName = dependency.category === 'catalog' ? 'default' : dependency.categoryName || 'default'
+      const categoryName = normalizeCatalogName(dependency.categoryName!)
       catalogs[categoryName] ??= {}
       catalogs[categoryName][dependency.rawName] = dependency.rawSpec
     }

src/core/workspace.ts

@@ -38,6 +38,7 @@ async function getPackageManager(uri: Uri): Promise<PackageManager> {
 class WorkspaceContext {
   folder: WorkspaceFolder
   packageManager: PackageManager = 'npm'
+  workspaceFileUri?: Uri
   #catalogs?: PromiseWithResolvers<CatalogsInfo | undefined>
   #invalidatedPaths = new Set<string>()
 
@@ -61,10 +62,10 @@ class WorkspaceContext {
     if (this.packageManager !== 'npm') {
       this.#catalogs = Promise.withResolvers()
       const workspaceFilename = workspaceFileMapping[this.packageManager]
-      const workspaceFile = Uri.joinPath(this.folder.uri, workspaceFilename)
+      this.workspaceFileUri = Uri.joinPath(this.folder.uri, workspaceFilename)
       this.#catalogs.resolve(
-        await accessOk(workspaceFile)
-          ? (await this.loadWorkspaceCatalogInfo(workspaceFile))?.catalogs
+        await accessOk(this.workspaceFileUri)
+          ? (await this.loadWorkspaceCatalogInfo(this.workspaceFileUri))?.catalogs
           : undefined,
       )
     }

src/index.ts

@@ -6,6 +6,7 @@ import { commands, displayName, version } from './generated-meta'
 import { useCodeActions } from './providers/code-actions'
 import { useCompletionItem } from './providers/completion-item'
 import { useDecorators } from './providers/decorators'
+import { useDefinition } from './providers/definition'
 import { useDiagnostics } from './providers/diagnostics'
 import { useDocumentLink } from './providers/document-link'
 import { useHover } from './providers/hover'
@@ -22,6 +23,7 @@ export const { activate, deactivate } = defineExtension(() => {
   useDecorators()
   useCodeActions()
   useDocumentLink()
+  useDefinition()
 
   useCommands({
     [commands.openInBrowser]: openInBrowser,

src/providers/definition/catalog.ts

@@ -0,0 +1,38 @@
+import type { DefinitionProvider, Position, TextDocument } from 'vscode'
+import { getResolvedDependencyByOffset, getWorkspaceContext } from '#core/workspace'
+import { offsetRangeToRange } from '#utils/ast'
+import { normalizeCatalogName } from '#utils/dependency'
+import { Location, workspace } from 'vscode'
+
+export class CatalogDefinitionProvider implements DefinitionProvider {
+  async provideDefinition(document: TextDocument, position: Position) {
+    const offset = document.offsetAt(position)
+    const info = await getResolvedDependencyByOffset(document.uri, offset)
+    if (!info?.rawSpec.startsWith('catalog:'))
+      return
+
+    const ctx = await getWorkspaceContext(document.uri)
+    if (!ctx?.workspaceFileUri)
+      return
+
+    const catalogInfo = await ctx.loadWorkspaceCatalogInfo(ctx.workspaceFileUri)
+    if (!catalogInfo)
+      return
+
+    const target = catalogInfo.dependencies.find(
+      (dep) =>
+        dep.rawName === info.resolvedName
+        && dep.categoryName != null && info.categoryName != null
+        && normalizeCatalogName(dep.categoryName) === normalizeCatalogName(info.categoryName),
+    )
+    if (!target)
+      return
+
+    const workspaceDocument = await workspace.openTextDocument(ctx.workspaceFileUri)
+
+    return new Location(
+      ctx.workspaceFileUri,
+      offsetRangeToRange(workspaceDocument, target.specRange),
+    )
+  }
+}

src/providers/definition/index.ts

@@ -0,0 +1,10 @@
+import { PACKAGE_JSON_BASENAME } from '#constants'
+import { useDisposable } from 'reactive-vscode'
+import { languages } from 'vscode'
+import { CatalogDefinitionProvider } from './catalog'
+
+export function useDefinition() {
+  useDisposable(
+    languages.registerDefinitionProvider({ pattern: `**/${PACKAGE_JSON_BASENAME}` }, new CatalogDefinitionProvider()),
+  )
+}

src/utils/dependency.ts

@@ -11,7 +11,7 @@ const DEFAULT_CATALOG_NAME = 'default'
 const GIT_PATTERN = /^(?:git\+|git:\/\/|github:|gitlab:|bitbucket:|ssh:\/\/git@)/i
 const HTTP_PATTERN = /^https?:/i
 
-function normalizeCatalogName(name: string): string {
+export function normalizeCatalogName(name: string): string {
   return name.trim() || DEFAULT_CATALOG_NAME
 }