Git - add settings to control the branch protection indicator (microsoft#152469)

* Add settings to control the branch protection indicator

* Pull request feedback

Author: lszomoru

extensions/git/package.json

@@ -1893,6 +1893,25 @@
           "default": [],
           "scope": "resource"
         },
+        "git.branchProtectionIndicator": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "%config.branchProtectionIndicator%",
+          "properties": {
+            "quickOpen": {
+              "type": "boolean",
+              "description": "%config.branchProtectionIndicator.quickOpen%"
+            },
+            "statusBar": {
+              "type": "boolean",
+              "description": "%config.branchProtectionIndicator.statusBar%"
+            }
+          },
+          "default": {
+            "quickOpen": true,
+            "statusBar": true
+          }
+        },
         "git.branchProtectionPrompt": {
           "type": "string",
           "description": "%config.branchProtectionPrompt%",

extensions/git/package.nls.json

@@ -122,6 +122,9 @@
 	"config.checkoutType.remote": "Remote branches",
 	"config.branchPrefix": "Prefix used when creating a new branch.",
 	"config.branchProtection": "List of protected branches. By default, a prompt is shown before changes are committed to a protected branch. The prompt can be controlled using the `#git.branchProtectionPrompt#`  setting.",
+	"config.branchProtectionIndicator": "Controls whether an indicator is being displayed for a protected branch.",
+	"config.branchProtectionIndicator.quickOpen": "Display an indicator in the quick open.",
+	"config.branchProtectionIndicator.statusBar": "Display an indicator in the status bar.",
 	"config.branchProtectionPrompt": "Controls whether a prompt is being before changes are committed to a protected branch.",
 	"config.branchProtectionPrompt.alwaysCommit": "Always commit changes to the protected branch.",
 	"config.branchProtectionPrompt.alwaysCommitToNewBranch": "Always commit changes to a new branch.",

extensions/git/src/commands.ts

@@ -26,7 +26,7 @@ const localize = nls.loadMessageBundle();
 class CheckoutItem implements QuickPickItem {
 
 	protected get shortCommit(): string { return (this.ref.commit || '').substr(0, 8); }
-	get label(): string { return this.ref.name ? `${this.ref.name}${this.repository.isBranchProtected(this.ref.name) ? ' $(lock-small)' : ''}` : this.shortCommit; }
+	get label(): string { return this.ref.name ? `${this.ref.name}${this.repository.isBranchProtected(this.ref.name, 'quickOpen') ? ' $(lock-small)' : ''}` : this.shortCommit; }
 	get description(): string { return this.shortCommit; }
 
 	constructor(protected repository: Repository, protected ref: Ref) { }

extensions/git/src/repository.ts

@@ -941,7 +941,9 @@ export class Repository implements Disposable {
 		}, undefined, this.disposables);
 
 		filterEvent(workspace.onDidChangeConfiguration, e =>
-			e.affectsConfiguration('git.branchSortOrder', root)
+			e.affectsConfiguration('git.branchProtection', root)
+			|| e.affectsConfiguration('git.branchProtectionIndicator', root)
+			|| e.affectsConfiguration('git.branchSortOrder', root)
 			|| e.affectsConfiguration('git.untrackedChanges', root)
 			|| e.affectsConfiguration('git.ignoreSubmodules', root)
 			|| e.affectsConfiguration('git.openDiffOnClick', root)
@@ -2228,7 +2230,17 @@ export class Repository implements Disposable {
 		}
 	}
 
-	public isBranchProtected(name: string = this.HEAD?.name ?? ''): boolean {
+	public isBranchProtected(name: string = this.HEAD?.name ?? '', indicator?: 'quickOpen' | 'statusBar'): boolean {
+		if (indicator) {
+			const scopedConfig = workspace.getConfiguration('git', Uri.file(this.repository.root));
+			const branchProtectionIndicator = scopedConfig.get<{ quickOpen: boolean; statusBar: boolean }>('branchProtectionIndicator', { quickOpen: true, statusBar: true });
+
+			if ((indicator === 'quickOpen' && !branchProtectionIndicator.quickOpen) ||
+				(indicator === 'statusBar' && !branchProtectionIndicator.statusBar)) {
+				return false;
+			}
+		}
+
 		return this.isBranchProtectedMatcher ? this.isBranchProtectedMatcher(name) : false;
 	}
 

extensions/git/src/statusbar.ts

@@ -24,8 +24,8 @@ class CheckoutStatusBar {
 
 	get command(): Command | undefined {
 		const rebasing = !!this.repository.rebaseCommit;
-		const isBranchProtected = this.repository.isBranchProtected();
-		const title = `$(git-branch) ${this.repository.headLabel}${rebasing ? ` (${localize('rebasing', 'Rebasing')})` : ''}${isBranchProtected ? ' $(lock-small)' : ''}`;
+		const isBranchProtected = this.repository.isBranchProtected(undefined, 'statusBar');
+		const title = `${isBranchProtected ? '$(lock)' : '$(git-branch)'} ${this.repository.headLabel}${rebasing ? ` (${localize('rebasing', 'Rebasing')})` : ''}`;
 
 		return {
 			command: 'git.checkout',