Release 1.28.0 package & documentation changes.

Author: mhutchie

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## 1.28.0 - 2020-12-01
+* #399 Sign Commits and Tags created by actions in the Git Graph View, by enabling the new extension settings `git-graph.repository.sign.commits` and `git-graph.repository.sign.tags` respectively. This is an alternative to the existing method using Git config (`commit.gpgSign` and `tag.gpgSign`).
+* #406 The keybindings for all Git Graph View keyboard shortcuts can now be configured using new extension settings `git-graph.keyboardShortcut.*`.
+* #407 Control whether Remote Head Symbolic References (e.g. origin/HEAD) are displayed in Git Graph via the new extension setting `git-graph.repository.showRemoteHeads`. Thanks [Maciej Wilk (@wilkmaciej)](https://github.com/wilkmaciej) for helping with this!
+* #409 Include built-in support for new emoji shortcodes recently added to [gitmoji](https://gitmoji.carloscuesta.me/).
+* #412 New "Git Graph: Fetch from Remote(s)" command contributed to Visual Studio Code, that opens the Git Graph View and immediately runs "Fetch from Remote(s)".
+* #414 Your Git Graph Repository Configuration can now be exported to a file that can be committed in the repository. It allows others working in the same repository to automatically use the same Git Graph configuration. To export your configuration, click the "Export Repository Configuration" button at the bottom of the Repository Settings Widget (on the Git Graph View).
+* #416 The existing file encoding extension setting `git-graph.fileEncoding` can now also be configured at a Workspace Folder Scope.
+* #419 On dialogs that refer to the "current branch" (Merge, Pull, Rebase, and Reset), the current branch is now explicitly mentioned.
+* #420 Fixed an issue that prevented files that overflow horizontally in the Commit Details View Files View from being left-clicked (i.e. those shortened with an ellipsis). _(issue introduced via #381)_
+* Significant code improvements.
+
 ## 1.27.0 - 2020-11-01
 * #281 For the Repository Settings Widget, read values defined in additional Git config files when they're included via [include directives](https://git-scm.com/docs/git-config#_includes) in local or global Git config files.
 * #364 Parse and render a frequently used subset of inline Markdown formatting rules in commit messages and tag details (bold, italics, bold & italics, and inline code blocks). Markdown parsing can be disabled using the extension setting `git-graph.markdown`.

README.md

