1.8.0 - Customizable status bar message format waderyan#5

Author: Sertion

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 1.8.0 (May 01, 2017)
+
+* Feature: Customizable status bar message format [#5](https://github.com/Sertion/vscode-gitblame/issues/5)
+* Feature: Customizable `infoMessage` format
+* Enhancement: Updating installation instructions
+
 ## 1.7.1 (April 30, 2017)
 
 * Enhancement: Use the same cache for `showMessage` and `view.refresh`

README.md

@@ -6,23 +6,48 @@ See Git Blame information in the status bar for the currently selected line.
 
 # Install
 
-Open up VS Code.
-
-1. Press `F1`
-2. Type `ext` in command palette
-3. Select "install" and hit enter
-4. Type `blame`
-5. Select "Git Blame" extension and hit enter
+1. Open _Visual Studio Code_
+1. Press `Ctrl+Shift+X` or `⇧⌘X`
+1. Type `blame`
+1. Click install on _Git Blame_
 
 # Configuration
 
 - `gitblame.commitUrl` (`string`, default `""`)
   - url where you can see the commit by hash
-  - Available tokens:
+  - available tokens:
     - `${hash}` - the commit hash
   - _Example:_ `https://github.com/Sertion/vscode-gitblame/commit/${hash}`
 - `gitblame.ignoreWhitespace` (`boolean`, default `false`)
   - use the git blame `-w` flag
+- `gitblame.infoMessageFormat` (`string`, default `"${commit.hash} ${commit.summary}"`)
+  - message that appears when the `extension.blame` command executes (when you click the status bar message)
+  - available tokens:
+    - `${commit.hash}` - 40-bit hash unique to the commit
+    - `${commit.summary}` - the first line of the commit message
+    - `${commit.filename}` - the file name where the line was committed
+    - `${author.name}` - the commit author's name
+    - `${author.email}` - the commit author's e-mail
+    - `${author.timestamp}` - timestamp for the commit author's commit
+    - `${author.tz}` - the commit author's time zone
+    - `${committer.name}` - the committer's name
+    - `${committer.email}` - the committer's e-mail
+    - `${committer.timestamp}` - timestamp for the committer's commit
+    - `${committer.tz}` - the committer's time zone
+    - `${time.ago}` - displays an estimation of how long ago the author committed (e.g. `10 hours ago`, `20 days ago`, `4 months ago`)
+    - `${time.custom,your_format}` - custom time format based on [momentjs.format(your_format)](https://momentjs.com/docs/#/displaying/format/) (uses author timestamp)
+    - `${time.from}` - format based on [momentjs.fromNow()](https://momentjs.com/docs/#/displaying/fromnow/) (uses author timestamp)
+    - `${time.c_ago}` - displays an estimation of how long ago the committer committed (e.g. `10 hours ago`, `20 days ago`, `4 months ago`)
+    - `${time.c_custom,your_format}` - custom time format based on [momentjs.format(your_format)](https://momentjs.com/docs/#/displaying/format/) (uses committer timestamp)
+    - `${time.c_from}` - format based on [momentjs.fromNow()](https://momentjs.com/docs/#/displaying/fromnow/) (uses committer timestamp)
+- `gitblame.statusBarMessageFormat` (`string`, default `"Blame ${author.name} ( ${time.ago} )"`)
+  - message in the status bar about the current line's git blame commit
+  - available tokens:
+    - See `gitblame.infoMessageFormat`
+- `gitblame.statusBarMessageNoCommit` (`string`, default `"Not Committed Yet"`)
+  - message in the status bar about the current line when no commit can be found
+  - available tokens:
+    - _No available tokens_
 
 # [Planned Features](https://github.com/Sertion/vscode-gitblame/labels/Planned)
 

package.json

@@ -2,7 +2,7 @@
   "name": "gitblame",
   "displayName": "Git Blame",
   "description": "See git blame information in the status bar.",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "publisher": "waderyan",
   "engines": {
     "vscode": "^1.10.0"
@@ -72,6 +72,21 @@
           "type": "string",
           "default": "",
           "description": "The link to an online tool to view a commit (use ${hash} for the commit hash)"
+        },
+        "gitblame.statusBarMessageNoCommit": {
+          "type": "string",
+          "default": "Not Committed Yet",
+          "description": "Customize the status bar message"
+        },
+        "gitblame.statusBarMessageFormat": {
+          "type": "string",
+          "default": "Blame ${author.name} ( ${time.ago} )",
+          "description": "Customize the status bar message"
+        },
+        "gitblame.infoMessageFormat": {
+          "type": "string",
+          "default": "${commit.hash} ${commit.summary}",
+          "description": "Customize the info message"
         }
       }
     }

src/extension.ts

@@ -56,6 +56,7 @@ function showMessage(context: ExtensionContext, repoDir: string) {
     const viewOnlineTitle = 'View';
     const config = workspace.getConfiguration('gitblame');
     const commitUrl = <string>config.get('commitUrl');
+    const messageFormat = <string>config.get('infoMessageFormat');
 
     fs.access(repoPath, (err) => {
         if (err) {
@@ -85,11 +86,12 @@ function showMessage(context: ExtensionContext, repoDir: string) {
 
                 const hash = info['lines'][lineNumber]['hash'];
                 const commitInfo = info['commits'][hash];
+                let normalizedCommitInfo = TextDecorator.normalizeCommitInfoTokens(commitInfo);
                 let infoMessageArguments = [];
                 let urlToUse = null;
 
                 // Add the message
-                infoMessageArguments.push(hash + ' ' + commitInfo['summary']);
+                infoMessageArguments.push(TextDecorator.parseTokens(messageFormat, normalizedCommitInfo));
 
                 if (commitUrl) {
                     // If we have a commitUrl we parse it and add it

src/textdecorator.ts

@@ -1,18 +1,19 @@
+import {workspace} from 'vscode';
 import * as moment from 'moment';
 import * as ObjectPath from 'object-path';
 
 export class TextDecorator {
 
     static toTextView(commit: Object) : string {
-        const dateNow = new Date();
-        const author = commit['author'];
-        const dateText = TextDecorator.toDateText(dateNow, new Date(author['timestamp'] * 1000));
+        const config = workspace.getConfiguration('gitblame');
 
         if (commit['hash'] === '0000000000000000000000000000000000000000') {
-            return author['name'];
+            return <string>config.get('statusBarMessageNoCommit');
         }
         else {
-            return 'Blame ' + author['name'] + ' ( ' + dateText + ' )';
+            let normalizedCommitInfo = TextDecorator.normalizeCommitInfoTokens(commit);
+            let messageFormat = <string>config.get('statusBarMessageFormat');
+            return TextDecorator.parseTokens(messageFormat, normalizedCommitInfo);
         }
     }
 
@@ -44,7 +45,7 @@ export class TextDecorator {
     }
 
     static parseTokens(target: string, tokens: object = {}): string {
-        const tokenRegex = /\$\{([a-z\.\-]{1,})[,]*(|[a-z\-,]{1,})}/gi;
+        const tokenRegex = /\$\{([a-z\.\-]{1,})[,]*(|.{1,}?)(?=\})}/gi;
 
         return target.replace(tokenRegex, (string: string, key: string, value: string): string => {
             let currentToken = ObjectPath.get(tokens, key)
@@ -56,8 +57,7 @@ export class TextDecorator {
                 return currentToken.toString();
             }
             else if (typeof currentToken === 'function') {
-                let values = value.split(',');
-                let newString = currentToken.call(this, key, values);
+                let newString = currentToken.call(this, value, key);
 
                 if (typeof newString === 'string') {
                     return newString;
@@ -70,4 +70,27 @@ export class TextDecorator {
             return key;
         });
     }
+
+    static normalizeCommitInfoTokens(commitInfo) {
+        const now = new Date();
+        const authorTime = moment.unix(commitInfo.author.timestamp);
+        const committerTime = moment.unix(commitInfo.committer.timestamp);
+        return {
+            'commit': {
+                'hash': commitInfo.hash,
+                'summary': commitInfo.summary,
+                'filename': commitInfo.filename
+            },
+            'author': commitInfo.author,
+            'committer': commitInfo.committer,
+            'time': {
+                'ago': () => TextDecorator.toDateText(now, authorTime.toDate()),
+                'from': () => authorTime.fromNow(),
+                'custom': (momentFormat) => authorTime.format(momentFormat),
+                'c_ago': () => TextDecorator.toDateText(now, committerTime.toDate()),
+                'c_from': () => committerTime.fromNow(),
+                'c_custom': (momentFormat) => committerTime.format(momentFormat)
+            }
+        }
+    }
 }

test/extension.test.ts

@@ -30,19 +30,25 @@ suite('GitBlame Tests', () => {
             'replace-word': () => 'replaced'
         }));
         assert.equal('Function value tested', TextDecorator.parseTokens('Function value ${replace,test}', {
-            'replace': (key, value) => value + 'ed'
+            'replace': (value) => value + 'ed'
         }));
         assert.equal('Multiple mixed replacers', TextDecorator.parseTokens('Multiple ${type} ${what,replacer}', {
             'type': 'mixed',
-            'what': (key, value) => value + 's'
+            'what': (value) => value + 's'
         }));
-        assert.equal('Should set to key if array', TextDecorator.parseTokens('Should set to key if ${array}', {
-            'array': []
+        assert.equal('Multiple of the same replacer should yield the same result', TextDecorator.parseTokens('Multiple of the ${replace} replacer should yield the ${replace} result', {
+            'replace': 'same'
+        }));
+        assert.equal('Should set to key if non-valid-value', TextDecorator.parseTokens('Should set to key if ${non-valid-value}', {
+            'non-valid-value': []
         }));
         assert.equal('Uses path', TextDecorator.parseTokens('Uses ${climb.down}', {
             'climb': {
                 'down': 'path'
             }
         }));
+        assert.equal('😃 should 💦 👌💯👌', TextDecorator.parseTokens('😃 should 💦 ${ok,💯}', {
+            'ok': (value) => '👌' + value + '👌'
+        }));
     })
 });