refactor: file structure

Author: L3au

Jenkinsfile

@@ -1,21 +1,18 @@
 # gitbook-plugin-git-author
 
-[![Greenkeeper badge](https://badges.greenkeeper.io/L3au/gitbook-plugin-git-author.svg)](https://greenkeeper.io/)
-
-This is a plugin for automatically adding author and timestamp to each gitbook article, including creator and last modified user from git commits
+This is a plugin for automatically adding author and timestamp to each gitbook page, including creator and last-modified from git commits
 
 [![npm](https://img.shields.io/npm/v/gitbook-plugin-git-author.svg)](https://www.npmjs.com/package/gitbook-plugin-git-author)
 [![travis](https://img.shields.io/travis/L3au/gitbook-plugin-git-author.svg)](https://travis-ci.org/L3au/gitbook-plugin-git-author)
 [![codecov](https://codecov.io/gh/L3au/gitbook-plugin-git-author/branch/master/graph/badge.svg)](https://codecov.io/gh/L3au/gitbook-plugin-git-author)
 [![npm-downloads](https://img.shields.io/npm/dm/gitbook-plugin-git-author.svg)](https://www.npmjs.com/package/gitbook-plugin-git-author)
 
-![git-author-preview](https://raw.githubusercontent.com/L3au/gitbook-plugin-git-author/master/preview.png)
+![git-author-preview](https://raw.githubusercontent.com/L3au/gitbook-plugin-git-author/master/src/assets/preview.png)
 
 ## Usage
 
 ### Recommended Environments
 
-
 - Node.js 4.0+
 - npm 3.0+
 - gitbook 3.0+
@@ -62,8 +59,8 @@ content
 <p>content</p>
 
 <div class="git-author-container git-author-bottom">
-    <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 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>
 ```
 
@@ -73,15 +70,15 @@ content
 
 default: `bottom`
 
-git-author content position in the article. `top` or `bottom` 
+git-author content position in the article. `top` or `bottom`
 
 this will add a `git-author-{position}` className to `git-author-container`
 
-### `createTpl`  `modifyTpl`
+### `createTpl` `modifyTpl`
 
 You can use `{user}` `{timeStamp}` as placeholder for username and timeStamp
 
-default: 
+default:
 
 createTpl: `Created by {user} {timeStamp}`
 

README.md

@@ -1,8 +1,8 @@
 {
   "name": "gitbook-plugin-git-author",
-  "description": "show git author for each article of gitbook",
-  "main": "index.js",
   "version": "1.1.3",
+  "description": "A gitbook plugin to show git author info",
+  "main": "src/index.js",
   "author": "L3au <leshu.lau@gmail.com>",
   "engines": {
     "node": ">4.0.0",
@@ -39,15 +39,15 @@
     "url": "https://github.com/L3au/gitbook-plugin-git-author/issues"
   },
   "dependencies": {
-    "execa": "^0.6.3",
-    "moment": "^2.18.1"
+    "execa": "^1.0.0",
+    "moment": "^2.24.0"
   },
   "devDependencies": {
-    "ava": "^0.19.1",
-    "husky": "^0.13.3",
-    "nyc": "^10.2.0",
-    "sinon": "^2.1.0",
-    "xo": "^0.18.1"
+    "ava": "^2.0.0",
+    "husky": "^2.4.0",
+    "nyc": "^14.1.1",
+    "sinon": "^7.3.2",
+    "xo": "^0.24.0"
   },
   "xo": {
     "space": true,

index.js

@@ -0,0 +1,99 @@
+'use strict'
+
+const execa = require('execa')
+const moment = require('moment')
+
+function substitute(str, o) {
+  return str.replace(/\\?\{([^{}]+)\}/g, (match, name) => {
+    if (match.charAt(0) === '\\') {
+      return match.slice(1)
+    }
+
+    return o[name] === undefined ? '' : o[name]
+  })
+}
+
+module.exports = {
+  website: {
+    assets: './assets',
+    css: ['style.css']
+  },
+
+  filters: {
+    timeFormat(time, format) {
+      return moment(time).format(format || moment.defaultFormat)
+    }
+  },
+
+  hooks: {
+    page(page) {
+      const defaults = {
+        position: 'bottom',
+        createTpl: 'Created by {user} at {timeStamp}',
+        modifyTpl: 'Last modified by {user} at {timeStamp}',
+        timeStampFormat: 'YYYY-MM-DD HH:mm:ss'
+      }
+      const bookRoot = this.resolve('')
+      const pluginConfig = this.config.get('pluginsConfig')['git-author']
+      const options = Object.assign({}, defaults, pluginConfig)
+
+      const {position} = options
+      const {createTpl} = options
+      const {modifyTpl} = options
+      const {timeStampFormat} = options
+
+      return execa
+        .shell(`git log --format="%an|%at" -- "${page.rawPath}"`, {
+          cwd: bookRoot
+        })
+        .then(ret => {
+          // None commit to this file
+          if (!ret.stdout) {
+            this.log.debug(`none commit to file ${page.path}`)
+            return page
+          }
+
+          const commits = ret.stdout.split(/\r?\n/).map(log => {
+            const arr = log.split('|')
+            const timeStamp = moment(arr[1] * 1000).format(timeStampFormat)
+
+            return {
+              user: arr[0],
+              timestamp: timeStamp,
+              timeStamp
+            }
+          })
+
+          const lastCommit = commits[0]
+          const firstCommit = commits.slice(-1)[0]
+
+          let gitAuthorContent = `<div class="git-author-container git-author-${position}">`
+
+          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>'
+
+          if (position === 'top') {
+            page.content = gitAuthorContent + page.content
+          } else {
+            page.content += gitAuthorContent
+          }
+
+          return page
+        })
+        .catch(error => {
+          this.log.warn('initialize git repository and commit files firstly')
+          this.log.warn(error)
+          return page
+        })
+    }
+  }
+}

package.json

@@ -3,7 +3,7 @@
 const test = require('ava')
 const execa = require('execa')
 const sinon = require('sinon')
-const plugin = require('./')
+const plugin = require('../src')
 
 test('gitbook plugin structure', t => {
   t.deepEqual(Object.keys(plugin), ['website', 'filters', 'hooks'])