Adds default date format

Author: eamodio

CHANGELOG.md

@@ -12,6 +12,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 - Improves performance
   - Optimized git output parsing to increase speed and reduce memory usage
   - Defers diff chunk parsing until it is actually required
+- Adds `gitlens.defaultDateFormat` setting to specify how all absolute dates will be formatted by default
 
 ### Fixed
 - Fixes excessive memory usage when parsing diffs

README.md

@@ -219,6 +219,7 @@ GitLens is highly customizable and provides many configuration settings to allow
 
 |Name | Description
 |-----|------------
+|`gitlens.defaultDateFormat`|Specifies how all absolute dates will be formatted by default\nSee https://momentjs.com/docs/#/displaying/format/ for valid formats
 |`gitlens.insiders`|Opts into the insiders channel -- provides access to upcoming features
 |`gitlens.outputLevel`|Specifies how much (if any) output will be sent to the GitLens output channel
 

package.json

@@ -402,6 +402,11 @@
                     "default": false,
                     "description": "Specifies whether or not to show debug information in code lens"
                 },
+                "gitlens.defaultDateFormat": {
+                    "type": "string",
+                    "default": null,
+                    "description": "Specifies how all absolute dates will be formatted by default\nSee https://momentjs.com/docs/#/displaying/format/ for valid formats"
+                },
                 "gitlens.statusBar.enabled": {
                     "type": "boolean",
                     "default": true,

src/annotations/annotations.ts

@@ -59,8 +59,8 @@ export class Annotations {
         } as DecorationOptions;
     }
 
