ckaczor/vscode-gitlens
1
0
Fork 0
mirror of https://github.com/ckaczor/vscode-gitlens.git synced 2026-02-15 02:48:37 -05:00
Code Issues Packages Projects Releases Wiki Activity

Stops Git from leaking out of GitService

Browse Source
This commit is contained in:
Eric Amodio
2017-04-14 00:29:57 -04:00
parent 8f2ec85c6b
commit f99ba89a4b
7 changed files with 47 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/commands/showCommitSearch.ts
View File

@@ -1,7 +1,7 @@
'use strict'; 'use strict';
import { commands, InputBoxOptions, TextEditor, Uri, window } from 'vscode'; import { commands, InputBoxOptions, TextEditor, Uri, window } from 'vscode';
import { ActiveEditorCachedCommand, Commands } from './common'; import { ActiveEditorCachedCommand, Commands } from './common';
import { Git, GitRepoSearchBy, GitService, GitUri } from '../gitService'; import { GitRepoSearchBy, GitService, GitUri } from '../gitService';
import { Logger } from '../logger'; import { Logger } from '../logger';
import { CommandQuickPickItem, CommitsQuickPick } from '../quickPicks'; import { CommandQuickPickItem, CommitsQuickPick } from '../quickPicks';
@@ -39,7 +39,7 @@ export class ShowCommitSearchCommand extends ActiveEditorCachedCommand {
searchBy = searchByMap.get(match[1]); searchBy = searchByMap.get(match[1]);
search = search.substring((search[1] === ' ') ? 2 : 1); search = search.substring((search[1] === ' ') ? 2 : 1);
} }
else if (Git.isSha(search)) { else if (GitService.isSha(search)) {
searchBy = GitRepoSearchBy.Sha; searchBy = GitRepoSearchBy.Sha;
} }
else { else {

10
src/extension.ts
View File

@@ -20,7 +20,7 @@ import { Keyboard } from './commands';
import { IConfig } from './configuration'; import { IConfig } from './configuration';
import { ApplicationInsightsKey, BuiltInCommands, ExtensionId, WorkspaceState } from './constants'; import { ApplicationInsightsKey, BuiltInCommands, ExtensionId, WorkspaceState } from './constants';
import { GitContentProvider } from './gitContentProvider'; import { GitContentProvider } from './gitContentProvider';
import { Git, GitContextTracker, GitService } from './gitService'; import { GitContextTracker, GitService } from './gitService';
import { GitRevisionCodeLensProvider } from './gitRevisionCodeLensProvider'; import { GitRevisionCodeLensProvider } from './gitRevisionCodeLensProvider';
import { Logger } from './logger'; import { Logger } from './logger';
import { Telemetry } from './telemetry'; import { Telemetry } from './telemetry';
@@ -40,7 +40,7 @@ export async function activate(context: ExtensionContext) {
const gitPath = config.advanced.git; const gitPath = config.advanced.git;
try { try {
await Git.getGitPath(gitPath); await GitService.getGitPath(gitPath);
} }
catch (ex) { catch (ex) {
Logger.error(ex, 'Extension.activate'); Logger.error(ex, 'Extension.activate');
@@ -51,9 +51,9 @@ export async function activate(context: ExtensionContext) {
return; return;
} }
const repoPath = await Git.getRepoPath(rootPath); const repoPath = await GitService.getRepoPath(rootPath);
const gitVersion = Git.gitInfo().version; const gitVersion = GitService.getGitVersion();
Logger.log(`Git version: ${gitVersion}`); Logger.log(`Git version: ${gitVersion}`);
const telemetryContext: { [id: string]: any } = Object.create(null); const telemetryContext: { [id: string]: any } = Object.create(null);
@@ -146,7 +146,7 @@ async function notifyOnUnsupportedGitVersion(context: ExtensionContext, version:
if (context.globalState.get(WorkspaceState.SuppressGitVersionWarning, false)) return; if (context.globalState.get(WorkspaceState.SuppressGitVersionWarning, false)) return;
// If git is less than v2.2.0 // If git is less than v2.2.0
if (!Git.validateVersion(2, 2)) { if (!GitService.validateGitVersion(2, 2)) {
const result = await window.showErrorMessage(`GitLens requires a newer version of Git (>= 2.2.0) than is currently installed (${version}). Please install a more recent version of Git.`, `Don't Show Again`); const result = await window.showErrorMessage(`GitLens requires a newer version of Git (>= 2.2.0) than is currently installed (${version}). Please install a more recent version of Git.`, `Don't Show Again`);
if (result === `Don't Show Again`) { if (result === `Don't Show Again`) {
context.globalState.update(WorkspaceState.SuppressGitVersionWarning, true); context.globalState.update(WorkspaceState.SuppressGitVersionWarning, true);

3
src/git/git.ts
View File

@@ -6,6 +6,7 @@ import * as fs from 'fs';
import * as path from 'path'; import * as path from 'path';
import * as tmp from 'tmp'; import * as tmp from 'tmp';
export { IGit };
export * from './models/models'; export * from './models/models';
export * from './parsers/blameParser'; export * from './parsers/blameParser';
export * from './parsers/logParser'; export * from './parsers/logParser';
@@ -47,7 +48,7 @@ export class Git {
return git; return git;
} }
static async getGitPath(gitPath?: string) { static async getGitPath(gitPath?: string): Promise<IGit> {
git = await findGitPath(gitPath); git = await findGitPath(gitPath);
Logger.log(`Git found: ${git.version} @ ${git.path === 'git' ? 'PATH' : git.path}`); Logger.log(`Git found: ${git.version} @ ${git.path === 'git' ? 'PATH' : git.path}`);
return git; return git;

10
src/git/gitUri.ts
View File

@@ -1,7 +1,7 @@
'use strict'; 'use strict';
import { Uri } from 'vscode'; import { Uri } from 'vscode';
import { DocumentSchemes } from '../constants'; import { DocumentSchemes } from '../constants';
import { Git, GitCommit, GitService, IGitStatusFile } from '../gitService'; import { GitCommit, GitService, IGitStatusFile } from '../gitService';
import * as path from 'path'; import * as path from 'path';
export class GitUri extends Uri { export class GitUri extends Uri {
@@ -30,7 +30,7 @@ export class GitUri extends Uri {
base._fsPath = path.resolve(data.repoPath, data.originalFileName || data.fileName); base._fsPath = path.resolve(data.repoPath, data.originalFileName || data.fileName);
this.offset = (data.decoration && data.decoration.split('\n').length) || 0; this.offset = (data.decoration && data.decoration.split('\n').length) || 0;
if (!Git.isUncommitted(data.sha)) { if (!GitService.isUncommitted(data.sha)) {
this.sha = data.sha; this.sha = data.sha;
this.repoPath = data.repoPath; this.repoPath = data.repoPath;
} }
@@ -43,7 +43,7 @@ export class GitUri extends Uri {
const commit = commitOrRepoPath; const commit = commitOrRepoPath;
base._fsPath = path.resolve(commit.repoPath, commit.originalFileName || commit.fileName); base._fsPath = path.resolve(commit.repoPath, commit.originalFileName || commit.fileName);
if (!Git.isUncommitted(commit.sha)) { if (!GitService.isUncommitted(commit.sha)) {
this.sha = commit.sha; this.sha = commit.sha;
this.repoPath = commit.repoPath; this.repoPath = commit.repoPath;
} }
@@ -64,7 +64,7 @@ export class GitUri extends Uri {
if (this.repoPath) { if (this.repoPath) {
directory = path.relative(this.repoPath, directory); directory = path.relative(this.repoPath, directory);
} }
directory = Git.normalizePath(directory); directory = GitService.normalizePath(directory);
return (!directory || directory === '.') return (!directory || directory === '.')
? path.basename(this.fsPath) ? path.basename(this.fsPath)
@@ -72,7 +72,7 @@ export class GitUri extends Uri {
} }
getRelativePath(): string { getRelativePath(): string {
return Git.normalizePath(path.relative(this.repoPath, this.fsPath)); return GitService.normalizePath(path.relative(this.repoPath, this.fsPath));
} }
static async fromUri(uri: Uri, git: GitService) { static async fromUri(uri: Uri, git: GitService) {

32
src/gitService.ts
View File

@@ -4,7 +4,7 @@ import { Disposable, Event, EventEmitter, ExtensionContext, FileSystemWatcher, l
import { CommandContext, setCommandContext } from './commands'; import { CommandContext, setCommandContext } from './commands';
import { CodeLensVisibility, IConfig } from './configuration'; import { CodeLensVisibility, IConfig } from './configuration';
import { DocumentSchemes } from './constants'; import { DocumentSchemes } from './constants';
import { Git, GitBlameParser, GitBranch, GitCommit, GitLogCommit, GitLogParser, GitRemote, GitStashParser, GitStatusFile, GitStatusParser, IGitAuthor, IGitBlame, IGitBlameLine, IGitBlameLines, IGitLog, IGitStash, IGitStatus } from './git/git'; import { Git, GitBlameParser, GitBranch, GitCommit, GitLogCommit, GitLogParser, GitRemote, GitStashParser, GitStatusFile, GitStatusParser, IGit, IGitAuthor, IGitBlame, IGitBlameLine, IGitBlameLines, IGitLog, IGitStash, IGitStatus } from './git/git';
import { IGitUriData, GitUri } from './git/gitUri'; import { IGitUriData, GitUri } from './git/gitUri';
import { GitCodeLensProvider } from './gitCodeLensProvider'; import { GitCodeLensProvider } from './gitCodeLensProvider';
import { Logger } from './logger'; import { Logger } from './logger';
@@ -14,7 +14,8 @@ import * as moment from 'moment';
import * as path from 'path'; import * as path from 'path';
export { GitUri }; export { GitUri };
export * from './git/git'; export * from './git/models/models';
export { getNameFromRemoteOpenType, RemoteOpenType } from './git/remotes/provider';
export * from './git/gitContextTracker'; export * from './git/gitContextTracker';
class UriCacheEntry { class UriCacheEntry {
@@ -840,6 +841,18 @@ export class GitService extends Disposable {
this._codeLensProviderDisposable = languages.registerCodeLensProvider(GitCodeLensProvider.selector, new GitCodeLensProvider(this.context, this)); this._codeLensProviderDisposable = languages.registerCodeLensProvider(GitCodeLensProvider.selector, new GitCodeLensProvider(this.context, this));
} }
static getGitPath(gitPath?: string): Promise<IGit> {
return Git.getGitPath(gitPath);
}
static getGitVersion(): string {
return Git.gitInfo().version;
}
static getRepoPath(cwd: string): Promise<string> {
return Git.getRepoPath(cwd);
}
static fromGitContentUri(uri: Uri): IGitUriData { static fromGitContentUri(uri: Uri): IGitUriData {
if (uri.scheme !== DocumentSchemes.GitLensGit) throw new Error(`fromGitUri(uri=${uri}) invalid scheme`); if (uri.scheme !== DocumentSchemes.GitLensGit) throw new Error(`fromGitUri(uri=${uri}) invalid scheme`);
return GitService._fromGitContentUri<IGitUriData>(uri); return GitService._fromGitContentUri<IGitUriData>(uri);
@@ -849,10 +862,18 @@ export class GitService extends Disposable {
return JSON.parse(uri.query) as T; return JSON.parse(uri.query) as T;
} }
static isUncommitted(sha: string) { static isSha(sha: string): boolean {
return Git.isSha(sha);
}
static isUncommitted(sha: string): boolean {
return Git.isUncommitted(sha); return Git.isUncommitted(sha);
} }
static normalizePath(fileName: string, repoPath?: string): string {
return Git.normalizePath(fileName, repoPath);
}
static toGitContentUri(sha: string, shortSha: string, fileName: string, repoPath: string, originalFileName: string): Uri; static toGitContentUri(sha: string, shortSha: string, fileName: string, repoPath: string, originalFileName: string): Uri;
static toGitContentUri(commit: GitCommit): Uri; static toGitContentUri(commit: GitCommit): Uri;
static toGitContentUri(shaOrcommit: string | GitCommit, shortSha?: string, fileName?: string, repoPath?: string, originalFileName?: string): Uri { static toGitContentUri(shaOrcommit: string | GitCommit, shortSha?: string, fileName?: string, repoPath?: string, originalFileName?: string): Uri {
@@ -904,4 +925,9 @@ export class GitService extends Disposable {
} }
return data; return data;
} }
static validateGitVersion(major: number, minor: number): boolean {
const [gitMajor, gitMinor] = this.getGitVersion().split('.');
return (parseInt(gitMajor, 10) >= major && parseInt(gitMinor, 10) >= minor);
}
} }

4
src/quickPicks/commitDetails.ts
View File

@@ -3,7 +3,7 @@ import { Arrays, Iterables } from '../system';
import { QuickPickItem, QuickPickOptions, Uri, window } from 'vscode'; import { QuickPickItem, QuickPickOptions, Uri, window } from 'vscode';
import { Commands, Keyboard, KeyNoopCommand } from '../commands'; import { Commands, Keyboard, KeyNoopCommand } from '../commands';
import { CommandQuickPickItem, getQuickPickIgnoreFocusOut, KeyCommandQuickPickItem, OpenFileCommandQuickPickItem, OpenFilesCommandQuickPickItem } from './common'; import { CommandQuickPickItem, getQuickPickIgnoreFocusOut, KeyCommandQuickPickItem, OpenFileCommandQuickPickItem, OpenFilesCommandQuickPickItem } from './common';
import { getGitStatusIcon, Git, GitCommit, GitLogCommit, GitService, GitStashCommit, GitStatusFileStatus, GitUri, IGitLog, IGitStatusFile } from '../gitService'; import { getGitStatusIcon, GitCommit, GitLogCommit, GitService, GitStashCommit, GitStatusFileStatus, GitUri, IGitLog, IGitStatusFile } from '../gitService';
import { OpenRemotesCommandQuickPickItem } from './remotes'; import { OpenRemotesCommandQuickPickItem } from './remotes';
import * as moment from 'moment'; import * as moment from 'moment';
import * as path from 'path'; import * as path from 'path';
@@ -19,7 +19,7 @@ export class CommitWithFileStatusQuickPickItem extends OpenFileCommandQuickPickI
constructor(commit: GitCommit, status: IGitStatusFile) { constructor(commit: GitCommit, status: IGitStatusFile) {
const icon = getGitStatusIcon(status.status); const icon = getGitStatusIcon(status.status);
let directory = Git.normalizePath(path.dirname(status.fileName)); let directory = GitService.normalizePath(path.dirname(status.fileName));
if (!directory || directory === '.') { if (!directory || directory === '.') {
directory = undefined; directory = undefined;
} }

4
src/quickPicks/repoStatus.ts
View File

@@ -3,7 +3,7 @@ import { Iterables } from '../system';
import { QuickPickItem, QuickPickOptions, Uri, window } from 'vscode'; import { QuickPickItem, QuickPickOptions, Uri, window } from 'vscode';
import { Commands, Keyboard } from '../commands'; import { Commands, Keyboard } from '../commands';
import { CommandQuickPickItem, getQuickPickIgnoreFocusOut, OpenFileCommandQuickPickItem } from './common'; import { CommandQuickPickItem, getQuickPickIgnoreFocusOut, OpenFileCommandQuickPickItem } from './common';
import { Git, GitStatusFile, GitUri, IGitStatus } from '../gitService'; import { GitService, GitStatusFile, GitUri, IGitStatus } from '../gitService';
import * as path from 'path'; import * as path from 'path';
export class OpenStatusFileCommandQuickPickItem extends OpenFileCommandQuickPickItem { export class OpenStatusFileCommandQuickPickItem extends OpenFileCommandQuickPickItem {
@@ -11,7 +11,7 @@ export class OpenStatusFileCommandQuickPickItem extends OpenFileCommandQuickPick
constructor(status: GitStatusFile, item?: QuickPickItem) { constructor(status: GitStatusFile, item?: QuickPickItem) {
const icon = status.getIcon(); const icon = status.getIcon();
let directory = Git.normalizePath(path.dirname(status.fileName)); let directory = GitService.normalizePath(path.dirname(status.fileName));
if (!directory || directory === '.') { if (!directory || directory === '.') {
directory = undefined; directory = undefined;
} }