@@ -48,6 +48,7 @@ View a Git Graph of your repository, and easily perform Git actions from the gra
         * Configure "Pull Request Creation" - Automates the opening and pre-filling of a Pull Request form, directly from a branches context menu.
             * Support for the publicly hosted Bitbucket, GitHub and GitLab Pull Request providers is built-in.
             * Custom Pull Request providers can be configured using the Extension Setting `git-graph.customPullRequestProviders` (e.g. for use with privately hosted Pull Request providers). Information on how to configure custom providers is available [here](https://github.com/mhutchie/vscode-git-graph/wiki/Configuring-a-custom-Pull-Request-Provider).
+        * Export your Git Graph Repository Configuration to a file that can be committed in the repository. It allows others working in the same repository to automatically use the same Git Graph configuration.
     * Keyboard Shortcuts (available in the Git Graph View):
         * `CTRL/CMD + F`: Open the Find Widget.
         * `CTRL/CMD + H`: Scrolls the Git Graph View to be centered on the commit referenced by HEAD.
@@ -86,14 +87,15 @@ A summary of the Git Graph extension settings are:
     * **Format**: Specifies the date format to be used in the "Date" column on the Git Graph View.
     * **Type**: Specifies the date type to be displayed in the "Date" column on the Git Graph View, either the author or commit date.
 * **Default Column Visibility**: An object specifying the default visibility of the Date, Author & Commit columns. Example: `{"Date": true, "Author": true, "Commit": true}`
-* **Dialog.\***: Set the default options on the following dialogs: Add Tag, Apply Stash, Cherry Pick, Create Branch, Delete Branch, Fetch Remote, Merge, Pop Stash, Pull Branch, Rebase, Reset, and Stash Uncommitted Changes
+* **Dialog > \***: Set the default options on the following dialogs: Add Tag, Apply Stash, Cherry Pick, Create Branch, Delete Branch, Fetch Remote, Merge, Pop Stash, Pull Branch, Rebase, Reset, and Stash Uncommitted Changes
 * **Enhanced Accessibility**: Visual file change A|M|D|R|U indicators in the Commit Details View for users with colour blindness. In the future, this setting will enable any additional accessibility related features of Git Graph that aren't enabled by default.
 * **File Encoding**: The character set encoding used when retrieving a specific version of repository files (e.g. in the Diff View). A list of all supported encodings can be found [here](https://github.com/ashtuchkin/iconv-lite/wiki/Supported-Encodings).
 * **Graph**:
     * **Colours**: Specifies the colours used on the graph.
     * **Style**: Specifies the style of the graph.
     * **Uncommitted Changes**: Specifies how the Uncommitted Changes are displayed on the graph.
 * **Integrated Terminal Shell**: Specifies the path and filename of the Shell executable to be used by the Visual Studio Code Integrated Terminal, when it is opened by Git Graph.
+* **Keyboard Shortcut > \***: Configures the keybindings used for all keyboard shortcuts in the Git Graph View.
 * **Markdown**: Parse and render a frequently used subset of inline Markdown formatting rules in commit messages and tag details (bold, italics, bold & italics, and inline code blocks).
 * **Max Depth Of Repo Search**: Specifies the maximum depth of subfolders to search when discovering repositories in the workspace.
 * **Open New Tab Editor Group**: Specifies the Editor Group where Git Graph should open new tabs, when performing the following actions from the Git Graph View: Viewing the Visual Studio Code Diff View, Opening a File, Viewing a File at a Specific Revision.
@@ -122,9 +124,13 @@ A summary of the Git Graph extension settings are:
     * **Only Follow First Parent**: Only follow the first parent of commits when discovering the commits to load in the Git Graph View. See [--first-parent](https://git-scm.com/docs/git-log#Documentation/git-log.txt---first-parent) to find out more about this setting.
     * **Show Commits Only Referenced By Tags**: Show Commits that are only referenced by tags in Git Graph.
     * **Show Remote Branches**: Show Remote Branches in Git Graph by default.
+    * **Show Remote Heads**: Show Remote HEAD Symbolic References in Git Graph.
     * **Show Tags**: Show Tags in Git Graph by default.
     * **Show Uncommitted Changes**: Show uncommitted changes. If you work on large repositories, disabling this setting can reduce the load time of the Git Graph View.
     * **Show Untracked Files**: Show untracked files when viewing the uncommitted changes. If you work on large repositories, disabling this setting can reduce the load time of the Git Graph View.
+    * **Sign**:
+        * **Commits**: Enables commit signing with GPG or X.509.
+        * **Tags**: Enables tag signing with GPG or X.509.
     * **Use Mailmap**: Respect [.mailmap](https://git-scm.com/docs/git-check-mailmap#_mapping_authors) files when displaying author & committer names and email addresses.
 * **Repository Dropdown Order**: Specifies the order that repositories are sorted in the repository dropdown on the Git Graph View (only visible when more than one repository exists in the current Visual Studio Code Workspace).
 * **Retain Context When Hidden**: Specifies if the Git Graph view Visual Studio Code context is kept when the panel is no longer visible (e.g. moved to background tab). Enabling this setting will make Git Graph load significantly faster when switching back to the Git Graph tab, however has a higher memory overhead.
@@ -145,6 +151,7 @@ This extension contributes the following commands:
 * `git-graph.clearAvatarCache`: Git Graph: Clear Avatar Cache
 * `git-graph.endAllWorkspaceCodeReviews`: Git Graph: End All Code Reviews in Workspace
 * `git-graph.endSpecificWorkspaceCodeReview`: Git Graph: End a specific Code Review in Workspace... _(used to end a specific Code Review without having to first open it in the Git Graph View)_
+* `git-graph.fetch`: Git Graph: Fetch from Remote(s) _(used to open the Git Graph View and immediately run "Fetch from Remote(s)")_
 * `git-graph.removeGitRepository`: Git Graph: Remove Git Repository... _(used to remove repositories from Git Graph)_
 * `git-graph.resumeWorkspaceCodeReview`: Git Graph: Resume a specific Code Review in Workspace... _(used to open the Git Graph View to a Code Review that is already in progress)_
 * `git-graph.version`: Git Graph: Get Version Information

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "git-graph",
 	"displayName": "Git Graph",
-	"version": "1.27.0",
+	"version": "1.28.0",
 	"publisher": "mhutchie",
 	"author": {
 		"name": "Michael Hutchison",

src/avatarManager.ts

@@ -361,18 +361,18 @@ export class AvatarManager extends Disposable {
 	 * Download and save an avatar image.
 	 * @param email The email address identifying the avatar.
 	 * @param imageUrl The URL the avatar can be downloaded from.
-	 * @returns The image name of the avatar on disk, or NULL if downloading failed.
+	 * @returns A promise that resolves to the image name of the avatar on disk, or NULL if downloading failed.
 	 */
 	private downloadAvatarImage(email: string, imageUrl: string) {
 		return (new Promise<string | null>((resolve) => {
 			const hash = crypto.createHash('md5').update(email).digest('hex');
 			const imgUrl = url.parse(imageUrl);
 
 			let completed = false;
-			const complete = (data: string | null = null) => {
+			const complete = (fileName: string | null = null) => {
 				if (!completed) {
 					completed = true;
-					resolve(data);
+					resolve(fileName);
 				}
 			};
 
@@ -478,7 +478,7 @@ class AvatarRequestQueue {
 		const existingRequest = this.queue.find((request) => request.email === email && request.repo === repo);
 		if (existingRequest) {
 			commits.forEach((commit) => {
-				if (existingRequest.commits.indexOf(commit) === -1) {
+				if (!existingRequest.commits.includes(commit)) {
 					existingRequest.commits.push(commit);
 				}
 			});

src/commands.ts

@@ -169,7 +169,7 @@ export class CommandManager extends Disposable {
 		const repoPaths = Object.keys(repos);
 
 		if (repoPaths.length > 1) {
-			const items: vscode.QuickPickItem[] = Object.keys(repos).map((path) => ({
+			const items: vscode.QuickPickItem[] = repoPaths.map((path) => ({
 				label: repos[path].name || getRepoName(path),
 				description: path
 			}));

src/config.ts

@@ -282,7 +282,7 @@ class Config {
 	}
 
 	/**
-	 * Get the keybinding configuration from the `git-graph.keybinding.*` Extension Settings.
+	 * Get the keybinding configuration from the `git-graph.keyboardShortcut.*` Extension Settings.
 	 */
 	get keybindings(): KeybindingConfig {
 		return {
@@ -586,7 +586,7 @@ class Config {
 
 /**
  * Get a Config instance for retrieving the users configuration of Git Graph Extension Settings.
- * @param repo An option path of a repository (to be used for Workspace Folder Scoped Configuration Values).
+ * @param repo An optional path of a repository (to be used for Workspace Folder Scoped Configuration Values).
  * @returns A Config instance.
  */
 export function getConfig(repo?: string) {

src/dataSource.ts

@@ -635,12 +635,10 @@ export class DataSource extends Disposable {
 	 */
 	public addTag(repo: string, tagName: string, commitHash: string, lightweight: boolean, message: string) {
 		const args = ['tag'];
-		if (getConfig().signTags) {
-			args.push('-s', tagName, '-m', message);
-		} else if (lightweight) {
+		if (lightweight) {
 			args.push(tagName);
 		} else {
-			args.push('-a', tagName, '-m', message);
+			args.push(getConfig().signTags ? '-s' : '-a', tagName, '-m', message);
 		}
 		args.push(commitHash);
 		return this.runGitCommand(args, repo);

src/gitGraphView.ts

@@ -134,7 +134,7 @@ export class GitGraphView extends Disposable {
 				}
 			}),
 
-			// Subscribe to events trigged when an avatar is available
+			// Subscribe to events triggered when an avatar is available
 			avatarManager.onAvatar((event) => {
 				this.sendMessage({
 					command: 'fetchAvatar',

src/repoManager.ts

@@ -689,7 +689,6 @@ function doesPathExist(path: string) {
 export namespace ExternalRepoConfig {
 
 	export const enum FileViewType {
-		Default = 'default',
 		Tree = 'tree',
 		List = 'list'
 	}
@@ -751,7 +750,8 @@ function readExternalConfigFile(repo: string) {
 				resolve(null);
 			} else {
 				try {
-					resolve(JSON.parse(data.toString()));
+					const contents = JSON.parse(data.toString());
+					resolve(typeof contents === 'object' ? contents : null);
 				} catch (_) {
 					resolve(null);
 				}
@@ -980,10 +980,10 @@ function applyExternalConfigFile(file: Readonly<ExternalRepoConfig.File>, state:
 		}
 		state.pullRequestConfig = <PullRequestConfig>{
 			provider: provider,
-			custom: file.pullRequestConfig.custom !== null
+			custom: provider === PullRequestProvider.Custom
 				? {
-					name: file.pullRequestConfig.custom.name,
-					templateUrl: file.pullRequestConfig.custom.templateUrl
+					name: file.pullRequestConfig.custom!.name,
+					templateUrl: file.pullRequestConfig.custom!.templateUrl
 				}
 				: null,
 			hostRootUrl: file.pullRequestConfig.hostRootUrl,

tests/dataSource.test.ts

@@ -4167,7 +4167,6 @@ describe('DataSource', () => {
 		it('Should add a lightweight tag to a commit', async () => {
 			// Setup
 			mockGitSuccessOnce();
-			vscode.mockExtensionSettingReturnValue('repository.sign.tags', false);
 
 			// Run
 			const result = await dataSource.addTag('/path/to/repo', 'tag-name', '1a2b3c4d5e6f1a2b3c4d5e6f1a2b3c4d5e6f1a2b', true, '');