PatchSeries: do not allow the config to be passed implicitly

Implicit configuration is a recipe for confusion when trying to allow
for overriding said configuration. Let's require the config to be passed
down explicitly.

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

Author: dscho

lib/gitgitgadget.ts

@@ -302,6 +302,7 @@ export class GitGitGadget {
         options.rfc = pr.draft ?? false;
 
         const series = await PatchSeries.getFromNotes(
+            this.config,
             this.notes,
             pr.pullRequestURL,
             pr.title,

lib/patch-series.ts

@@ -8,7 +8,7 @@ import { IMailMetadata } from "./mail-metadata.js";
 import { md2text } from "./markdown-renderer.js";
 import { IPatchSeriesMetadata } from "./patch-series-metadata.js";
 import { PatchSeriesOptions } from "./patch-series-options.js";
-import { IConfig, getConfig } from "./project-config.js";
+import { IConfig } from "./project-config.js";
 import { ProjectOptions } from "./project-options.js";
 import { getPullRequestKeyFromURL } from "./pullRequestKey.js";
 
@@ -57,6 +57,7 @@ interface IRangeDiff {
 
 export class PatchSeries {
     public static async getFromNotes(
+        config: IConfig,
         notes: GitNotes,
         pullRequestURL: string,
         pullRequestTitle: string,
@@ -144,7 +145,17 @@ export class PatchSeries {
             options.rangeDiff = rangeDiff;
         }
 
-        return new PatchSeries(notes, options, project, metadata, rangeDiffRanges, patchCount, coverLetter, senderName);
+        return new PatchSeries(
+            config,
+            notes,
+            options,
+            project,
+            metadata,
+            rangeDiffRanges,
+            patchCount,
+            coverLetter,
+            senderName,
+        );
     }
 
     protected static async parsePullRequest(
@@ -513,7 +524,7 @@ export class PatchSeries {
         return results;
     }
 
-    public readonly config: IConfig = getConfig();
+    public readonly config: IConfig;
     public readonly notes: GitNotes;
     public readonly options: PatchSeriesOptions;
     public readonly project: ProjectOptions;
@@ -524,6 +535,7 @@ export class PatchSeries {
     public readonly patchCount: number;
 
     protected constructor(
+        config: IConfig,
         notes: GitNotes,
         options: PatchSeriesOptions,
         project: ProjectOptions,
@@ -533,6 +545,7 @@ export class PatchSeries {
         coverLetter?: string,
         senderName?: string,
     ) {
+        this.config = config;
         this.notes = notes;
         this.options = options;
         this.project = project;

tests/gitgitgadget.test.ts

@@ -210,6 +210,7 @@ test("generate tag/notes from a Pull Request", async () => {
     await git(["config", "user.email", "gitgitgadget@example.com"], repo.options);
 
     const patches = await PatchSeries.getFromNotes(
+        defaultConfig,
         notes,
         pullRequestURL,
         pullRequestTitle,
@@ -252,6 +253,7 @@ to have included in git.git [https://github.com/git/git].`);
 
     const headCommit2 = await repo.revParse("HEAD");
     const patches2 = await PatchSeries.getFromNotes(
+        defaultConfig,
         notes,
         pullRequestURL,
         pullRequestTitle,

tests/patch-series.test.ts

@@ -6,6 +6,7 @@ import { GitNotes } from "../lib/git-notes.js";
 import { PatchSeries } from "../lib/patch-series.js";
 import { ProjectOptions } from "../lib/project-options.js";
 import { testCreateRepo } from "./test-lib.js";
+import defaultConfig from "../lib/gitgitgadget-config.js";
 
 jest.setTimeout(60000);
 const sourceFileName = fileURLToPath(import.meta.url);
@@ -102,7 +103,15 @@ class PatchSeriesTest extends PatchSeries {
             }
         }
 
-        const x = new PatchSeriesTest(new GitNotes(), {}, new ProjectOptionsTest(), prMeta, undefined, 1);
+        const x = new PatchSeriesTest(
+            defaultConfig,
+            new GitNotes(),
+            {},
+            new ProjectOptionsTest(),
+            prMeta,
+            undefined,
+            1,
+        );
 
         x.insertCcAndFromLines(mails, thisAuthor, senderName);
 

tests/project-options.test.ts

@@ -6,6 +6,7 @@ import { getConfig } from "../lib/gitgitgadget-config.js";
 import { PatchSeries } from "../lib/patch-series.js";
 import { ProjectOptions } from "../lib/project-options.js";
 import { testCreateRepo } from "./test-lib.js";
+import defaultConfig from "../lib/gitgitgadget-config.js";
 
 // This test script might take quite a while to run
 jest.setTimeout(20000);
@@ -45,7 +46,7 @@ test("project options", async () => {
                 headLabel: options2.branchName,
                 iteration: 1,
             };
-            const x = new X(new GitNotes(repo.workDir), {}, options2, prMeta, undefined, 1);
+            const x = new X(defaultConfig, new GitNotes(repo.workDir), {}, options2, prMeta, undefined, 1);
             const mbox = await x.generateMBox();
             const needle = "=?UTF-8?Q?Nguy=E1=BB=85n_Th=C3=A1i_Ng=E1=BB=8Dc?= Duy";
             expect(mbox).toEqual(expect.stringContaining(needle));