wlxsp
/
test1
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Browse Source

Closes #542 - adds file annotation option to modes

main
Eric Amodio 6 years ago
parent
7ca0da664d
commit
18ee54dbdf
10 changed files with 149 additions and 48 deletions
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. +6
    -0
      CHANGELOG.md
  2. +6
    -6
      README.md
  3. +68
    -30
      package.json
  4. +1
    -4
      src/annotations/annotations.ts
  5. +11
    -3
      src/annotations/fileAnnotationController.ts
  6. +7
    -3
      src/commands/annotations.ts
  7. +14
    -0
      src/commands/switchMode.ts
  8. +3
    -0
      src/configuration.ts
  9. +32
    -2
      src/container.ts
  10. +1
    -0
      src/ui/config.ts

+ 6
- 0
CHANGELOG.md View File

@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
## [Unreleased]
### Added
- Adds the ability to turn on file annotations (blame, heatmap, and recent changes) via user-defined modes — closes [#542](https://github.com/eamodio/vscode-gitlens/issues/542)
## [9.2.4] - 2018-12-26 ## [9.2.4] - 2018-12-26
### Added ### Added

+ 6
- 6
README.md View File

@ -831,12 +831,12 @@ See also [View Settings](#view-settings- 'Jump to the View settings')
### Modes Settings [#](#modes-settings- 'Modes Settings') ### Modes Settings [#](#modes-settings- 'Modes Settings')
| Name | Description |
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `gitlens.mode.active` | Specifies the active GitLens mode, if any |
| `gitlens.mode.statusBar.enabled` | Specifies whether to provide the active GitLens mode in the status bar |
| `gitlens.mode.statusBar.alignment` | Specifies the active GitLens mode alignment in the status bar<br /><br />`left` - aligns to the left<br />`right` - aligns to the right |
| `gitlens.modes` | Specifies the user-defined GitLens modes |
| Name | Description |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `gitlens.mode.active` | Specifies the active GitLens mode, if any |
| `gitlens.mode.statusBar.enabled` | Specifies whether to provide the active GitLens mode in the status bar |
| `gitlens.mode.statusBar.alignment` | Specifies the active GitLens mode alignment in the status bar<br /><br />`left` - aligns to the left<br />`right` - aligns to the right |
| `gitlens.modes` | Specifies the user-defined GitLens modes class="p">< class="nt">br class="p">/>< class="nt">br class="p">/>Example class="ni">&mdash; adds heatmap annotations to the built-in class="ge">_Reviewing_ mode class="p">< class="nt">br class="p">/>`"gitlens.modes": { "review": { "annotations": "heatmap" } }` class="p">< class="nt">br class="p">/>< class="nt">br class="p">/>Example class="ni">&mdash; adds a new class="ge">_Annotating_ mode with blame annotations class="p">< class="nt">br class="p">/>`"gitlens.modes": {` class="p">< class="nt">br class="p">/> class="ni">&nbsp;&nbsp;&nbsp;&nbsp;`"annotate": {` class="p">< class="nt">br class="p">/> class="ni">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`"name": "Annotating",` class="p">< class="nt">br class="p">/> class="ni">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`"statusBarItemName": "Annotating",` class="p">< class="nt">br class="p">/> class="ni">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`"description": "for root cause analysis",` class="p">< class="nt">br class="p">/> class="ni">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`"annotations": "blame",` class="p">< class="nt">br class="p">/> class="ni">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`"codeLens": false,` class="p">< class="nt">br class="p">/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`"currentLine": false,`<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`"hovers": true`<br />&nbsp;&nbsp;&nbsp;&nbsp;`}`<br />`}` |
### Advanced Settings [#](#advanced-settings- 'Advanced Settings') ### Advanced Settings [#](#advanced-settings- 'Advanced Settings')

+ 68
- 30
package.json View File

@ -841,65 +841,75 @@
"properties": { "properties": {
"zen": { "zen": {
"type": "object", "type": "object",
"required": [
"name"
],
"properties": { "properties": {
"name": { "name": {
"type": "string"
"type": "string",
"description": "Specifies the friendly name of this user-defined mode"
}, },
"statusBarItemName": { "statusBarItemName": {
"type": "string"
"type": "string",
"description": "Specifies the name shown in the status bar when this user-defined mode is active"
}, },
"description": { "description": {
"type": "string"
"type": "string",
"description": "Specifies the description of this user-defined mode"
}, },
"codeLens": { "codeLens": {
"type": "boolean"
"type": "boolean",
"description": "Specifies whether to show any Git code lens when this user-defined mode is active"
}, },
"currentLine": { "currentLine": {
"type": "boolean"
"type": "boolean",
"description": "Specifies whether to show a blame annotation for the current line when this user-defined mode is active"
}, },
"hovers": { "hovers": {
"type": "boolean"
"type": "boolean",
"description": "Specifies whether to show any hovers when this user-defined mode is active"
}, },
"statusBar": { "statusBar": {
"type": "boolean"
"type": "boolean",
"description": "Specifies whether to show blame information in the status bar when this user-defined mode is active"
}, },
"views": { "views": {
"type": "boolean"
"type": "boolean",
"description": "Specifies whether to show any GitLens views when this user-defined mode is active"
} }
} }
}, },
"review": { "review": {
"type": "object", "type": "object",
"required": [
"name"
],
"properties": { "properties": {
"name": { "name": {
"type": "string"
"type": "string",
"description": "Specifies the friendly name of this user-defined mode"
}, },
"statusBarItemName": { "statusBarItemName": {
"type": "string"
"type": "string",
"description": "Specifies the name shown in the status bar when this user-defined mode is active"
}, },
"description": { "description": {
"type": "string"
"type": "string",
"description": "Specifies the description of this user-defined mode"
}, },
"codeLens": { "codeLens": {
"type": "boolean"
"type": "boolean",
"description": "Specifies whether to show any Git code lens when this user-defined mode is active"
}, },
"currentLine": { "currentLine": {
"type": "boolean"
"type": "boolean",
"description": "Specifies whether to show a blame annotation for the current line when this user-defined mode is active"
}, },
"hovers": { "hovers": {
"type": "boolean"
"type": "boolean",
"description": "Specifies whether to show any hovers when this user-defined mode is active"
}, },
"statusBar": { "statusBar": {
"type": "boolean"
"type": "boolean",
"description": "Specifies whether to show blame information in the status bar when this user-defined mode is active"
}, },
"views": { "views": {
"type": "boolean"
"type": "boolean",
"description": "Specifies whether to show any GitLens views when this user-defined mode is active"
} }
} }
} }
@ -911,28 +921,50 @@
], ],
"properties": { "properties": {
"name": { "name": {
"type": "string"
"type": "string",
"description": "Specifies the friendly name of this user-defined mode"
}, },
"statusBarItemName": { "statusBarItemName": {
"type": "string"
"type": "string",
"description": "Specifies the name shown in the status bar when this user-defined mode is active"
}, },
"description": { "description": {
"type": "string"
"type": "string",
"description": "Specifies the description of this user-defined mode"
},
"annotations": {
"type": "string",
"enum": [
"blame",
"heatmap",
"recentChanges"
],
"enumDescriptions": [
"Shows the gutter blame annotations",
"Shows the gutter heatmap annotations",
"Shows the recently changed lines annotations"
],
"description": "Specifies which (if any) file annotations will be shown when this user-defined mode is active"
}, },
"codeLens": { "codeLens": {
"type": "boolean"
"type": "boolean",
"description": "Specifies whether to show any Git code lens when this user-defined mode is active"
}, },
"currentLine": { "currentLine": {
"type": "boolean"
"type": "boolean",
"description": "Specifies whether to show a blame annotation for the current line when this user-defined mode is active"
}, },
"hovers": { "hovers": {
"type": "boolean"
"type": "boolean",
"description": "Specifies whether to show any hovers when this user-defined mode is active"
}, },
"statusBar": { "statusBar": {
"type": "boolean"
"type": "boolean",
"description": "Specifies whether to show blame information in the status bar when this user-defined mode is active"
}, },
"views": { "views": {
"type": "boolean"
"type": "boolean",
"description": "Specifies whether to show any GitLens views when this user-defined mode is active"
} }
} }
}, },
@ -967,6 +999,12 @@
"verbose", "verbose",
"debug" "debug"
], ],
"enumDescriptions": [
"Logs nothing",
"Logs only errors",
"Logs all errors, warnings, and messages",
"Logs all errors, warnings, and messages with extra context useful for debugging"
],
"markdownDescription": "Specifies how much (if any) output will be sent to the GitLens output channel", "markdownDescription": "Specifies how much (if any) output will be sent to the GitLens output channel",
"scope": "window" "scope": "window"
}, },

