Update Book

Author: azu

README.md

@@ -10,7 +10,26 @@ Install with [npm](https://www.npmjs.com/):
 
 ## Usage
 
-- [ ] Write usage instructions
+You should set `repo` in your `book.json`.
+
+`book.json`
+
+- `repo`: `owner/name`
+
+```json
+{
+    "gitbook": ">=3.0.0",
+    "title": "Example",
+    "plugins": [
+        "github-issue-feedback"
+    ],
+    "pluginsConfig": {
+        "github-issue-feedback": {
+            "repo": "azu/gitbook-plugin-github-issue-feedback"
+        }
+    }
+}
+```
 
 ## Changelog
 

example/README.md

@@ -1,8 +1,67 @@
-# Example
+# gitbook-plugin-github-issue-feedback
 
-## How to Feedback
+GitHub issue feedback for gitbook.
 
-1. Select Text
-2. Press Feedback
+![feeback button](https://monosnap.com/file/h2F1HbP6l58FkJoNXgnLNvD8LBvcbu.png)
 
-Dummy text.
+- Put button to right button
+
+## Install
+
+Install with [npm](https://www.npmjs.com/):
+
+    npm install gitbook-plugin-github-issue-feedback
+
+## Usage
+
+You should set `repo` in your `book.json`.
+
+`book.json`
+
+- `repo`: `owner/name`
+
+```json
+{
+    "gitbook": ">=3.0.0",
+    "title": "Example",
+    "plugins": [
+        "github-issue-feedback"
+    ],
+    "pluginsConfig": {
+        "github-issue-feedback": {
+            "repo": "azu/gitbook-plugin-github-issue-feedback"
+        }
+    }
+}
+```
+
+## Changelog
+
+See [Releases page](https://github.com/azu/gitbook-plugin-github-issue-feedback/releases).
+
+## Running tests
+
+Install devDependencies and Run `npm test`:
+
+    npm i -d && npm test
+
+## Contributing
+
+Pull requests and stars are always welcome.
+
+For bugs and feature requests, [please create an issue](https://github.com/azu/gitbook-plugin-github-issue-feedback/issues).
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request :D
+
+## Author
+
+- [github/azu](https://github.com/azu)
+- [twitter/azu_re](https://twitter.com/azu_re)
+
+## License
+
+MIT © azu

example/book.js

@@ -7,9 +7,7 @@ module.exports = {
     ],
     "pluginsConfig": {
         "github-issue-feedback": {
-            "newIssueURL": "https://github.com/asciidwango/js-primer/issues/new",
-            "markdownBaseURL": "https://github.com/asciidwango/js-primer/contents",
-            "githubAPIBaseURL": "https://api.github.com/repos/asciidwango/js-primer/blob/master/"
+            "repo": "azu/gitbook-plugin-github-issue-feedback"
         }
     }
 };

package.json

@@ -19,21 +19,32 @@
   },
   "gitbook": {
     "properties": {
+      "repo": {
+        "type": "string",
+        "description": "GitHub repo path. e.g.) asciidwango/js-primer ",
+        "required": true
+      },
       "newIssueURL": {
         "type": "string",
         "description": "GitHub New Issue url e.g.) https://github.com/azu/promises-book/issues/new",
-        "required": true
+        "required": false
       },
       "markdownBaseURL": {
         "type": "string",
         "description": "Base url for resouce e.g.) https://github.com/asciidwango/js-primer/blob/master/",
-        "required": true
+        "required": false
+      },
+      "githubAPIBaseURL": {
+        "type": "string",
+        "description": "GitHub API Base url e.g.) https://api.github.com/repos/asciidwango/js-primer/blob/master/",
+        "required": false
       }
     }
   },
   "scripts": {
     "test": "mocha test/",
-    "build": "browserify src/plugin.js -o assets/plugin.js",
+    "build": "webpack -p",
+    "watch": "webpack --watch",
     "prepublish": "npm run --if-present build"
   },
   "keywords": [

src/plugin.js

@@ -1,45 +1,73 @@
+var path = require("path");
 var BugReporter = require("./BugReporter");
 var findAllPositions = require("position-map-text-to-markdown").findAllPositions;
-var path = require("path");
 
 function quoteText(text) {
     return text.split("\n").map(function(line) {
         return "> " + line;
     }).join("\n");
 }
 
-function getContentAsync(filePath) {
+function getContentAsync(apiURL) {
     // https://github.com/jser/jser.info/edit/gh-pages/data/2015/08/index.json
     // => https://api.github.com/repos/jser/jser.info/contents/data/2015/08/index.json
-    var apiPath = filePath.replace("github.com/", "api.github.com/repos/");
-    return fetch(apiPath).then(function(response) {
+    return fetch(apiURL).then(function(response) {
         return response.json();
     }).then(function(response) {
         return decodeURIComponent(escape(atob(response.content)));
     });
 }
+
+function getResourceURL(config, filePath, branch) {
+    if (config["markdownBaseURL"]) {
+        return path.join(config["markdownBaseURL"], filePath);
+    }
+    return `https://github.com/${config.repo}/blob/${branch}/${filePath}`
+}
+
+function getEditURL(config, filePath, branch) {
+    return `https://github.com/${config.repo}/edit/${branch}/${filePath}`
+}
+function getAPIURL(config, filePath) {
+    if (config["githubAPIBaseURL"]) {
+        return path.join(config["githubAPIBaseURL"], filePath);
+    }
+    return `https://api.github.com/repos/${config.repo}/contents/${filePath}`;
+}
+
+function getIssueURL(config) {
+    if (config["newIssueURL"]) {
+        return config["newIssueURL"];
+    }
+    return `https://github.com/${config.repo}/issues/new`
+}
 window.require(["gitbook"], function(gitbook) {
     // plugin config
     gitbook.events.bind("start", function(e, pluginConfig) {
         var config = pluginConfig["github-issue-feedback"];
         var reportElement = document.createElement("button");
-        reportElement.textContent = "BugReport";
+        reportElement.textContent = "Bug Report";
+        reportElement.className = "gitbook-plugin-github-issue-feedback";
         reportElement.setAttribute("style", "position:fixed; right:0;bottom:0;");
         var clickEvent = ("ontouchstart" in window) ? "touchend" : "click";
         reportElement.addEventListener(clickEvent, function(event) {
-            var resourcePath = path.join(config["markdownBaseURL"], gitbook.state.filepath);
-            getContentAsync(resourcePath).then(function(markdown) {
-                var bug = new BugReporter(config["newIssueURL"]);
+            var apiURL = getAPIURL(config, gitbook.state.filepath);
+            var resourceURL = getResourceURL(config, gitbook.state.filepath, "master");
+            var editURL = getEditURL(config, gitbook.state.filepath, "master");
+            getContentAsync(apiURL).then(function(markdown) {
+                var bug = new BugReporter(getIssueURL(config));
                 var selectedText = bug.getSelectedText().trim();
-                let body = 'URL : ' + resourcePath + "\n\n";
+                let body = 'URL : ' + resourceURL + "\n\n";
                 if (selectedText && selectedText.length > 0) {
                     var matches = findAllPositions({
                         text: selectedText,
                         markdown: markdown
                     });
+                    console.log(matches);
                     matches.forEach(function(match) {
-                        body += quoteText(match.markdown) + "\n";
-                        body += resourcePath + "#L" + match.loc.start.line + "\n";
+                        var editLink = `[:memo:](${editURL}#L${match.loc.start.line} "Edit")`;
+                        body += quoteText(match.markdown + "\n" +
+                                `${editLink} <${resourceURL}#L${match.loc.start.line}>`) + "\n";
                     });
                 }
                 bug.setBody(body);

webpack.config.js

@@ -0,0 +1,23 @@
+const webpack = require('webpack');
+const path = require('path');
+module.exports = {
+    entry: "./src/plugin.js",
+
+    output: {
+        filename: 'plugin.js',
+        path: path.resolve(__dirname, 'assets')
+    },
+
+    module: {
+        rules: [
+            {
+                test: /\.js$/,
+                exclude: /node_modules/,
+                loader: 'babel-loader',
+                options: {
+                    presets: ['es2015']
+                }
+            }
+        ]
+    }
+};