You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
105 lines
5.4 KiB
105 lines
5.4 KiB
'use strict';
|
|
import { commands, ConfigurationTarget, Uri, window } from 'vscode';
|
|
import { BuiltInCommands } from './constants';
|
|
import { GitCommit } from './gitService';
|
|
import { Logger } from './logger';
|
|
import { configuration } from './configuration';
|
|
|
|
export enum SuppressedMessages {
|
|
CommitHasNoPreviousCommitWarning = 'suppressCommitHasNoPreviousCommitWarning',
|
|
CommitNotFoundWarning = 'suppressCommitNotFoundWarning',
|
|
FileNotUnderSourceControlWarning = 'suppressFileNotUnderSourceControlWarning',
|
|
GitVersionWarning = 'suppressGitVersionWarning',
|
|
LineUncommittedWarning = 'suppressLineUncommittedWarning',
|
|
NoRepositoryWarning = 'suppressNoRepositoryWarning',
|
|
UpdateNotice = 'suppressUpdateNotice',
|
|
WelcomeNotice = 'suppressWelcomeNotice'
|
|
}
|
|
|
|
export class Messages {
|
|
|
|
static showCommitHasNoPreviousCommitWarningMessage(commit?: GitCommit): Promise<string | undefined> {
|
|
if (commit === undefined) return Messages.showMessage('info', `Commit has no previous commit`, SuppressedMessages.CommitHasNoPreviousCommitWarning);
|
|
return Messages.showMessage('info', `Commit ${commit.shortSha} (${commit.author}, ${commit.fromNow()}) has no previous commit`, SuppressedMessages.CommitHasNoPreviousCommitWarning);
|
|
}
|
|
|
|
static showCommitNotFoundWarningMessage(message: string): Promise<string | undefined> {
|
|
return Messages.showMessage('warn', `${message}. The commit could not be found`, SuppressedMessages.CommitNotFoundWarning);
|
|
}
|
|
|
|
static showFileNotUnderSourceControlWarningMessage(message: string): Promise<string | undefined> {
|
|
return Messages.showMessage('warn', `${message}. The file is probably not under source control`, SuppressedMessages.FileNotUnderSourceControlWarning);
|
|
}
|
|
|
|
static showLineUncommittedWarningMessage(message: string): Promise<string | undefined> {
|
|
return Messages.showMessage('warn', `${message}. The line has uncommitted changes`, SuppressedMessages.LineUncommittedWarning);
|
|
}
|
|
|
|
static showNoRepositoryWarningMessage(message: string): Promise<string | undefined> {
|
|
return Messages.showMessage('warn', `${message}. No repository could be found`, SuppressedMessages.NoRepositoryWarning);
|
|
}
|
|
|
|
static showUnsupportedGitVersionErrorMessage(version: string): Promise<string | undefined> {
|
|
return Messages.showMessage('error', `GitLens requires a newer version of Git (>= 2.2.0) than is currently installed (${version}). Please install a more recent version of Git.`, SuppressedMessages.GitVersionWarning);
|
|
}
|
|
|
|
static async showUpdateMessage(version: string): Promise<string | undefined> {
|
|
const viewReleaseNotes = 'View Release Notes';
|
|
const result = await Messages.showMessage('info', `GitLens has been updated to v${version}`, SuppressedMessages.UpdateNotice, undefined, viewReleaseNotes);
|
|
if (result === viewReleaseNotes) {
|
|
commands.executeCommand(BuiltInCommands.Open, Uri.parse('https://marketplace.visualstudio.com/items/eamodio.gitlens/changelog'));
|
|
}
|
|
return result;
|
|
}
|
|
|
|
static async showWelcomeMessage(): Promise<string | undefined> {
|
|
const viewDocs = 'View Docs';
|
|
const result = await Messages.showMessage('info', `Thank you for choosing GitLens! GitLens is powerful, feature rich, and highly configurable, so please be sure to view the docs and tailor it to suit your needs.`, SuppressedMessages.WelcomeNotice, null, viewDocs);
|
|
if (result === viewDocs) {
|
|
commands.executeCommand(BuiltInCommands.Open, Uri.parse('https://marketplace.visualstudio.com/items/eamodio.gitlens'));
|
|
}
|
|
return result;
|
|
}
|
|
|
|
private static async showMessage(type: 'info' | 'warn' | 'error', message: string, suppressionKey: SuppressedMessages, dontShowAgain: string | null = 'Don\'t Show Again', ...actions: any[]): Promise<string | undefined> {
|
|
Logger.log(`ShowMessage(${type}, '${message}', ${suppressionKey}, ${dontShowAgain})`);
|
|
|
|
if (configuration.get<boolean>(configuration.name('advanced')('messages')(suppressionKey).value)) {
|
|
Logger.log(`ShowMessage(${type}, ${message}, ${suppressionKey}, ${dontShowAgain}) skipped`);
|
|
return undefined;
|
|
}
|
|
|
|
if (dontShowAgain !== null) {
|
|
actions.push(dontShowAgain);
|
|
}
|
|
|
|
let result: string | undefined = undefined;
|
|
switch (type) {
|
|
case 'info':
|
|
result = await window.showInformationMessage(message, ...actions);
|
|
break;
|
|
|
|
case 'warn':
|
|
result = await window.showWarningMessage(message, ...actions);
|
|
break;
|
|
|
|
case 'error':
|
|
result = await window.showErrorMessage(message, ...actions);
|
|
break;
|
|
}
|
|
|
|
if (dontShowAgain === null || result === dontShowAgain) {
|
|
Logger.log(`ShowMessage(${type}, '${message}', ${suppressionKey}, ${dontShowAgain}) don't show again requested`);
|
|
|
|
const section = configuration.name('advanced')('messages').value;
|
|
const messages: { [key: string]: boolean } = configuration.get(section);
|
|
messages[suppressionKey] = true;
|
|
await configuration.update(section, messages, ConfigurationTarget.Global);
|
|
|
|
if (result === dontShowAgain) return undefined;
|
|
}
|
|
|
|
Logger.log(`ShowMessage(${type}, '${message}', ${suppressionKey}, ${dontShowAgain}) returned ${result}`);
|
|
return result;
|
|
}
|
|
}
|