[cli] Store projectName in project.json when linking to a project (vercel#13611)

This PR adds `projectName` to `project.json` when you link or pull
project settings. This will be used by microfrontends in local
development to find the right microfrontends configuration and/or
suggest a better error message to the user.

Author: mknichel

.changeset/twelve-terms-chew.md

@@ -0,0 +1,5 @@
+---
+'vercel': patch
+---
+
+Save projectName in project.json when linking a Project.

internals/types/index.d.ts

@@ -421,6 +421,10 @@ export interface ProjectLink {
    * to the selected project root directory.
    */
   projectRootDirectory?: string;
+  /**
+   * Name of the Vercel Project.
+   */
+  projectName?: string;
 }
 
 export interface PaginationOptions {

packages/cli/src/util/projects/link.ts

@@ -47,6 +47,10 @@ const linkSchema = {
       type: 'string',
       minLength: 1,
     },
+    projectName: {
+      type: 'string',
+      minLength: 1,
+    },
   },
 };
 
@@ -318,7 +322,10 @@ export async function linkFolderToProject(
 
   await writeFile(
     join(path, VERCEL_DIR, VERCEL_DIR_PROJECT),
-    JSON.stringify(projectLink)
+    JSON.stringify({
+      ...projectLink,
+      projectName,
+    })
   );
 
   await writeReadme(path);

packages/cli/src/util/projects/project-settings.ts

@@ -43,6 +43,7 @@ export async function writeProjectSettings(
   const projectLinkAndSettings: ProjectLinkAndSettings = {
     projectId: isRepoLinked ? undefined : project.id,
     orgId: isRepoLinked ? undefined : org.id,
+    projectName: isRepoLinked ? undefined : project.name,
     settings: {
       createdAt: project.createdAt,
       framework: project.framework,

packages/cli/test/unit/commands/link/index.test.ts

@@ -313,6 +313,7 @@ describe('link', () => {
       const projectJson = await readJSON(join(cwd, '.vercel/project.json'));
       expect(projectJson.orgId).toEqual(user.id);
       expect(projectJson.projectId).toEqual(project.id);
+      expect(projectJson.projectName).toEqual(project.name);
     });
 
     it('should track use of redacted `--project` option', async () => {
@@ -373,6 +374,7 @@ describe('link', () => {
       const projectJson = await readJSON(join(cwd, '.vercel/project.json'));
       expect(projectJson.orgId).toEqual(user.id);
       expect(projectJson.projectId).toEqual(project.id);
+      expect(projectJson.projectName).toEqual(project.name);
 
       const gitignore = await readFile(join(cwd, '.gitignore'), 'utf8');
       expect(gitignore).toBe(`.vercel${EOL}`);
@@ -465,6 +467,7 @@ describe('link', () => {
     const projectJson = await readJSON(join(cwd, '.vercel/project.json'));
     expect(projectJson.orgId).toEqual(user.id);
     expect(projectJson.projectId).toEqual(project.id);
+    expect(projectJson.projectName).toEqual(project.name);
   });
 
   it('should create new Project', async () => {
@@ -539,6 +542,7 @@ describe('link', () => {
     let projectJson = await readJSON(join(cwd, '.vercel/project.json'));
     expect(projectJson.orgId).toEqual(user.id);
     expect(projectJson.projectId).toEqual(proj1.id);
+    expect(projectJson.projectName).toEqual(proj1.name);
 
     client.setArgv('--project', proj2.name!, '--yes');
     const exitCodeLink2 = await link(client);
@@ -547,6 +551,7 @@ describe('link', () => {
     projectJson = await readJSON(join(cwd, '.vercel/project.json'));
     expect(projectJson.orgId).toEqual(user.id);
     expect(projectJson.projectId).toEqual(proj2.id);
+    expect(projectJson.projectName).toEqual(proj2.name);
   });
 
   it('should track use of deprecated `cwd` positional argument', async () => {

packages/cli/test/unit/commands/pull/index.test.ts

@@ -133,6 +133,7 @@ describe('pull', () => {
         {
           "orgId": "team_dummy",
           "projectId": "vercel-pull-next",
+          "projectName": "vercel-pull-next",
           "settings": {
             "createdAt": 1555413045188,
           },