Centralize all configuration strings into settingKeys.ts

Makes it eaiser to keep track of how/where configuration is being used.

src/commands.ts

@@ -11,6 +11,7 @@ import { GitErrorCodes } from './api/api1';
 import { CommentReply, resolveCommentHandler } from './commentHandlerResolver';
 import { IComment } from './common/comment';
 import Logger from './common/logger';
+import { FILE_LIST_LAYOUT, PR_SETTINGS_NAMESPACE } from './common/settingKeys';
 import { ITelemetry } from './common/telemetry';
 import { asImageDataURI, fromReviewUri, Schemes } from './common/uri';
 import { formatError } from './common/utils';
@@ -1028,13 +1029,13 @@ ${contents}
 
 	context.subscriptions.push(
 		vscode.commands.registerCommand('pr.setFileListLayoutAsTree', _ => {
-			vscode.workspace.getConfiguration('githubPullRequests').update('fileListLayout', 'tree', true);
+			vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).update(FILE_LIST_LAYOUT, 'tree', true);
 		}),
 	);
 
 	context.subscriptions.push(
 		vscode.commands.registerCommand('pr.setFileListLayoutAsFlat', _ => {
-			vscode.workspace.getConfiguration('githubPullRequests').update('fileListLayout', 'flat', true);
+			vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).update(FILE_LIST_LAYOUT, 'flat', true);
 		}),
 	);
 

src/common/settingKeys.ts

@@ -23,7 +23,45 @@ export const QUICK_DIFF_EXP = 'experimental.quickDiff';
 export const QUICK_DIFF = 'quickDiff';
 export const SET_AUTO_MERGE = 'setAutoMerge';
 export const SHOW_PULL_REQUEST_NUMBER_IN_TREE = 'showPullRequestNumberInTree';
+export const DEFAULT_MERGE_METHOD = 'defaultMergeMethod';
+export const DEFAULT_DELETION_METHOD = 'defaultDeletionMethod';
+export const SELECT_LOCAL_BRANCH = 'selectLocalBranch';
+export const SELECT_REMOTE = 'selectRemote';
+export const REMOTES = 'remotes';
+
+export const ISSUES_SETTINGS_NAMESPACE = 'githubIssues';
+export const ASSIGN_WHEN_WORKING = 'assignWhenWorking';
+export const ISSUE_COMPLETIONS = 'issueCompletions';
+export const USER_COMPLETIONS = 'userCompletions';
+export const ENABLED = 'enabled';
+export const IGNORE_USER_COMPLETION_TRIGGER = 'ignoreUserCompletionTrigger';
+export const CREATE_INSERT_FORMAT = 'createInsertFormat';
+export const ISSUE_BRANCH_TITLE = 'issueBranchTitle';
+export const USE_BRANCH_FOR_ISSUES = 'useBranchForIssues';
+export const WORKING_ISSUE_FORMAT_SCM = 'workingIssueFormatScm';
+export const IGNORE_COMPLETION_TRIGGER = 'ignoreCompletionTrigger';
+export const ISSUE_COMPLETION_FORMAT_SCM = 'issueCompletionFormatScm';
+export const CREATE_ISSUE_TRIGGERS = 'createIssueTriggers';
+export const DEFAULT = 'default';
+export const IGNORE_MILESTONES = 'ignoreMilestones';
 
 // git
 export const GIT = 'git';
 export const OPEN_DIFF_ON_CLICK = 'openDiffOnClick';
+export const AUTO_STASH = 'autoStash';
+
+// GitHub Enterprise
+export const GITHUB_ENTERPRISE = 'github-enterprise';
+export const URI = 'uri';
+
+// Editor
+export const EDITOR = 'editor';
+export const WORD_WRAP = 'wordWrap';
+
+// Comments
+export const COMMENTS = 'comments';
+export const OPEN_VIEW = 'openView';
+
+// Explorer
+export const EXPLORER = 'explorer';
+export const AUTO_REVEAL = 'autoReveal';

src/extension.ts

@@ -21,7 +21,7 @@ import { Schemes, handler as uriHandler } from './common/uri';
 import { EXTENSION_ID, FOCUS_REVIEW_MODE } from './constants';
 import { createExperimentationService, ExperimentationTelemetry } from './experimentationService';
 import { CredentialStore } from './github/credentials';
