guiofsaints · November 1, 2021 18:28 · Jul 11, 2015 · Jul 11, 2015 · Jul 11, 2015 · Jul 11, 2015
diff --git a/2.Example.md b/2.Example.md
@@ -1,4 +1,4 @@
-Here is an example in Javascript:
+Here is an example in Javascript based on a package I'm working on for Atom:
 
 ```js
 var format = '{%n  "commit": "%H",%n  "abbreviated_commit": "%h",%n  "tree": "%T",%n  "abbreviated_tree": "%t",%n  "parent": "%P",%n  "abbreviated_parent": "%p",%n  "refs": "%D",%n  "encoding": "%e",%n  "subject": "%s",%n  "sanitized_subject_line": "%f",%n  "body": "%b",%n  "commit_notes": "%N",%n  "verification_flag": "%G?",%n  "signer": "%GS",%n  "signer_key": "%GK",%n  "author": {%n    "name": "%aN",%n    "email": "%aE",%n    "date": "%aD"%n  },%n  "commiter": {%n    "name": "%cN",%n    "email": "%cE",%n    "date": "%cD"%n  }%n},';

diff --git a/2.Example.md b/2.Example.md
@@ -11,7 +11,7 @@ new BufferedProcess({
         'log',
         '--pretty=format:' + format
     ],
-    stdout: function (output) { commits += output; },
+    stdout: function (chunk) { commits += chunk },
     exit: function (code) {
         if (code === 0) {
             var result = JSON.parse('[' + commits.slice(0, -1) + ']');

diff --git a/1.README.md b/1.README.md
@@ -9,6 +9,7 @@ The only information that aren't fetched are:
 * `%B`: raw body (unwrapped subject and body)
 * `%GG`: raw verification message from GPG for a signed commit
 
----
 
-The format is applied to each line, so once you get all the lines, you need to remove the trailing `,` and wrap them around an Array.
+The format is applied to each line, so once you get all the lines, you need to remove the trailing `,` and wrap them around an Array.
+
+git log pretty format source: http://git-scm.com/docs/pretty-formats
diff --git a/2.Example.md b/2.Example.md
@@ -20,6 +20,4 @@ new BufferedProcess({
         }
     }
 });
-```
-
-git log pretty format source: http://git-scm.com/docs/pretty-formats
+```
diff --git a/_README.md → 1.README.md b/_README.md → 1.README.md
diff --git a/Example.md → 2.Example.md b/Example.md → 2.Example.md
diff --git a/README.md → _README.md b/README.md → _README.md
diff --git a/Example.md b/Example.md
@@ -0,0 +1,25 @@
+Here is an example in Javascript:
+
+```js
+var format = '{%n  "commit": "%H",%n  "abbreviated_commit": "%h",%n  "tree": "%T",%n  "abbreviated_tree": "%t",%n  "parent": "%P",%n  "abbreviated_parent": "%p",%n  "refs": "%D",%n  "encoding": "%e",%n  "subject": "%s",%n  "sanitized_subject_line": "%f",%n  "body": "%b",%n  "commit_notes": "%N",%n  "verification_flag": "%G?",%n  "signer": "%GS",%n  "signer_key": "%GK",%n  "author": {%n    "name": "%aN",%n    "email": "%aE",%n    "date": "%aD"%n  },%n  "commiter": {%n    "name": "%cN",%n    "email": "%cE",%n    "date": "%cD"%n  }%n},';
+
+var commits = [];
+
+new BufferedProcess({
+    command: 'git',
+    args: [
+        'log',
+        '--pretty=format:' + format
+    ],
+    stdout: function (output) { commits += output; },
+    exit: function (code) {
+        if (code === 0) {
+            var result = JSON.parse('[' + commits.slice(0, -1) + ']');
+
+            console.log(result); // valid JSON array
+        }
+    }
+});
+```
+
+git log pretty format source: http://git-scm.com/docs/pretty-formats
diff --git a/README.md b/README.md
@@ -11,28 +11,4 @@ The only information that aren't fetched are:
 
 ---
 
-The format is applied to each line, so once you get all the lines, you need to remove the trailing `,` and wrap them around an Array. For example in Javascript:
-
-```js
-var format = '{%n  "commit": "%H",%n  "abbreviated_commit": "%h",%n  "tree": "%T",%n  "abbreviated_tree": "%t",%n  "parent": "%P",%n  "abbreviated_parent": "%p",%n  "refs": "%D",%n  "encoding": "%e",%n  "subject": "%s",%n  "sanitized_subject_line": "%f",%n  "body": "%b",%n  "commit_notes": "%N",%n  "verification_flag": "%G?",%n  "signer": "%GS",%n  "signer_key": "%GK",%n  "author": {%n    "name": "%aN",%n    "email": "%aE",%n    "date": "%aD"%n  },%n  "commiter": {%n    "name": "%cN",%n    "email": "%cE",%n    "date": "%cD"%n  }%n},';
-
-var commits = [];
-
-new BufferedProcess({
-    command: 'git',
-    args: [
-        'log',
-        '--pretty=format:' + format
-    ],
-    stdout: function (output) { commits += output; },
-    exit: function (code) {
-        if (code === 0) {
-            var result = JSON.parse('[' + commits.slice(0, -1) + ']');
-
-            console.log(result); // valid JSON array
-        }
-    }
-});
-```
-
-git log pretty format source: http://git-scm.com/docs/pretty-formats
+The format is applied to each line, so once you get all the lines, you need to remove the trailing `,` and wrap them around an Array.
diff --git a/README.md b/README.md
@@ -9,6 +9,8 @@ The only information that aren't fetched are:
 * `%B`: raw body (unwrapped subject and body)
 * `%GG`: raw verification message from GPG for a signed commit
 
+---
+
 The format is applied to each line, so once you get all the lines, you need to remove the trailing `,` and wrap them around an Array. For example in Javascript:
 
 ```js