-    static detailsHover(commit: GitCommit): DecorationOptions {
-        const message = CommitFormatter.toHoverAnnotation(commit);
+    static detailsHover(commit: GitCommit, dateFormat: string | null): DecorationOptions {
+        const message = CommitFormatter.toHoverAnnotation(commit, dateFormat);
         return {
             hoverMessage: message
         } as DecorationOptions;
@@ -127,9 +127,9 @@ export class Annotations {
         } as IRenderOptions;
     }
 
-    static hover(commit: GitCommit, renderOptions: IRenderOptions, heatmap: boolean): DecorationOptions {
+    static hover(commit: GitCommit, renderOptions: IRenderOptions, heatmap: boolean, dateFormat: string | null): DecorationOptions {
         return {
-            hoverMessage: CommitFormatter.toHoverAnnotation(commit),
+            hoverMessage: CommitFormatter.toHoverAnnotation(commit, dateFormat),
             renderOptions: heatmap ? { before: { ...renderOptions.before } } : undefined
         } as DecorationOptions;
     }

src/annotations/gutterBlameAnnotationProvider.ts

@@ -25,14 +25,15 @@ export class GutterBlameAnnotationProvider extends BlameAnnotationProviderBase {
             }, {} as { [token: string]: ICommitFormatOptions });
 
         const options: ICommitFormatOptions = {
-            dateFormat: cfg.dateFormat,
+            dateFormat: cfg.dateFormat === null ? this._config.defaultDateFormat : cfg.dateFormat,
             tokenOptions: tokenOptions
         };
 
         const now = moment();
         const offset = this.uri.offset;
         let previousLine: string | undefined = undefined;
         const renderOptions = Annotations.gutterRenderOptions(this._config.theme, cfg.heatmap);
+        const dateFormat = this._config.defaultDateFormat;
 
         const decorations: DecorationOptions[] = [];
 
@@ -58,7 +59,7 @@ export class GutterBlameAnnotationProvider extends BlameAnnotationProviderBase {
             decorations.push(gutter);
 
             if (cfg.hover.details) {
-                const details = Annotations.detailsHover(commit);
+                const details = Annotations.detailsHover(commit, dateFormat);
                 details.range = cfg.hover.wholeLine
                     ? this.editor.document.validateRange(new Range(line, 0, line, endOfLineIndex))
                     : gutter.range;

src/annotations/hoverBlameAnnotationProvider.ts

@@ -18,6 +18,7 @@ export class HoverBlameAnnotationProvider extends BlameAnnotationProviderBase {
         const now = moment();
         const offset = this.uri.offset;
         const renderOptions = Annotations.hoverRenderOptions(this._config.theme, cfg.heatmap);
+        const dateFormat = this._config.defaultDateFormat;
 
         const decorations: DecorationOptions[] = [];
 
@@ -27,7 +28,7 @@ export class HoverBlameAnnotationProvider extends BlameAnnotationProviderBase {
 
             const line = l.line + offset;
 
-            const hover = Annotations.hover(commit, renderOptions, cfg.heatmap.enabled);
+            const hover = Annotations.hover(commit, renderOptions, cfg.heatmap.enabled, dateFormat);
 
             const endIndex = cfg.wholeLine ? endOfLineIndex : this.editor.document.lineAt(line).firstNonWhitespaceCharacterIndex;
             hover.range = this.editor.document.validateRange(new Range(line, 0, line, endIndex));

src/annotations/recentChangesAnnotationProvider.ts

@@ -21,6 +21,7 @@ export class RecentChangesAnnotationProvider extends AnnotationProviderBase {
         if (diff === undefined) return false;
 
         const cfg = this._config.annotations.file.recentChanges;
+        const dateFormat = this._config.defaultDateFormat;
 
         const decorators: DecorationOptions[] = [];
 
@@ -42,7 +43,7 @@ export class RecentChangesAnnotationProvider extends AnnotationProviderBase {
 
                 if (cfg.hover.details) {
                     decorators.push({
-                        hoverMessage: CommitFormatter.toHoverAnnotation(commit),
+                        hoverMessage: CommitFormatter.toHoverAnnotation(commit, dateFormat),
                         range: range
                     } as DecorationOptions);
                 }

src/configuration.ts

@@ -216,7 +216,7 @@ export interface IConfig {
         file: {
             gutter: {
                 format: string;
-                dateFormat: string;
+                dateFormat: string | null;
                 compact: boolean;
                 heatmap: {
                     enabled: boolean;
@@ -252,7 +252,7 @@ export interface IConfig {
 
             trailing: {
                 format: string;
-                dateFormat: string;
+                dateFormat: string | null;
                 hover: {
                     changes: boolean;
                     details: boolean;
@@ -301,12 +301,14 @@ export interface IConfig {
         debug: boolean;
     };
 
+    defaultDateFormat: string | null;
+
     statusBar: {
         enabled: boolean;
         alignment: 'left' | 'right';
         command: StatusBarCommand;
         format: string;
-        dateFormat: string;
+        dateFormat: string | null;
     };
 
     strings: {

src/currentLineController.ts

@@ -291,7 +291,7 @@ export class CurrentLineController extends Disposable {
                     showDetailsInStartingWhitespace = true;
                 }
 
-                const decoration = Annotations.trailing(commit, cfgAnnotations.format, cfgAnnotations.dateFormat, this._config.theme);
+                const decoration = Annotations.trailing(commit, cfgAnnotations.format, cfgAnnotations.dateFormat === null ? this._config.defaultDateFormat : cfgAnnotations.dateFormat, this._config.theme);
                 decoration.range = editor.document.validateRange(new Range(line, endOfLineIndex, line, endOfLineIndex));
                 decorationOptions.push(decoration);
 
@@ -395,7 +395,7 @@ export class CurrentLineController extends Disposable {
                 // I have no idea why I need this protection -- but it happens
                 if (editor.document === undefined) return;
 
-                const decoration = Annotations.detailsHover(logCommit || commit);
+                const decoration = Annotations.detailsHover(logCommit || commit, this._config.defaultDateFormat);
                 decoration.range = editor.document.validateRange(new Range(line, showDetailsStartIndex, line, endOfLineIndex));
                 decorationOptions.push(decoration);
 
@@ -429,7 +429,7 @@ export class CurrentLineController extends Disposable {
         const cfg = this._config.statusBar;
         if (!cfg.enabled || this._statusBarItem === undefined) return;
 
-        this._statusBarItem.text = `$(git-commit) ${CommitFormatter.fromTemplate(cfg.format, commit, cfg.dateFormat)}`;
+        this._statusBarItem.text = `$(git-commit) ${CommitFormatter.fromTemplate(cfg.format, commit, cfg.dateFormat === null ? this._config.defaultDateFormat : cfg.dateFormat)}`;
 
         switch (cfg.command) {
             case StatusBarCommand.BlameAnnotate:

src/git/formatters/commit.ts

@@ -158,7 +158,11 @@ export class CommitFormatter {
         return Strings.interpolate(template, new CommitFormatter(commit, options));
     }
 
-    static toHoverAnnotation(commit: GitCommit, dateFormat: string = 'MMMM Do, YYYY h:MMa'): string | string[] {
+    static toHoverAnnotation(commit: GitCommit, dateFormat: string | null): string | string[] {
+        if (dateFormat === null) {
+            dateFormat = 'MMMM Do, YYYY h:MMa';
+        }
+
         const message = commit.isUncommitted ? '' : `\n\n> ${commit.message.replace(/\n/g, '  \n')}`;
         return `\`${commit.shortSha}\`   __${commit.author}__, ${moment(commit.date).fromNow()}   _(${moment(commit.date).format(dateFormat)})_${message}`;
     }