-import { FolderRepositoryManager, SETTINGS_NAMESPACE } from './github/folderRepositoryManager';
+import { FolderRepositoryManager } from './github/folderRepositoryManager';
 import { RepositoriesManager } from './github/repositoriesManager';
 import { registerBuiltinGitProvider, registerLiveShareGitProvider } from './gitProviders/api';
 import { GitHubContactServiceProvider } from './gitProviders/GitHubContactServiceProvider';
@@ -201,7 +201,7 @@ async function init(
 
 	registerCommands(context, reposManager, reviewManagers, telemetry, tree);
 
-	const layout = vscode.workspace.getConfiguration(SETTINGS_NAMESPACE).get<string>(FILE_LIST_LAYOUT);
+	const layout = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<string>(FILE_LIST_LAYOUT);
 	await vscode.commands.executeCommand('setContext', 'fileListLayout:flat', layout === 'flat');
 
 	const issuesFeatures = new IssueFeatureRegistrar(git, reposManager, reviewManagers, context, telemetry);

src/github/createPRViewProvider.ts

@@ -11,14 +11,20 @@ import { commands, contexts } from '../common/executeCommands';
 import Logger from '../common/logger';
 import { Protocol } from '../common/protocol';
 import { GitHubRemote } from '../common/remote';
-import { ASSIGN_TO, CREATE_DRAFT, PULL_REQUEST_DESCRIPTION, PUSH_BRANCH, SET_AUTO_MERGE } from '../common/settingKeys';
+import {
+	ASSIGN_TO,
+	CREATE_DRAFT,
+	PR_SETTINGS_NAMESPACE,
+	PULL_REQUEST_DESCRIPTION,
+	PUSH_BRANCH,
+	SET_AUTO_MERGE,
+} from '../common/settingKeys';
 import { getNonce, IRequestMessage, WebviewViewBase } from '../common/webview';
 import {
 	byRemoteName,
 	DetachedHeadError,
 	FolderRepositoryManager,
 	PullRequestDefaults,
-	SETTINGS_NAMESPACE,
 	titleAndBodyFrom,
 } from './folderRepositoryManager';
 import { GitHubRepository } from './githubRepository';
@@ -135,7 +141,9 @@ export class CreatePullRequestViewProvider extends WebviewViewBase implements vs
 		// By default, the base branch we use for comparison is the base branch of origin. Compare this to the
 		// compare branch if it has a GitHub remote.
 		const origin = await this._folderRepositoryManager.getOrigin(compareBranch);
-		const useTemplate = vscode.workspace.getConfiguration(SETTINGS_NAMESPACE).get<string>(PULL_REQUEST_DESCRIPTION) === 'template';
+		const useTemplate =
+			vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<string>(PULL_REQUEST_DESCRIPTION) ===
+			'template';
 
 		let useBranchName = this._pullRequestDefaults.base === compareBranch.name;
 		Logger.debug(`Compare branch name: ${compareBranch.name}, Base branch name: ${this._pullRequestDefaults.base}`, 'CreatePullRequestViewProvider');
@@ -325,10 +333,10 @@ export class CreatePullRequestViewProvider extends WebviewViewBase implements vs
 			defaultMergeMethod: getDefaultMergeMethod(mergeConfiguration.mergeMethodsAvailability),
 			allowAutoMerge: mergeConfiguration.viewerCanAutoMerge,
 			mergeMethodsAvailability: mergeConfiguration.mergeMethodsAvailability,
-			autoMergeDefault: mergeConfiguration.viewerCanAutoMerge && (vscode.workspace.getConfiguration(SETTINGS_NAMESPACE).get<boolean>(SET_AUTO_MERGE, false) === true),
+			autoMergeDefault: mergeConfiguration.viewerCanAutoMerge && (vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<boolean>(SET_AUTO_MERGE, false) === true),
 			createError: '',
 			labels: this.labels,
-			isDraftDefault: vscode.workspace.getConfiguration(SETTINGS_NAMESPACE).get(CREATE_DRAFT, false),
+			isDraftDefault: vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get(CREATE_DRAFT, false),
 			isDarkTheme: vscode.window.activeColorTheme.kind === vscode.ColorThemeKind.Dark
 		};
 
