Skip to content

Working Issue Branch is not validated #2040

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Alex Ross (alexr00) merged 2 commits into from
Aug 5, 2020
Merged

Working Issue Branch is not validated #2040

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8dc1d8
Working Issue Branch is not validated
alexr00 Aug 4, 2020
98be77d
Add button to edit setting
alexr00 Aug 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/issues/currentIssue.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,24 @@ export class CurrentIssue {
return vscode.workspace.getConfiguration(ISSUES_CONFIGURATION).get<string>(BRANCH_NAME_CONFIGURATION) ?? this.getBasicBranchName(await this.getUser());
}

private validateBranchName(branch: string): string | undefined {
const VALID_BRANCH_CHARACTERS = /[^ \\@\~\^\?\*\[]+/;
const match = branch.match(VALID_BRANCH_CHARACTERS);
if (match && match.length > 0 && match[0] !== branch) {
return 'Branch name cannot contain a space or the following characters: \\@~^?*[';
}
return undefined;
}

private showBranchNameError(error: string) {
const editSetting = `Edit Setting`;
vscode.window.showErrorMessage(error, editSetting).then(result => {
if (result === editSetting) {
return vscode.commands.executeCommand('workbench.action.openSettings', `${ISSUES_CONFIGURATION}.${BRANCH_NAME_CONFIGURATION}`);
}
});
}

private async createIssueBranch(): Promise<boolean> {
const createBranchConfig = this.shouldPromptForBranch ? 'prompt' : <string>vscode.workspace.getConfiguration(ISSUES_CONFIGURATION).get(BRANCH_CONFIGURATION);
if (createBranchConfig === 'off') {
Expand All @@ -140,6 +158,11 @@ export class CurrentIssue {
if (!this._branchName) {
const branchNameConfig = await variableSubstitution(await this.ensureBranchTitleConfigMigrated(), this.issue, undefined, await this.getUser());
if (createBranchConfig === 'on') {
const validateBranchName = this.validateBranchName(branchNameConfig);
if (validateBranchName) {
this.showBranchNameError(validateBranchName);
return false;
}
this._branchName = branchNameConfig;
} else {
this._branchName = await vscode.window.showInputBox({ value: branchNameConfig, prompt: 'Enter the label for the new branch.' });
Expand Down