init git-author plugin

Author: 瓷松

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[package.json]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1,4 @@
+.idea
+.DS_Store
+npm-debug.log
+node_modules

README.md

@@ -0,0 +1,79 @@
+# gitbook-plugin-git-author
+
+This is a plugin for automatically adding author and timestamp to each gitbook article, including creator and last modified user from git commits
+
+## Example
+
+`README.md` file
+
+Be sure to commit this file to git repository
+
+```markdown
+# Title of the Article
+
+content
+```
+
+### Output
+
+```html
+<h1>Title of the Article</h1>
+
+<p>content</p>
+
+<div class="git-author-container">
+    <div class="modified">Last modified by someone 2016-06-06 06:06:06</div>
+    <div class="created">Created by someone 2016-06-06 06:06:06</div>
+</div>
+```
+
+## Usage
+
+### install
+
+```sh
+npm i -D gitbook-plugin-git-author
+```
+
+### book.json
+
+```js
+{
+    "plugins": ["git-author"]
+    "pluginsConfig": {
+          "git-author":{
+              "modifyTpl": "Last modified by {user} {timeStamp}",
+              "createTpl": "Created by {user} {timeStamp}",
+              "timeStampFormat": "YYYY-MM-DD HH:mm:ss"
+          }
+    }
+}
+```
+
+## hide creator
+
+```
+"createTpl": false
+```
+
+## custom styles
+
+`book.json`
+
+```js
+{
+    "styles": {
+        "website": "./website.css"
+    }
+}
+```
+
+`website.css`
+
+```
+.git-author-container {
+    font-size: 85%;
+}
+```
+
+

assets/style.css

@@ -0,0 +1,3 @@
+.git-author-container  {
+    text-align: right;
+}

index.js

@@ -0,0 +1,80 @@
+'use strict';
+
+const execa = require('execa');
+const moment = require('moment');
+
+function substitute(str, o) {
+    return str.replace(/\\?\{([^{}]+)\}/g, function (match, name) {
+        if (match.charAt(0) === '\\') {
+            return match.slice(1);
+        }
+        return (o[name] === undefined) ? '' : o[name];
+    });
+}
+
+module.exports = {
+    website: {
+        assets: './assets',
+        css: [
+            'style.css'
+        ]
+    },
+
+    hooks: {
+        "page:before": function (page) {
+            const defaults = {
+                createTpl: 'Created by {user} at {timeStamp}',
+                modifyTpl: 'Last modified by {user} at {timeStamp}',
+                timeStampFormat: 'YYYY-MM-DD HH:mm:ss'
+            };
+            const pluginConfig = this.config.get('pluginsConfig')['git-author'];
+            const options = Object.assign({}, defaults, pluginConfig);
+
+            const createTpl = options.createTpl;
+            const modifyTpl = options.modifyTpl;
+            const timeStampFormat = options.timeStampFormat;
+
+            return execa.shell(`git log --format="%an|%at" -- ${page.rawPath}`).then((ret) => {
+                // none commit to this file
+                if (!ret.stdout) {
+                    return page;
+                }
+
+                const commits = ret.stdout.split(/\r?\n/).map((log) => {
+                    const arr = log.split('|').map(r => r.trim());
+                    const timeStamp = moment(arr[1] * 1000).format(timeStampFormat);
+
+                    return {
+                        user: arr[0],
+                        timestamp: timeStamp,
+                        timeStamp: timeStamp
+                    }
+                });
+
+                const lastCommit = commits[0];
+                const firstCommit = commits.slice(-1)[0];
+
+                let gitAuthorContent = '<div class="git-author-container">';
+
+                if (modifyTpl) {
+                    const modifyMsg = substitute(modifyTpl, lastCommit);
+                    gitAuthorContent += `<div class="modified">${modifyMsg}</div>`;
+                }
+
+                if (createTpl) {
+                    const createMsg = substitute(createTpl, firstCommit);
+                    gitAuthorContent += `<div class="created">${createMsg}</div>`;
+                }
+
+                gitAuthorContent += '</div>';
+
+                page.content += gitAuthorContent;
+
+                return page;
+            }).catch((e) => {
+                this.log.info(e);
+                return page;
+            });
+        }
+    }
+};

package.json

@@ -0,0 +1,32 @@
+{
+  "name": "gitbook-plugin-git-author",
+  "description": "show git author for each article of gitbook",
+  "main": "index.js",
+  "version": "0.0.1",
+  "author": "L3au <leshu.lau@gmail.com>",
+  "engines": {
+    "node": ">4.0.0",
+    "gitbook": ">3.0.0"
+  },
+  "keywords": [
+    "gitbook",
+    "plugin",
+    "git",
+    "author",
+    "signature",
+    "modified",
+    "creator"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/L3au/gitbook-plugin-git-author.git"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/L3au/gitbook-plugin-git-author/issues"
+  },
+  "dependencies": {
+    "execa": "^0.4.0",
+    "moment": "^2.13.0"
+  }
+}