ProjectOptions: adjust misnomer

Already in b46912d (PatchSeries: allow initializing from notes,
2018-05-31), the `ProjectOptions` instance that gets constructed when
initializing from Git notes receives the `headCommit` as `branchName`
parameter. Therefore, that name is misleading.

Let's rename the parameter to `headCommit`, to reflect what is being
passed in.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>

Author: dscho

lib/patch-series.ts

@@ -570,9 +570,9 @@ export class PatchSeries {
     ): Promise<IPatchSeriesMetadata | undefined> {
         let globalOptions: IGitGitGadgetOptions | undefined;
         if (this.options.dryRun) {
-            logger.log(`Dry-run ${this.project.branchName} v${this.metadata.iteration}`);
+            logger.log(`Dry-run ${this.project.headCommit} v${this.metadata.iteration}`);
         } else {
-            logger.log(`Submitting ${this.project.branchName} v${this.metadata.iteration}`);
+            logger.log(`Submitting ${this.project.headCommit} v${this.metadata.iteration}`);
             globalOptions = await this.notes.get<IGitGitGadgetOptions>("");
         }
 
@@ -645,7 +645,7 @@ export class PatchSeries {
         );
         let tagName: string | undefined;
         if (!this.metadata.pullRequestURL) {
-            tagName = `${this.project.branchName}-v${this.metadata.iteration}`;
+            tagName = `${this.project.headCommit}-v${this.metadata.iteration}`;
         } else {
             const prKey = getPullRequestKeyFromURL(this.metadata.pullRequestURL);
             const branch = this.metadata.headLabel.replace(/:/g, "/");
@@ -816,7 +816,7 @@ export class PatchSeries {
         }
 
         if (!this.options.dryRun) {
-            const key = this.metadata.pullRequestURL || this.project.branchName;
+            const key = this.metadata.pullRequestURL || this.project.headCommit;
             await this.notes.set(key, this.metadata, true);
         }
 
@@ -847,7 +847,7 @@ export class PatchSeries {
     }
 
     protected async generateMBox(): Promise<string> {
-        const mergeBase = await git(["merge-base", this.project.baseCommit, this.project.branchName], {
+        const mergeBase = await git(["merge-base", this.project.baseCommit, this.project.headCommit], {
             workDir: this.project.workDir,
         });
         const args = [
@@ -874,15 +874,15 @@ export class PatchSeries {
         }
         if (this.patchCount > 1) {
             if (!this.coverLetter) {
-                throw new Error(`Branch ${this.project.branchName} needs a description`);
+                throw new Error(`Branch ${this.project.headCommit} needs a description`);
             }
             args.push("--cover-letter");
         }
         if (this.options.patience) {
             args.push("--patience");
         }
 
-        args.push(`${this.project.baseCommit}..${this.project.branchName}`);
+        args.push(`${this.project.baseCommit}..${this.project.headCommit}`);
 
         return await git(args, { workDir: this.project.workDir });
     }

lib/project-options.ts

@@ -5,7 +5,7 @@ export class ProjectOptions {
     public static async get(
         config: IConfig,
         workDir: string,
-        branchName: string,
+        headCommit: string,
         cc: string[],
         baseCommit: string,
         basedOn?: string,
@@ -24,10 +24,10 @@ export class ProjectOptions {
             cc.push("Johannes Sixt <j6t@kdbg.org>");
         }
 
-        return new ProjectOptions(branchName, basedOn, to, cc, midUrlPrefix, workDir, baseCommit);
+        return new ProjectOptions(headCommit, basedOn, to, cc, midUrlPrefix, workDir, baseCommit);
     }
 
-    public readonly branchName: string;
+    public readonly headCommit: string;
     public readonly baseCommit: string;
     public readonly basedOn?: string;
     public readonly workDir: string;
@@ -37,15 +37,15 @@ export class ProjectOptions {
     public readonly midUrlPrefix: string;
 
     protected constructor(
-        branchName: string,
+        headCommit: string,
         basedOn: string | undefined,
         to: string,
         cc: string[],
         midUrlPrefix: string,
         workDir: string,
         baseCommit: string,
     ) {
-        this.branchName = branchName;
+        this.headCommit = headCommit;
 
         this.baseCommit = baseCommit;
 

tests/project-options.test.ts

@@ -38,8 +38,8 @@ test("project options", async () => {
             const prMeta = {
                 baseCommit: options2.baseCommit,
                 baseLabel: "upstream/main",
-                headCommit: options2.branchName,
-                headLabel: options2.branchName,
+                headCommit: options2.headCommit,
+                headLabel: options2.headCommit,
                 iteration: 1,
             };
             const x = new X(testConfig, new GitNotes(repo.workDir), {}, options2, prMeta, undefined, 1);