Git - experimental input validation using diagnostics (#204822)

* Initial implementation

* Add setting + code actions

extensions/git/src/diagnostics.ts

@@ -0,0 +1,159 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { CodeAction, CodeActionKind, CodeActionProvider, Diagnostic, DiagnosticCollection, DiagnosticSeverity, Disposable, Range, Selection, TextDocument, Uri, WorkspaceEdit, l10n, languages, workspace } from 'vscode';
+import { mapEvent, filterEvent, dispose } from './util';
+
+export enum DiagnosticCodes {
+	empty_message = 'empty_message',
+	line_length = 'line_length'
+}
+
+export class GitCommitInputBoxDiagnosticsManager {
+
+	private readonly diagnostics: DiagnosticCollection;
+	private readonly severity = DiagnosticSeverity.Warning;
+	private readonly disposables: Disposable[] = [];
+
+	constructor() {
+		this.diagnostics = languages.createDiagnosticCollection();
+		mapEvent(filterEvent(workspace.onDidChangeTextDocument, e => e.document.uri.scheme === 'vscode-scm'), e => e.document)(this.validateTextDocument, this, this.disposables);
+	}
+
+	public getDiagnostics(uri: Uri): ReadonlyArray<Diagnostic> {
+		return this.diagnostics.get(uri) ?? [];
+	}
+
+	private validateTextDocument(document: TextDocument): void {
+		this.diagnostics.delete(document.uri);
+
+		const config = workspace.getConfiguration('git');
+		const inputValidation = config.get<boolean>('experimental.inputValidation', false) === true;
+		if (!inputValidation) {
+			return;
+		}
+
+		const diagnostics: Diagnostic[] = [];
+
+		if (/^\s+$/.test(document.getText())) {
+			const documentRange = new Range(document.lineAt(0).range.start, document.lineAt(document.lineCount - 1).range.end);
+			const diagnostic = new Diagnostic(documentRange, l10n.t('Current commit message only contains whitespace characters'), this.severity);
+			diagnostic.code = DiagnosticCodes.empty_message;
+
+			diagnostics.push(diagnostic);
+			this.diagnostics.set(document.uri, diagnostics);
+
+			return;
+		}
+
+		const inputValidationLength = config.get<number>('inputValidationLength', 50);
+		const inputValidationSubjectLength = config.get<number | undefined>('inputValidationSubjectLength', undefined);
+
+		for (let index = 0; index < document.lineCount; index++) {
+			const line = document.lineAt(index);
+			const threshold = index === 0 ? inputValidationSubjectLength ?? inputValidationLength : inputValidationLength;
+
+			if (line.text.length > threshold) {
+				const diagnostic = new Diagnostic(line.range, l10n.t('{0} characters over {1} in current line', line.text.length - threshold, threshold), this.severity);
+				diagnostic.code = DiagnosticCodes.line_length;
+
+				diagnostics.push(diagnostic);
+			}
+		}
+
+		this.diagnostics.set(document.uri, diagnostics);
+	}
+
+	dispose() {
+		dispose(this.disposables);
+	}
+}
+
+export class GitCommitInputBoxCodeActionsProvider implements CodeActionProvider {
+
+	private readonly disposables: Disposable[] = [];
+
+	constructor(private readonly diagnosticsManager: GitCommitInputBoxDiagnosticsManager) {
+		this.disposables.push(languages.registerCodeActionsProvider({ scheme: 'vscode-scm' }, this));
+	}
+
+	provideCodeActions(document: TextDocument, range: Range | Selection): CodeAction[] {
+		const codeActions: CodeAction[] = [];
+		const diagnostics = this.diagnosticsManager.getDiagnostics(document.uri);
+
+		for (const diagnostic of diagnostics) {
+			if (!diagnostic.range.contains(range)) {
+				continue;
+			}
+
+			switch (diagnostic.code) {
+				case DiagnosticCodes.empty_message: {
+					const workspaceEdit = new WorkspaceEdit();
+					workspaceEdit.delete(document.uri, diagnostic.range);
+
+					const codeAction = new CodeAction(l10n.t('Remove empty characters'), CodeActionKind.QuickFix);
+					codeAction.diagnostics = [diagnostic];
+					codeAction.edit = workspaceEdit;
+
+					codeActions.push(codeAction);
+					break;
+				}
+				case DiagnosticCodes.line_length: {
+					const workspaceEdit = this.getWrapLineWorkspaceEdit(document, diagnostic.range);
+					const codeAction = new CodeAction(l10n.t('Hard wrap line'), CodeActionKind.QuickFix);
+					codeAction.diagnostics = [diagnostic];
+					codeAction.edit = workspaceEdit;
+
+					codeActions.push(codeAction);
+					break;
+				}
+			}
+		}
+
+		return codeActions;
+	}
+
+	private getWrapLineWorkspaceEdit(document: TextDocument, range: Range): WorkspaceEdit {
+		const config = workspace.getConfiguration('git');
+		const inputValidationLength = config.get<number>('inputValidationLength', 50);
+		const inputValidationSubjectLength = config.get<number | undefined>('inputValidationSubjectLength', undefined);
+		const lineLengthThreshold = range.start.line === 0 ? inputValidationSubjectLength ?? inputValidationLength : inputValidationLength;
+
+		const lineSegments: string[] = [];
+		const lineText = document.lineAt(range.start.line).text;
+
+		let position = 0;
+		while (lineText.length - position > lineLengthThreshold) {
+			const lastSpaceBeforeThreshold = lineText.lastIndexOf(' ', position + lineLengthThreshold);
+
+			if (lastSpaceBeforeThreshold !== -1 && lastSpaceBeforeThreshold > position) {
+				lineSegments.push(lineText.substring(position, lastSpaceBeforeThreshold));
+				position = lastSpaceBeforeThreshold + 1;
+			} else {
+				// Find first space after threshold
+				const firstSpaceAfterThreshold = lineText.indexOf(' ', position + lineLengthThreshold);
+				if (firstSpaceAfterThreshold !== -1) {
+					lineSegments.push(lineText.substring(position, firstSpaceAfterThreshold));
+					position = firstSpaceAfterThreshold + 1;
+				} else {
+					lineSegments.push(lineText.substring(position));
+					position = lineText.length;
+				}
+			}
+		}
+		if (position < lineText.length) {
+			lineSegments.push(lineText.substring(position));
+		}
+
+		const workspaceEdit = new WorkspaceEdit();
+		workspaceEdit.replace(document.uri, range, lineSegments.join('\n'));
+
+		return workspaceEdit;
+	}
+
+	dispose() {
+		dispose(this.disposables);
+	}
+}

extensions/git/src/main.ts

@@ -25,6 +25,7 @@ import { createIPCServer, IPCServer } from './ipc/ipcServer';
 import { GitEditor } from './gitEditor';
 import { GitPostCommitCommandsProvider } from './postCommitCommands';
 import { GitEditSessionIdentityProvider } from './editSessionIdentityProvider';
+import { GitCommitInputBoxCodeActionsProvider, GitCommitInputBoxDiagnosticsManager } from './diagnostics';
 
 const deactivateTasks: { (): Promise<any> }[] = [];
 
@@ -118,6 +119,12 @@ async function createModel(context: ExtensionContext, logger: LogOutputChannel,
 	const postCommitCommandsProvider = new GitPostCommitCommandsProvider();
 	model.registerPostCommitCommandsProvider(postCommitCommandsProvider);
 
+	const diagnosticsManager = new GitCommitInputBoxDiagnosticsManager();
+	disposables.push(diagnosticsManager);
+
+	const codeActionsProvider = new GitCommitInputBoxCodeActionsProvider(diagnosticsManager);
+	disposables.push(codeActionsProvider);
+
 	checkGitVersion(info);
 	commands.executeCommand('setContext', 'gitVersion2.35', git.compareGitVersionTo('2.35') >= 0);