enhance: show vaults by name instead of path (#1078)

* chore: auto build on dev

* enhance: show vaults by name instead of path

Author: kevinslin

.github/workflows/ci.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - master
+      - dev
       - integ-publish
   pull_request:
     branches:

packages/plugin-core/src/components/lookup/utils.ts

@@ -41,7 +41,7 @@ export const CONTEXT_DETAIL = "current note context";
 export const HIERARCHY_MATCH_DETAIL = "hierarchy match";
 export const FULL_MATCH_DETAIL = "hierarchy match and current note context";
 
-export type VaultPickerItem = { vault: DVault } & Partial<QuickPickItem>;
+export type VaultPickerItem = { vault: DVault, label: string } & Partial<Omit<QuickPickItem, "label">>;
 
 function isDVaultArray(
   overrides?: VaultPickerItem[] | DVault[]
@@ -452,14 +452,14 @@ export class PickerUtilsV2 {
   ): Promise<DVault | undefined> {
     const pickerOverrides = isDVaultArray(overrides)
       ? overrides.map((value) => {
-          return { vault: value };
+          return { vault: value, label: VaultUtils.getName(value) };
         })
       : overrides;
 
     const vaults: VaultPickerItem[] =
       pickerOverrides ??
-      DendronWorkspace.instance().vaultsv4.map((value) => {
-        return { vault: value };
+      DendronWorkspace.instance().vaultsv4.map((vault) => {
+        return { vault, label: VaultUtils.getName(vault) };
       });
 
     const items = vaults.map((ent) => ({
@@ -492,7 +492,7 @@ export class PickerUtilsV2 {
 
     // Only 1 vault, no other options to choose from:
     if (engine.vaults.length <= 1) {
-      return Array.of({ vault });
+      return Array.of({ vault, label: VaultUtils.getName(vault) });
     }
 
     const domain = fname.split(".").slice(0, -1);
@@ -517,6 +517,7 @@ export class PickerUtilsV2 {
           return {
             vault: value,
             detail: HIERARCHY_MATCH_DETAIL,
+            label: VaultUtils.getName(vault)
           };
         });
 
@@ -525,11 +526,12 @@ export class PickerUtilsV2 {
       vaultSuggestions.push({
         vault,
         detail: CONTEXT_DETAIL,
+        label: VaultUtils.getName(vault)
       });
 
       allVaults.forEach((cmpVault) => {
         if (cmpVault.fsPath !== vault.fsPath) {
-          vaultSuggestions.push({ vault: cmpVault });
+          vaultSuggestions.push({ vault: cmpVault, label: VaultUtils.getName(vault) });
         }
       });
     }
@@ -543,6 +545,7 @@ export class PickerUtilsV2 {
       vaultSuggestions.push({
         vault,
         detail: FULL_MATCH_DETAIL,
+        label: VaultUtils.getName(vault)
       });
 
       vaultsWithMatchingHierarchy.forEach((ent) => {
@@ -554,6 +557,7 @@ export class PickerUtilsV2 {
           vaultSuggestions.push({
             vault: ent.vault,
             detail: HIERARCHY_MATCH_DETAIL,
+            label: VaultUtils.getName(vault)
           });
         }
       });
@@ -564,7 +568,7 @@ export class PickerUtilsV2 {
             (suggestion) => suggestion.vault.fsPath === wsVault.fsPath
           )
         ) {
-          vaultSuggestions.push({ vault: wsVault });
+          vaultSuggestions.push({ vault: wsVault, label: VaultUtils.getName(wsVault) });
         }
       });
     } else {
@@ -573,6 +577,7 @@ export class PickerUtilsV2 {
       vaultSuggestions.push({
         vault,
         detail: CONTEXT_DETAIL,
+        label: VaultUtils.getName(vault)
       });
 
       allVaults.forEach((wsVault) => {
@@ -581,7 +586,7 @@ export class PickerUtilsV2 {
             (suggestion) => suggestion.vault.fsPath === wsVault.fsPath
           )
         ) {
-          vaultSuggestions.push({ vault: wsVault });
+          vaultSuggestions.push({ vault: wsVault, label: VaultUtils.getName(wsVault) });
         }
       });
     }

packages/plugin-core/src/test/suite-integ/utils.test.ts

@@ -0,0 +1,35 @@
+import { VaultUtils } from "@dendronhq/common-all";
+import {
+	ENGINE_HOOKS
+} from "@dendronhq/engine-test-utils";
+import { describe } from "mocha";
+import sinon from "sinon";
+import { PickerUtilsV2, VaultPickerItem } from "../../components/lookup/utils";
+import { VSCodeUtils } from "../../utils";
+import { expect } from "../testUtilsv2";
+import {
+	runLegacyMultiWorkspaceTest, setupBeforeAfter
+} from "../testUtilsV3";
+
+suite("Plugin Utils", function () {
+  describe("PickerUtils", function () {
+    const ctx = setupBeforeAfter(this);
+
+    test("vault picker", function (done) {
+      runLegacyMultiWorkspaceTest({
+        ctx,
+        postSetupHook: ENGINE_HOOKS.setupBasic,
+        onInit: async ({vaults}) => {
+					const stub = sinon.stub(VSCodeUtils, "showQuickPick").returns({} as any);
+					await PickerUtilsV2.promptVault();
+					const items: VaultPickerItem[] = vaults.map((vault) => ({
+						vault,
+						label: VaultUtils.getName(vault)
+					}));
+					expect(stub.calledOnceWith(items)).toBeTruthy();
+					done();
+				},
+      });
+    });
+  });
+});