diff --git a/README.md b/README.md
@@ -6,8 +6,8 @@ git log --pretty=format:'{%n  "commit": "%H",%n  "abbreviated_commit": "%h",%n
 
 The only information that aren't fetched are:
 
-* %B: raw body (unwrapped subject and body)
-* %GG: raw verification message from GPG for a signed commit
+* `%B`: raw body (unwrapped subject and body)
+* `%GG`: raw verification message from GPG for a signed commit
 
 The format is applied to each line, so once you get all the lines, you need to remove the trailing `,` and wrap them around an Array. For example in Javascript:
 

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ Get Git log in JSON format
 git log --pretty=format:'{%n  "commit": "%H",%n  "abbreviated_commit": "%h",%n  "tree": "%T",%n  "abbreviated_tree": "%t",%n  "parent": "%P",%n  "abbreviated_parent": "%p",%n  "refs": "%D",%n  "encoding": "%e",%n  "subject": "%s",%n  "sanitized_subject_line": "%f",%n  "body": "%b",%n  "commit_notes": "%N",%n  "verification_flag": "%G?",%n  "signer": "%GS",%n  "signer_key": "%GK",%n  "author": {%n    "name": "%aN",%n    "email": "%aE",%n    "date": "%aD"%n  },%n  "commiter": {%n    "name": "%cN",%n    "email": "%cE",%n    "date": "%cD"%n  }%n},'
 ```
 
-The only information that's aren't fetched are:
+The only information that aren't fetched are:
 
 * %B: raw body (unwrapped subject and body)
 * %GG: raw verification message from GPG for a signed commit

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-Get git log in JSON format
+Get Git log in JSON format
 
 ```shell
 git log --pretty=format:'{%n  "commit": "%H",%n  "abbreviated_commit": "%h",%n  "tree": "%T",%n  "abbreviated_tree": "%t",%n  "parent": "%P",%n  "abbreviated_parent": "%p",%n  "refs": "%D",%n  "encoding": "%e",%n  "subject": "%s",%n  "sanitized_subject_line": "%f",%n  "body": "%b",%n  "commit_notes": "%N",%n  "verification_flag": "%G?",%n  "signer": "%GS",%n  "signer_key": "%GK",%n  "author": {%n    "name": "%aN",%n    "email": "%aE",%n    "date": "%aD"%n  },%n  "commiter": {%n    "name": "%cN",%n    "email": "%cE",%n    "date": "%cD"%n  }%n},'

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-Get an (almost valid) JSON object out of git log
+Get git log in JSON format
 
 ```shell
 git log --pretty=format:'{%n  "commit": "%H",%n  "abbreviated_commit": "%h",%n  "tree": "%T",%n  "abbreviated_tree": "%t",%n  "parent": "%P",%n  "abbreviated_parent": "%p",%n  "refs": "%D",%n  "encoding": "%e",%n  "subject": "%s",%n  "sanitized_subject_line": "%f",%n  "body": "%b",%n  "commit_notes": "%N",%n  "verification_flag": "%G?",%n  "signer": "%GS",%n  "signer_key": "%GK",%n  "author": {%n    "name": "%aN",%n    "email": "%aE",%n    "date": "%aD"%n  },%n  "commiter": {%n    "name": "%cN",%n    "email": "%cE",%n    "date": "%cD"%n  }%n},'

diff --git a/README.md b/README.md
@@ -0,0 +1,36 @@
+Get an (almost valid) JSON object out of git log
+
+```shell
+git log --pretty=format:'{%n  "commit": "%H",%n  "abbreviated_commit": "%h",%n  "tree": "%T",%n  "abbreviated_tree": "%t",%n  "parent": "%P",%n  "abbreviated_parent": "%p",%n  "refs": "%D",%n  "encoding": "%e",%n  "subject": "%s",%n  "sanitized_subject_line": "%f",%n  "body": "%b",%n  "commit_notes": "%N",%n  "verification_flag": "%G?",%n  "signer": "%GS",%n  "signer_key": "%GK",%n  "author": {%n    "name": "%aN",%n    "email": "%aE",%n    "date": "%aD"%n  },%n  "commiter": {%n    "name": "%cN",%n    "email": "%cE",%n    "date": "%cD"%n  }%n},'
+```
+
+The only information that's aren't fetched are:
+
+* %B: raw body (unwrapped subject and body)
+* %GG: raw verification message from GPG for a signed commit
+
+The format is applied to each line, so once you get all the lines, you need to remove the trailing `,` and wrap them around an Array. For example in Javascript:
+
+```js
+var format = '{%n  "commit": "%H",%n  "abbreviated_commit": "%h",%n  "tree": "%T",%n  "abbreviated_tree": "%t",%n  "parent": "%P",%n  "abbreviated_parent": "%p",%n  "refs": "%D",%n  "encoding": "%e",%n  "subject": "%s",%n  "sanitized_subject_line": "%f",%n  "body": "%b",%n  "commit_notes": "%N",%n  "verification_flag": "%G?",%n  "signer": "%GS",%n  "signer_key": "%GK",%n  "author": {%n    "name": "%aN",%n    "email": "%aE",%n    "date": "%aD"%n  },%n  "commiter": {%n    "name": "%cN",%n    "email": "%cE",%n    "date": "%cD"%n  }%n},';
+
+var commits = [];
+
+new BufferedProcess({
+    command: 'git',
+    args: [
+        'log',
+        '--pretty=format:' + format
+    ],
+    stdout: function (output) { commits += output; },
+    exit: function (code) {
+        if (code === 0) {
+            var result = JSON.parse('[' + commits.slice(0, -1) + ']');
+
+            console.log(result); // valid JSON array
+        }
+    }
+});
+```
+
+git log pretty format source: http://git-scm.com/docs/pretty-formats