feat: show pkg desc on vscode not builtin dependencies node

tjx666 · Jun 30, 2024 · e76d32f · e76d32f
1 parent 8b72007
commit e76d32f
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 10 deletions.
diff --git a/src/hoverTooltips/dependencies.ts b/src/hoverTooltips/dependencies.ts
@@ -14,7 +14,7 @@ export class DependenciesHoverProvider implements HoverProvider {
         const pkgNameAndVersion = await getPkgNameAndVersionFromDocPosition(document, position);
         if (!pkgNameAndVersion) return;
 
-        const { name, version } = pkgNameAndVersion;
+        const { name, version, dependenciesNodePath } = pkgNameAndVersion;
         const info = await getPackageInfo(name, {
             packageInstallDir: await findPkgInstallDir(name, document.uri.fsPath),
             searchVersionRange: version,
@@ -27,7 +27,11 @@ export class DependenciesHoverProvider implements HoverProvider {
         if (!info) return;
 
         const pkgHoverContentsCreator = getPkgHoverContentsCreator();
-        const hoverContents = pkgHoverContentsCreator.generate(info);
+        const isVscodeBuiltinShowDesc =
+            !dependenciesNodePath.includes('.') && dependenciesNodePath.endsWith('dependencies');
+        const hoverContents = pkgHoverContentsCreator.generate(info, {
+            showDescription: !isVscodeBuiltinShowDesc,
+        });
         return new Hover(hoverContents);
     }
 }
diff --git a/src/utils/pkg.ts b/src/utils/pkg.ts
@@ -56,19 +56,19 @@ export async function getPkgNameAndVersionFromDocPosition(
     const nameNode = findNodeAtOffset(root, document.offsetAt(position));
     if (!nameNode || !nameNode.parent) return;
 
-    const dependenciesNodes =
-        configuration.packageJsonDependenciesCodeLens.dependenciesNodePaths.map((path) =>
-            findNodeAtLocation(root, path.split('.')),
-        );
-
     const versionNode = nameNode.parent.children![1];
-    const isHoverOverDependency =
+    let isHoverOverDependency =
         nameNode.type === 'string' &&
         versionNode.type === 'string' &&
         nameNode.parent?.type === 'property' &&
         nameNode.parent.children?.length === 2 &&
-        nameNode === nameNode.parent.children![0] &&
-        dependenciesNodes.includes(nameNode.parent?.parent);
+        nameNode === nameNode.parent.children![0];
+    const dependenciesNodePath =
+        configuration.packageJsonDependenciesCodeLens.dependenciesNodePaths.find((path) => {
+            const node = findNodeAtLocation(root, path.split('.'));
+            return node === nameNode.parent?.parent;
+        });
+    isHoverOverDependency = isHoverOverDependency && !!dependenciesNodePath;
     if (!isHoverOverDependency) return;
 
     const pkgName = nameNode.value;
@@ -77,6 +77,7 @@ export async function getPkgNameAndVersionFromDocPosition(
     return {
         nameNode,
         versionNode,
+        dependenciesNodePath: dependenciesNodePath!,
         name: pkgName,
         version: versionNode.value!,
     };

diff --git a/test-workspace/pkg-json-codelens/package.json b/test-workspace/pkg-json-codelens/package.json
@@ -20,5 +20,8 @@
         "bbb": "233",
         "vscode": "1.1.37",
         "execa": "^7.1.1"
+    },
+    "resolutions": {
+        "axios": "0.28.1"
     }
 }