@@ -391,7 +399,7 @@ export class CreatePullRequestViewProvider extends WebviewViewBase implements vs
 	}
 
 	private async autoAssign(pr: PullRequestModel): Promise<void> {
-		const configuration = vscode.workspace.getConfiguration(SETTINGS_NAMESPACE).get<string | undefined>(ASSIGN_TO);
+		const configuration = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<string | undefined>(ASSIGN_TO);
 		if (!configuration) {
 			return;
 		}
@@ -497,15 +505,18 @@ export class CreatePullRequestViewProvider extends WebviewViewBase implements vs
 						// We assume this happens only when the compare branch is based on the current branch.
 						const alwaysPublish = vscode.l10n.t('Always Publish Branch');
 						const publish = vscode.l10n.t('Publish Branch');
-						const pushBranchSetting = vscode.workspace.getConfiguration(SETTINGS_NAMESPACE).get(PUSH_BRANCH) === 'always';
+						const pushBranchSetting =
+							vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get(PUSH_BRANCH) === 'always';
 						const messageResult = !pushBranchSetting ? await vscode.window.showInformationMessage(
 							vscode.l10n.t('There is no upstream branch for \'{0}\'.\n\nDo you want to publish it and then create the pull request?', compareBranchName),
 							{ modal: true },
 							publish,
 							alwaysPublish)
 							: publish;
 						if (messageResult === alwaysPublish) {
-							await vscode.workspace.getConfiguration(SETTINGS_NAMESPACE).update(PUSH_BRANCH, 'always', vscode.ConfigurationTarget.Global);
+							await vscode.workspace
+								.getConfiguration(PR_SETTINGS_NAMESPACE)
+								.update(PUSH_BRANCH, 'always', vscode.ConfigurationTarget.Global);
 						}
 						if ((messageResult === alwaysPublish) || (messageResult === publish)) {
 							progress.report({ message: vscode.l10n.t('Pushing branch'), increment: 10 });

src/github/folderRepositoryManager.ts

@@ -13,7 +13,14 @@ import { commands, contexts } from '../common/executeCommands';
 import Logger from '../common/logger';
 import { Protocol, ProtocolType } from '../common/protocol';
 import { GitHubRemote, parseRepositoryRemotes, Remote } from '../common/remote';
-import { PULL_BRANCH } from '../common/settingKeys';
+import {
+	AUTO_STASH,
+	DEFAULT_MERGE_METHOD,
+	GIT,
+	PR_SETTINGS_NAMESPACE,
+	PULL_BRANCH,
+	REMOTES,
+} from '../common/settingKeys';
 import { ITelemetry } from '../common/telemetry';
 import { EventType, TimelineEvent } from '../common/timelineEvent';
 import { fromPRUri, Schemes } from '../common/uri';
@@ -88,9 +95,6 @@ export class BadUpstreamError extends Error {
 	}
 }
 
-export const SETTINGS_NAMESPACE = 'githubPullRequests';
-export const REMOTES_SETTING = 'remotes';
-
 export const ReposManagerStateContext: string = 'ReposManagerStateContext';
 
 export enum ReposManagerState {
@@ -163,7 +167,7 @@ export class FolderRepositoryManager implements vscode.Disposable {
 
 		this._subs.push(
 			vscode.workspace.onDidChangeConfiguration(async e => {
-				if (e.affectsConfiguration(`${SETTINGS_NAMESPACE}.${REMOTES_SETTING}`)) {
+				if (e.affectsConfiguration(`${PR_SETTINGS_NAMESPACE}.${REMOTES}`)) {
 					await this.updateRepositories();
 				}
 			}),
@@ -241,7 +245,7 @@ export class FolderRepositoryManager implements vscode.Disposable {
 	}
 
 	public async getActiveGitHubRemotes(allGitHubRemotes: GitHubRemote[]): Promise<GitHubRemote[]> {
-		const remotesSetting = vscode.workspace.getConfiguration(SETTINGS_NAMESPACE).get<string[]>(REMOTES_SETTING);
+		const remotesSetting = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<string[]>(REMOTES);
 
 		if (!remotesSetting) {
 			Logger.error(`Unable to read remotes setting`);
@@ -1258,8 +1262,10 @@ export class FolderRepositoryManager implements vscode.Disposable {
 
 		const origin = await this.getOrigin(branch);
 		const meta = await origin.getMetadata();
-		const remotesSettingDefault = vscode.workspace.getConfiguration(SETTINGS_NAMESPACE).inspect<string[]>(REMOTES_SETTING)?.defaultValue;
-		const remotesSettingSetValue = vscode.workspace.getConfiguration(SETTINGS_NAMESPACE).get<string[]>(REMOTES_SETTING);
+		const remotesSettingDefault = vscode.workspace
+			.getConfiguration(PR_SETTINGS_NAMESPACE)
+			.inspect<string[]>(REMOTES)?.defaultValue;
+		const remotesSettingSetValue = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<string[]>(REMOTES);
 		const settingsEqual = (!remotesSettingSetValue || remotesSettingDefault?.every((value, index) => remotesSettingSetValue[index] === value));
 		const parent = (meta.fork && meta.parent && settingsEqual)
 			? meta.parent
@@ -1559,8 +1565,8 @@ export class FolderRepositoryManager implements vscode.Disposable {
 			merge_method:
 				method ||
 				vscode.workspace
-					.getConfiguration('githubPullRequests')
-					.get<'merge' | 'squash' | 'rebase'>('defaultMergeMethod'),
+					.getConfiguration(PR_SETTINGS_NAMESPACE)
+					.get<'merge' | 'squash' | 'rebase'>(DEFAULT_MERGE_METHOD),
 			owner: remote.owner,
 			repo: remote.repositoryName,
 			pull_number: pullRequest.number,
@@ -2096,9 +2102,13 @@ export class FolderRepositoryManager implements vscode.Disposable {
 		const neverShowPullNotification = this.context.globalState.get<boolean>(NEVER_SHOW_PULL_NOTIFICATION, false);
 		if (neverShowPullNotification) {
 			this.context.globalState.update(NEVER_SHOW_PULL_NOTIFICATION, false);
-			await vscode.workspace.getConfiguration(SETTINGS_NAMESPACE).update(PULL_BRANCH, 'never', vscode.ConfigurationTarget.Global);
+			await vscode.workspace
+				.getConfiguration(PR_SETTINGS_NAMESPACE)
+				.update(PULL_BRANCH, 'never', vscode.ConfigurationTarget.Global);
 		}
-		return vscode.workspace.getConfiguration(SETTINGS_NAMESPACE).get<'never' | 'prompt' | 'always'>(PULL_BRANCH, 'prompt');
+		return vscode.workspace
+			.getConfiguration(PR_SETTINGS_NAMESPACE)
+			.get<'never' | 'prompt' | 'always'>(PULL_BRANCH, 'prompt');
 	}
 
 	private async pullBranch(branch: Branch) {
@@ -2127,9 +2137,13 @@ export class FolderRepositoryManager implements vscode.Disposable {
 				await this.pullBranch(branch);
 				this._updateMessageShown = false;
 			} else if (never) {
-				await vscode.workspace.getConfiguration(SETTINGS_NAMESPACE).update(PULL_BRANCH, 'never', vscode.ConfigurationTarget.Global);
+				await vscode.workspace
+					.getConfiguration(PR_SETTINGS_NAMESPACE)
+					.update(PULL_BRANCH, 'never', vscode.ConfigurationTarget.Global);
 			} else if (always) {
-				await vscode.workspace.getConfiguration(SETTINGS_NAMESPACE).update(PULL_BRANCH, 'always', vscode.ConfigurationTarget.Global);
+				await vscode.workspace
+					.getConfiguration(PR_SETTINGS_NAMESPACE)
+					.update(PULL_BRANCH, 'always', vscode.ConfigurationTarget.Global);
 				await this.pullBranch(branch);
 			}
 		}
@@ -2163,7 +2177,7 @@ export class FolderRepositoryManager implements vscode.Disposable {
 				if (branch.behind !== undefined && branch.behind > 0) {
 					switch (pullBranchConfiguration) {
 						case 'always': {
-							const autoStash = vscode.workspace.getConfiguration('git').get<boolean>('autoStash', false);
+							const autoStash = vscode.workspace.getConfiguration(GIT).get<boolean>(AUTO_STASH, false);
 							if (autoStash) {
 								return this.promptPullBrach(pr, branch, autoStash);
 							} else {

src/github/notifications.ts

@@ -7,14 +7,13 @@ import { OctokitResponse } from '@octokit/types';
 import * as vscode from 'vscode';
 import { AuthProvider } from '../common/authentication';
 import Logger from '../common/logger';
-import { NOTIFICATION_SETTING } from '../common/settingKeys';
+import { NOTIFICATION_SETTING, PR_SETTINGS_NAMESPACE } from '../common/settingKeys';
 import { createPRNodeUri } from '../common/uri';
 import { PullRequestsTreeDataProvider } from '../view/prsTreeDataProvider';
 import { CategoryTreeNode } from '../view/treeNodes/categoryNode';
 import { PRNode } from '../view/treeNodes/pullRequestNode';
 import { TreeNode } from '../view/treeNodes/treeNode';
 import { CredentialStore, GitHub } from './credentials';
-import { SETTINGS_NAMESPACE } from './folderRepositoryManager';
 import { GitHubRepository } from './githubRepository';
 import { PullRequestState } from './graphql';
 import { PullRequestModel } from './pullRequestModel';
@@ -99,15 +98,18 @@ export class NotificationProvider implements vscode.Disposable {
 
 		this.disposables.push(
 			vscode.workspace.onDidChangeConfiguration((e) => {
-				if (e.affectsConfiguration(`${SETTINGS_NAMESPACE}.${NOTIFICATION_SETTING}`)) {
+				if (e.affectsConfiguration(`${PR_SETTINGS_NAMESPACE}.${NOTIFICATION_SETTING}`)) {
 					this.checkNotificationSetting();
 				}
 			})
 		);
 	}
 
 	private static isPRNotificationsOn() {
-		return vscode.workspace.getConfiguration(SETTINGS_NAMESPACE).get<string>(NOTIFICATION_SETTING) === 'pullRequests';
+		return (
+			vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<string>(NOTIFICATION_SETTING) ===
+			'pullRequests'
+		);
 	}
 
 	private registerAuthProvider(credentialStore: CredentialStore) {

src/github/pullRequestOverview.ts

@@ -8,6 +8,7 @@ import * as vscode from 'vscode';
 import { onDidUpdatePR, openPullRequestOnGitHub } from '../commands';
 import { IComment } from '../common/comment';
 import Logger from '../common/logger';
+import { DEFAULT_MERGE_METHOD, PR_SETTINGS_NAMESPACE } from '../common/settingKeys';
 import { ReviewEvent as CommonReviewEvent } from '../common/timelineEvent';
 import { asPromise, dispose, formatError } from '../common/utils';
 import { IRequestMessage, PULL_REQUEST_OVERVIEW_VIEW_TYPE } from '../common/webview';
@@ -940,7 +941,9 @@ export class PullRequestOverviewPanel extends IssueOverviewPanel<PullRequestMode
 export function getDefaultMergeMethod(
 	methodsAvailability: MergeMethodsAvailability,
 ): MergeMethod {
-	const userPreferred = vscode.workspace.getConfiguration('githubPullRequests').get<MergeMethod>('defaultMergeMethod');
+	const userPreferred = vscode.workspace
+		.getConfiguration(PR_SETTINGS_NAMESPACE)
+		.get<MergeMethod>(DEFAULT_MERGE_METHOD);
 	// Use default merge method specified by user if it is available
 	if (userPreferred && methodsAvailability.hasOwnProperty(userPreferred) && methodsAvailability[userPreferred]) {
 		return userPreferred;

src/github/pullRequestOverviewCommon.ts

@@ -5,6 +5,12 @@
 'use strict';
 
 import * as vscode from 'vscode';
+import {
+	DEFAULT_DELETION_METHOD,
+	PR_SETTINGS_NAMESPACE,
+	SELECT_LOCAL_BRANCH,
+	SELECT_REMOTE,
+} from '../common/settingKeys';
 import { Schemes } from '../common/uri';
 import { FolderRepositoryManager } from './folderRepositoryManager';
 import { PullRequestModel } from './pullRequestModel';
@@ -31,17 +37,17 @@ export namespace PullRequestView {
 
 		if (branchInfo) {
 			const preferredLocalBranchDeletionMethod = vscode.workspace
-				.getConfiguration('githubPullRequests')
-				.get<boolean>('defaultDeletionMethod.selectLocalBranch');
+				.getConfiguration(PR_SETTINGS_NAMESPACE)
+				.get<boolean>(`${DEFAULT_DELETION_METHOD}.${SELECT_LOCAL_BRANCH}`);
 			actions.push({
 				label: vscode.l10n.t('Delete local branch {0}', branchInfo.branch),
 				type: 'local',
 				picked: !!preferredLocalBranchDeletionMethod,
 			});
 
 			const preferredRemoteDeletionMethod = vscode.workspace
-				.getConfiguration('githubPullRequests')
-				.get<boolean>('defaultDeletionMethod.selectRemote');
+				.getConfiguration(PR_SETTINGS_NAMESPACE)
+				.get<boolean>(`${DEFAULT_DELETION_METHOD}.${SELECT_REMOTE}`);
 
 			if (branchInfo.remote && branchInfo.createdForPullRequest && !branchInfo.remoteInUse) {
 				actions.push({