+ 1
- 4
src/annotations/annotations.ts View File

@ -344,10 +344,7 @@ export class Annotations {
static heatmapRenderOptions(): IRenderOptions { static heatmapRenderOptions(): IRenderOptions {
return { return {
borderStyle: 'solid', borderStyle: 'solid',
borderWidth: '0 0 0 2px',
contentText: GlyphChars.ZeroWidthSpace,
height: '100%',
margin: '0 26px -1px 0'
borderWidth: '0 0 0 2px'
} as IRenderOptions; } as IRenderOptions;
} }

+ 11
- 3
src/annotations/fileAnnotationController.ts View File

@ -19,7 +19,7 @@ import {
workspace workspace
} from 'vscode'; } from 'vscode';
import { AnnotationsToggleMode, configuration, FileAnnotationType, HighlightLocations } from '../configuration'; import { AnnotationsToggleMode, configuration, FileAnnotationType, HighlightLocations } from '../configuration';
import { CommandContext, isTextEditor, setCommandContext } from '../constants';
import { CommandContext, GlyphChars, isTextEditor, setCommandContext } from '../constants';
import { Container } from '../container'; import { Container } from '../container';
import { KeyboardScope, KeyCommand, Keys } from '../keyboard'; import { KeyboardScope, KeyCommand, Keys } from '../keyboard';
import { Logger } from '../logger'; import { Logger } from '../logger';
@ -49,7 +49,13 @@ export const Decorations = {
textDecoration: 'none' textDecoration: 'none'
} as DecorationRenderOptions), } as DecorationRenderOptions),
blameHighlight: undefined as TextEditorDecorationType | undefined, blameHighlight: undefined as TextEditorDecorationType | undefined,
heatmapAnnotation: window.createTextEditorDecorationType({} as DecorationRenderOptions),
heatmapAnnotation: window.createTextEditorDecorationType({
before: {
contentText: GlyphChars.ZeroWidthSpace,
height: '100%',
margin: '0 26px -1px 0'
}
} as DecorationRenderOptions),
heatmapHighlight: undefined as TextEditorDecorationType | undefined, heatmapHighlight: undefined as TextEditorDecorationType | undefined,
recentChangesAnnotation: undefined as TextEditorDecorationType | undefined, recentChangesAnnotation: undefined as TextEditorDecorationType | undefined,
recentChangesHighlight: undefined as TextEditorDecorationType | undefined recentChangesHighlight: undefined as TextEditorDecorationType | undefined
@ -389,7 +395,8 @@ export class FileAnnotationController implements Disposable {
async toggle( async toggle(
editor: TextEditor | undefined, editor: TextEditor | undefined,
type: FileAnnotationType, type: FileAnnotationType,
shaOrLine?: string | number
shaOrLine?: string | number,
on?: boolean
): Promise<boolean> { ): Promise<boolean> {
if (editor !== undefined) { if (editor !== undefined) {
const trackedDocument = await Container.tracker.getOrAdd(editor.document); const trackedDocument = await Container.tracker.getOrAdd(editor.document);
@ -405,6 +412,7 @@ export class FileAnnotationController implements Disposable {
if (provider === undefined) return this.show(editor!, type, shaOrLine); if (provider === undefined) return this.show(editor!, type, shaOrLine);
const reopen = provider.annotationType !== type; const reopen = provider.annotationType !== type;
if (on === true && !reopen) return true;
if (this.isInWindowToggle()) { if (this.isInWindowToggle()) {
await this.clearAll(); await this.clearAll();

+ 7
- 3
src/commands/annotations.ts View File

@ -36,6 +36,7 @@ export class ClearFileAnnotationsCommand extends EditorCommand {
} }
export interface ToggleFileBlameCommandArgs { export interface ToggleFileBlameCommandArgs {
on?: boolean;
sha?: string; sha?: string;
type?: FileAnnotationType; type?: FileAnnotationType;
} }
@ -65,7 +66,8 @@ export class ToggleFileBlameCommand extends ActiveEditorCommand {
return Container.fileAnnotations.toggle( return Container.fileAnnotations.toggle(
editor, editor,
args.type!, args.type!,
args.sha !== undefined ? args.sha : editor && editor.selection.active.line
args.sha !== undefined ? args.sha : editor && editor.selection.active.line,
args.on
); );
} }
catch (ex) { catch (ex) {
@ -83,8 +85,9 @@ export class ToggleFileHeatmapCommand extends ActiveEditorCommand {
super(Commands.ToggleFileHeatmap); super(Commands.ToggleFileHeatmap);
} }
async execute(editor: TextEditor, uri?: Uri): Promise<any> {
async execute(editor: TextEditor, uri?: Uri, args: ToggleFileBlameCommandArgs = {}): Promise<any> {
commands.executeCommand(Commands.ToggleFileBlame, uri, { commands.executeCommand(Commands.ToggleFileBlame, uri, {
...args,
type: FileAnnotationType.Heatmap type: FileAnnotationType.Heatmap
} as ToggleFileBlameCommandArgs); } as ToggleFileBlameCommandArgs);
} }
@ -96,8 +99,9 @@ export class ToggleFileRecentChangesCommand extends ActiveEditorCommand {
super(Commands.ToggleFileRecentChanges); super(Commands.ToggleFileRecentChanges);
} }
async execute(editor: TextEditor, uri?: Uri): Promise<any> {
async execute(editor: TextEditor, uri?: Uri, args: ToggleFileBlameCommandArgs = {}): Promise<any> {
commands.executeCommand(Commands.ToggleFileBlame, uri, { commands.executeCommand(Commands.ToggleFileBlame, uri, {
...args,
type: FileAnnotationType.RecentChanges type: FileAnnotationType.RecentChanges
} as ToggleFileBlameCommandArgs); } as ToggleFileBlameCommandArgs);
} }

+ 14
- 0
src/commands/switchMode.ts View File

@ -15,6 +15,20 @@ export class SwitchModeCommand extends Command {
const pick = await ModesQuickPick.show(); const pick = await ModesQuickPick.show();
if (pick === undefined) return; if (pick === undefined) return;
const active = Container.config.mode.active;
if (active === pick.key) return;
// Check if we have applied any annotations and clear them if we won't be applying them again
if (active != null && active.length !== 0) {
const activeAnnotations = Container.config.modes[active].annotations;
if (activeAnnotations != null) {
const newAnnotations = pick.key != null ? Container.config.modes[pick.key].annotations : undefined;
if (activeAnnotations !== newAnnotations) {
await Container.fileAnnotations.clearAll();
}
}
}
await configuration.update(configuration.name('mode')('active').value, pick.key, ConfigurationTarget.Global); await configuration.update(configuration.name('mode')('active').value, pick.key, ConfigurationTarget.Global);
} }
} }

+ 3
- 0
src/configuration.ts View File

@ -40,9 +40,12 @@ export class Configuration {
this._configAffectedByMode = [ this._configAffectedByMode = [
`gitlens.${this.name('mode').value}`, `gitlens.${this.name('mode').value}`,
`gitlens.${this.name('modes').value}`, `gitlens.${this.name('modes').value}`,
`gitlens.${this.name('blame')('toggleMode').value}`,
`gitlens.${this.name('codeLens').value}`, `gitlens.${this.name('codeLens').value}`,
`gitlens.${this.name('currentLine').value}`, `gitlens.${this.name('currentLine').value}`,
`gitlens.${this.name('heatmap')('toggleMode').value}`,
`gitlens.${this.name('hovers').value}`, `gitlens.${this.name('hovers').value}`,
`gitlens.${this.name('recentChanges')('toggleMode').value}`,
`gitlens.${this.name('statusBar').value}`, `gitlens.${this.name('statusBar').value}`,
`gitlens.${this.name('views')('compare').value}`, `gitlens.${this.name('views')('compare').value}`,
`gitlens.${this.name('views')('fileHistory').value}`, `gitlens.${this.name('views')('fileHistory').value}`,

+ 32
- 2
src/container.ts View File

@ -1,9 +1,10 @@
'use strict'; 'use strict';
import { Disposable, ExtensionContext } from 'vscode';
import { commands, Disposable, ExtensionContext } from 'vscode';
import { FileAnnotationController } from './annotations/fileAnnotationController'; import { FileAnnotationController } from './annotations/fileAnnotationController';
import { LineAnnotationController } from './annotations/lineAnnotationController'; import { LineAnnotationController } from './annotations/lineAnnotationController';
import { GitCodeLensController } from './codelens/codeLensController'; import { GitCodeLensController } from './codelens/codeLensController';
import { Config, configuration } from './configuration';
import { Commands, ToggleFileBlameCommandArgs } from './commands';
import { AnnotationsToggleMode, Config, configuration } from './configuration';
import { GitFileSystemProvider } from './git/fsProvider'; import { GitFileSystemProvider } from './git/fsProvider';
import { GitService } from './git/gitService'; import { GitService } from './git/gitService';
import { LineHoverController } from './hovers/lineHoverController'; import { LineHoverController } from './hovers/lineHoverController';
@ -244,6 +245,35 @@ export class Container {
const mode = config.modes[config.mode.active]; const mode = config.modes[config.mode.active];
if (mode == null) return config; if (mode == null) return config;
if (mode.annotations != null) {
let command: string | undefined;
switch (mode.annotations) {
case 'blame':
config.blame.toggleMode = AnnotationsToggleMode.Window;
command = Commands.ToggleFileBlame;
break;
case 'heatmap':
config.heatmap.toggleMode = AnnotationsToggleMode.Window;
command = Commands.ToggleFileHeatmap;
break;
case 'recentChanges':
config.recentChanges.toggleMode = AnnotationsToggleMode.Window;
command = Commands.ToggleFileRecentChanges;
break;
}
if (command !== undefined) {
// Make sure to delay the execution by a bit so that the configuration changes get propegated first
setTimeout(
() =>
commands.executeCommand(command!, {
on: true
} as ToggleFileBlameCommandArgs),
50
);
}
}
if (mode.codeLens != null) { if (mode.codeLens != null) {
config.codeLens.enabled = mode.codeLens; config.codeLens.enabled = mode.codeLens;
} }

+ 1
- 0
src/ui/config.ts View File

@ -312,6 +312,7 @@ export interface ModeConfig {
name: string; name: string;
statusBarItemName?: string; statusBarItemName?: string;
description?: string; description?: string;
annotations?: 'blame' | 'heatmap' | 'recentChanges';
codeLens?: boolean; codeLens?: boolean;
currentLine?: boolean; currentLine?: boolean;
hovers?: boolean; hovers?: boolean;

Write Preview
Loading…
Cancel
Save