fixes microsoft#84274

joaomoreno · joaomoreno · commit fd091abb856f · 2019-11-08T15:55:30.000+01:00
diff --git a/extensions/git/package.json b/extensions/git/package.json
@@ -1608,6 +1608,12 @@
           "default": "mixed",
           "description": "%config.untrackedChanges%",
           "scope": "resource"
+        },
+        "git.restoreCommitTemplateComments": {
+          "type": "boolean",
+          "scope": "resource",
+          "default": true,
+          "description": "%config.restoreCommitTemplateComments%"
         }
       }
     },
diff --git a/extensions/git/package.nls.json b/extensions/git/package.nls.json
@@ -139,6 +139,7 @@
 	"config.untrackedChanges.mixed": "All changes, tracked and untracked, appear together and behave equally.",
 	"config.untrackedChanges.separate": "Untracked changes appear separately in the Source Control view. They are also excluded from several actions.",
 	"config.untrackedChanges.hidden": "Untracked changes are hidden and excluded from several actions.",
+	"config.restoreCommitTemplateComments": "Controls whether to restore commit template comments in the commit input box.",
 	"colors.added": "Color for added resources.",
 	"colors.modified": "Color for modified resources.",
 	"colors.deleted": "Color for deleted resources.",
diff --git a/extensions/git/src/git.ts b/extensions/git/src/git.ts
@@ -1823,7 +1823,6 @@ export class Repository {
 		return message.replace(/^\s*#.*$\n?/gm, '').trim();
 	}
 
-
 	async getMergeMessage(): Promise<string | undefined> {
 		const mergeMsgPath = path.join(this.repositoryRoot, '.git', 'MERGE_MSG');
 
diff --git a/extensions/git/src/repository.ts b/extensions/git/src/repository.ts
@@ -844,7 +844,15 @@ export class Repository implements Disposable {
 			return mergeMessage;
 		}
 
-		return await this.repository.getCommitTemplate();
+		let template = await this.repository.getCommitTemplate();
+
+		const config = workspace.getConfiguration('git', Uri.file(this.root));
+
+		if (!config.get<boolean>('restoreCommitTemplateComments')) {
+			template = this.cleanUpCommitEditMessage(template);
+		}
+
+		return template;
 	}
 
 	getConfigs(): Promise<{ key: string; value: string; }[]> {
@@ -1278,7 +1286,7 @@ export class Repository implements Disposable {
 		return await this.run(Operation.GetCommitTemplate, async () => this.repository.getCommitTemplate());
 	}
 
-	async cleanUpCommitEditMessage(editMessage: string): Promise<string> {
+	cleanUpCommitEditMessage(editMessage: string): string {
 		return this.repository.cleanupCommitEditMessage(editMessage);
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -1608,6 +1608,12 @@`
`1608`	`1608`	`"default": "mixed",`
`1609`	`1609`	`"description": "%config.untrackedChanges%",`
`1610`	`1610`	`"scope": "resource"`
	`1611`	`+ },`
	`1612`	`+ "git.restoreCommitTemplateComments": {`
	`1613`	`+ "type": "boolean",`
	`1614`	`+ "scope": "resource",`
	`1615`	`+ "default": true,`
	`1616`	`+ "description": "%config.restoreCommitTemplateComments%"`
`1611`	`1617`	`}`
`1612`	`1618`	`}`
`1613`	`1619`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1823,7 +1823,6 @@ export class Repository {`
`1823`	`1823`	`return message.replace(/^\s#.$\n?/gm, '').trim();`
`1824`	`1824`	`}`
`1825`	`1825`
`1826`		`-`
`1827`	`1826`	`async getMergeMessage(): Promise<string \| undefined> {`
`1828`	`1827`	`const mergeMsgPath = path.join(this.repositoryRoot, '.git', 'MERGE_MSG');`
`1829`	`1828`
Original file line number	Diff line number	Diff line change
`@@ -844,7 +844,15 @@ export class Repository implements Disposable {`
`844`	`844`	`return mergeMessage;`
`845`	`845`	`}`
`846`	`846`
`847`		`- return await this.repository.getCommitTemplate();`
	`847`	`+ let template = await this.repository.getCommitTemplate();`
	`848`	`+`
	`849`	`+ const config = workspace.getConfiguration('git', Uri.file(this.root));`
	`850`	`+`
	`851`	`+ if (!config.get<boolean>('restoreCommitTemplateComments')) {`
	`852`	`+ template = this.cleanUpCommitEditMessage(template);`
	`853`	`+ }`
	`854`	`+`
	`855`	`+ return template;`
`848`	`856`	`}`
`849`	`857`
`850`	`858`	`getConfigs(): Promise<{ key: string; value: string; }[]> {`
`@@ -1278,7 +1286,7 @@ export class Repository implements Disposable {`
`1278`	`1286`	`return await this.run(Operation.GetCommitTemplate, async () => this.repository.getCommitTemplate());`
`1279`	`1287`	`}`
`1280`	`1288`
`1281`		`- async cleanUpCommitEditMessage(editMessage: string): Promise<string> {`
	`1289`	`+ cleanUpCommitEditMessage(editMessage: string): string {`
`1282`	`1290`	`return this.repository.cleanupCommitEditMessage(editMessage);`
`1283`	`1291`	`}`
`1284`	`1292`