Merge pull request #15 from aarondill/dev

feat: add vercel.DashboardURL for use with teams

README.md

@@ -34,6 +34,7 @@ This extension contributes the following settings:
 
 - `vercel.RefreshRate`: Number of minutes to wait between refreshes of Deployments and Environment. (Default 5 minutes)
 - `vercel.DeploymentCount`: Number of deployments to display from Vercel. (Default 20)
+- `vercel.TeamDashboardURL`: (For use with teams) The URL to append the project name to.
 
 ## Contributing
 

package.json

@@ -145,6 +145,11 @@
           "minimum": 1,
           "maximum": 100,
           "description": "Number of deployments to fetch from Vercel."
+        },
+        "vercel.TeamDashboardURL": {
+          "type": "string",
+          "default": "",
+          "description": "(For use with teams) The URL to append the project name to. If not set, it will default to https://vercel.com/{user}/{project}"
         }
       }
     },

src/commands/Deployments/openDeploymentsLink.ts

@@ -1,24 +1,14 @@
 import * as vscode from "vscode";
 import type { Command } from "../../CommandManager";
 import type { VercelManager } from "../../features/VercelManager";
+import getProjectDashboard from "../../utils/dashboard";
 
 export class OpenDeploymentsLink implements Command {
   public readonly id = "vercel.openDeploymentsLink";
   constructor(private readonly vercel: VercelManager) {}
   dispose() {}
   async execute() {
-    const projectInfo = await this.vercel.project.getInfo();
-    if (!projectInfo) return;
-    const user = await this.vercel.user.getInfo();
-    if (!user)
-      return void vscode.window.showErrorMessage("Could not get user info!");
-    const base = vscode.Uri.parse("https://vercel.com");
-    const url = vscode.Uri.joinPath(
-      base,
-      user.username,
-      projectInfo.name,
-      "/deployments"
-    );
-    await vscode.env.openExternal(url);
+    const url = await getProjectDashboard(this.vercel, "/deployments");
+    if (url) await vscode.env.openExternal(url);
   }
 }

src/commands/Environment/openEnvironmentLink.ts

@@ -1,24 +1,17 @@
 import * as vscode from "vscode";
 import type { Command } from "../../CommandManager";
 import type { VercelManager } from "../../features/VercelManager";
+import getProjectDashboard from "../../utils/dashboard";
 
 export class OpenEnvironmentLink implements Command {
   public readonly id = "vercel.openEnvironmentLink";
   constructor(private readonly vercel: VercelManager) {}
   dispose() {}
   async execute() {
-    const projectInfo = await this.vercel.project.getInfo();
-    if (!projectInfo) return;
-    const user = await this.vercel.user.getInfo();
-    if (!user)
-      return void vscode.window.showErrorMessage("Could not get user info!");
-    const base = vscode.Uri.parse("https://vercel.com");
-    const url = vscode.Uri.joinPath(
-      base,
-      user.username,
-      projectInfo.name,
+    const url = await getProjectDashboard(
+      this.vercel,
       "/settings/environment-variables"
     );
-    await vscode.commands.executeCommand("vscode.open", url);
+    if (url) await vscode.env.openExternal(url);
   }
 }

src/features/VercelManager.ts

@@ -45,6 +45,7 @@ export class VercelManager {
     };
   }
   loggedIn = async () => !!(await this.token.getAuth())?.accessToken;
+  teamId = async () => (await this.token.getAuth())?.teamId;
   async debug(): Promise<Record<string, unknown>> {
     const ident = (x: unknown) => x;
     const orErr = <T>(p: Thenable<T>) => p.then(ident, ident);

src/utils/dashboard.ts

@@ -0,0 +1,39 @@
+import type { VercelManager } from "../features/VercelManager";
+import * as vscode from "vscode";
+
+async function getBaseURL(
+  vercel: VercelManager
+): Promise<vscode.Uri | undefined> {
+  const teamId = await vercel.teamId();
+  const projectAccountId = (await vercel.project.getInfo())?.accountId;
+  // If the current progect is a team project, use the team dashboard URL
+  if (teamId && projectAccountId === teamId) {
+    const userURL = vscode.workspace
+      .getConfiguration("vercel")
+      .get("TeamDashboardURL");
+    if (typeof userURL !== "string" || userURL.length === 0) {
+      return void vscode.window.showErrorMessage(
+        "To open the team dashboard, please set the TeamDashboardURL setting."
+      );
+    }
+    return vscode.Uri.parse(userURL);
+  }
+
+  // Else, use the default URL and append the username
+  const base = vscode.Uri.parse("https://vercel.com");
+  const user = await vercel.user.getInfo();
+  if (!user)
+    return void vscode.window.showErrorMessage("Could not get user info!");
+  return vscode.Uri.joinPath(base, user.username);
+}
+export async function getProjectDashboard(
+  vercel: VercelManager,
+  path: string
+): Promise<vscode.Uri | undefined> {
+  const projectInfo = await vercel.project.getInfo();
+  if (!projectInfo) return;
+  const base = await getBaseURL(vercel);
+  if (!base) return;
+  return vscode.Uri.joinPath(base, projectInfo.name, path);
+}
+export default getProjectDashboard;