Merge pull request #38 from gdolle/plugin-ace-support

Plugin ace support

Author: azu

README.md

@@ -22,37 +22,66 @@ gitbook install
 
 ## Options
 
-You can put your template into `book.js`(`book.json`) by `template` option.
+Several options can be set in `book.json` to customize the plugin.
+
+| option | value | Description |
+| --- | --- | --- |
+| `template` | `{default,full,ace,...}` or custom path | reindent code if marker or slice is used |
+| `unindent` | `{true,false}` | reindent code if marker or slice is used |
+| `edit` | `{true,false}` | [allow edit code](https://github.com/ymcatar/gitbook-plugin-ace/blob/master/README.md) (**ace template required**) |
+| `check` | `{true,false}` | [syntax validation](https://github.com/ymcatar/gitbook-plugin-ace/blob/master/README.md) (**ace template required**) |
+| `theme` | `{monokai,coffee,...}` | [check syntax](https://github.com/ymcatar/gitbook-plugin-ace/blob/master/README.md) (**ace template required**) |
+| `fixlang` | {true,false} | fix some errors with code lang (e.g C++, ...) |
+
+Just add the desired optin under `pluginConfig` in the `book.json` file
 
 ```js
-const fs = require("fs");
-module.exports = {
+{
     "gitbook": "3.x.x",
-    "title": "gitbook-plugin-include-codeblock example",
-    "plugins": [
-        "include-codeblock"
-    ],
     "pluginsConfig": {
         "include-codeblock": {
-            "template": fs.readFileSync(__dirname + "/user-template.hbs", "utf-8")
+            "template": "ace",
+            "unindent": "true",
+            "theme": "monokai"
         }
     }
-};
+}
 ```
 
-See [template/](template/) and [example/](example/) for details.
+### Templates
 
-You can also unindent the included text by specifying the `unindent` option:
+Templates let customize the rendered code. Several default templates are available
 
+| template | description |
+| --- | --- |
+| `default` | default template, standard markdown code style |
+| `full` | enable title, labeling, id, ... |
+| `ace` | enable ace code rendering |
+| `acefull` | enable ace code rendering with title, label, id, ... |
+
+For more template, consult the list in [template/](templates/).
+
+Custom templates can be created to render the code by specifying a custom path
+to the template file.
 ```js
-"pluginsConfig": {
-    "include-codeblock": {
-        "unindent": true
+{
+    "gitbook": "3.x.x",
+    "pluginsConfig": {
+        "include-codeblock": {
+            "template": __dirname + "/" + "path/to/custom.hbs",
+        }
     }
 }
 ```
+See [template/](templates/) and [example/](example/) for details.
+
+Any contribution is welcome. Propose your new templates via pull-requests.
 
-Alternatively, unindent can be specified on a per-tag basis (see below)
+### Ace plugin
+
+It is possible to use the gitbook ace plugin to have code numbering or custom themes
+(See [gitbook-ace-plugin](https://github.com/ymcatar/gitbook-plugin-ace) for more details).
+To use ace within include-codeblock, an "ace" template is required.
 
 ## Usage
 
@@ -74,9 +103,27 @@ or
 ```
 Result
 
-    ``` js
-    console.log("test");
-    ```
+``` js
+console.log("test");
+```
+
+### Local options
+
+Option can be passed locally and may depend on the template your are using.
+
+| option | value | Description |
+| --- | --- | --- |
+| `unindent` | `{"true","false"}` | reindent code if marker or slice is used |
+| `title`| `"<your title>"` | Title for the code **full template required**|
+| `filename` | `"<your_filename>"` | name of the included file  **full template required** |
+| `originalPath` | `"</path/to/file/>"` | name of the included file  **full template required** |
+| `id` | `"<your_id>"` | hmlt class for custom style **full template required** |
+| `label` | `"<your_ref_label>"` | reference label (latex like) **full template required** |
+| `edit` | `{"true","false"}` | allow edit code (**ace template required**) |
+| `check` | `{"true","false"}` | check syntax (**ace template required**) |
+| `theme` | `{"monokai","coffee",...}` | check syntax (**ace template required**) |
+
+For more details see sections below.
 
 <!--
 ### Title(from v)
@@ -127,6 +174,7 @@ e.g.) typescript's aceMode value is `typescript`.
 
 - https://github.com/blakeembrey/language-map/blob/b72edb8c2cb1b05d098782aa85dd2f573ed96ba3/languages.json#L4140
 
+
 ### Sliced Code
 
 If you want to slice imported code and show.

example/book.js

@@ -7,7 +7,7 @@ module.exports = {
     ],
     "pluginsConfig": {
         "include-codeblock": {
-            "template": fs.readFileSync(__dirname + "/user-template.hbs", "utf-8")
+            "template": __dirname + "/user-template.hbs"
         }
     }
-};
+};

package.json

@@ -16,7 +16,7 @@
   "main": "lib/include-codeblock.js",
   "files": [
     "lib",
-    "template",
+    "templates",
     "src"
   ],
   "directories": {
@@ -43,12 +43,38 @@
         "type": "string",
         "description": "Template string",
         "required": false
+      },
+      "unindent": {
+        "type": "string",
+        "description": "undindent inner snippets",
+        "required": false
+      },
+      "edit": {
+        "type": "string",
+        "description": "ace code edition (ace* template required)",
+        "required": false
+      },
+      "check": {
+        "type": "string",
+        "description": "ace syntax validation (ace* template required)",
+        "required": false
+      },
+      "theme": {
+        "type": "string",
+        "description": "ace code editor theme (ace* template required)",
+        "required": false
+      },
+      "fixlang": {
+        "type": "Fix lang label (c++,...)",
+        "description": "",
+        "required": false
       }
     }
   },
   "dependencies": {
     "language-map": "^1.1.1",
-    "handlebars": "^4.0.5"
+    "handlebars": "^4.0.5",
+    "ace": "^0.3.2"
   },
   "devDependencies": {
     "babel-cli": "^6.7.7",

src/language-detection.js

@@ -13,7 +13,7 @@ export function languageAceModeFix(resultAceMode) {
     return resultAceMode;
 }
 
-export function lookupLanguageByAceMode(commands) {
+export function lookupLanguageByAceMode(commands, fixlang=false) {
     let resultAceMode;
     commands.forEach(command => {
         const matchAceModes = /lang\-(.+)/g.exec(command);
@@ -34,12 +34,14 @@ export function lookupLanguageByAceMode(commands) {
         if (resultAceMode === undefined) {
             resultAceMode = matchLang;
         }
-        resultAceMode = languageAceModeFix(resultAceMode);
     });
+    if(fixlang) {
+        resultAceMode = languageAceModeFix(resultAceMode);
+    }
     return resultAceMode;
 }
 
-export function lookupLanguageByExtension(ext) {
+export function lookupLanguageByExtension(ext, fixlang=false) {
     let aceMode;
     Object.keys(language_map).some(langKey => {
         const extensions = language_map[langKey]["extensions"];
@@ -57,15 +59,17 @@ export function lookupLanguageByExtension(ext) {
             }
         });
     });
-    aceMode = languageAceModeFix(aceMode);
+    if(fixlang) {
+        aceMode = languageAceModeFix(aceMode);
+    }
     return aceMode;
 }
 
-export function getLang(commands, filePath) {
+export function getLang(commands, filePath, fixlang=false ) {
     const lang = lookupLanguageByAceMode(commands);
     if (lang) {
         return lang;
     }
     const ext = path.extname(filePath);
-    return lookupLanguageByExtension(ext) || ext;
+    return lookupLanguageByExtension(ext, fixlang) || ext;
 }

src/parser.js

@@ -60,13 +60,18 @@ export function parseVariablesFromLabel(label) {
         "class": undefined,
         "name": undefined,
         "marker": undefined,
-        "unindent": undefined
+        "unindent": undefined,
+        "edit": undefined,
+        "theme": undefined,
+        "check": undefined,
+        "fixlang": undefined
     };
     Object.keys(keyvals).forEach(key => {
         var keyReg = key;
         if (key === "marker") {
             keyReg = "import|include";
         }
+
         const regStr = "\^.*,?\\s*(" + keyReg + ")\\s*:\\s*[\"']([^'\"]*)[\"'],?.*\$";
         const reg = new RegExp(regStr);
         const res = label.match(reg);
@@ -90,6 +95,7 @@ export function embedCode({lang, filePath, originalPath, label, template, uninde
     const code = fs.readFileSync(filePath, "utf-8");
     const fileName = path.basename(filePath);
     const keyValueObject = parseVariablesFromLabel(label);
+
     var content = code;
     // Slice content via line numbers.
     if (hasSliceRange(label)) {
@@ -102,15 +108,15 @@ export function embedCode({lang, filePath, originalPath, label, template, uninde
         content = removeMarkers(markerSliceCode(code, marker));
     }
     if (unindent || keyValueObject.unindent) {
-      content = strip(content)
+      content = strip(content);
     }
     return generateEmbedCode({
         keyValueObject,
         lang,
         fileName,
         originalPath,
         content,
-        template
+        template,
     });
 }
 
@@ -137,7 +143,7 @@ export function generateEmbedCode({
     fileName,
     originalPath,
     content,
-    template
+    template,
 }) {
     const count = hasTitle(keyValueObject) ? codeCounter() : -1;
     // merge objects
@@ -150,11 +156,19 @@ export function generateEmbedCode({
     return handlebars(context);
 }
 
+const templatePath = {
+    default: path.join(__dirname, "..", "templates", "default-template.hbs"),
+    full: path.join(__dirname, "..", "templates", "full-template.hbs"),
+    ace: path.join(__dirname, "..", "templates", "ace-template.hbs"),
+    acefull: path.join(__dirname, "..", "templates", "acefull-template.hbs")
+};
 
 const defaultOptions = {
-    template: fs.readFileSync(path.join(__dirname, "..", "template", "default-template.hbs"), "utf-8"),
-    unindent: false
+    template: "default",
+    unindent: false,
+    fixlang: false
 };
+
 /**
  * generate code with options
  * @param {string} content
@@ -164,14 +178,31 @@ const defaultOptions = {
  */
 export function parse(content, baseDir, options = {}) {
     const results = [];
-    const template = options.template || defaultOptions.template;
+    const isTemplateDefault = (options.template == undefined);
+    const isTemplatePath = (templatePath[options.template] == undefined);
+    let tPath;
+    // No template option.
+    if(isTemplateDefault) {
+        tPath = templatePath[defaultOptions.template];
+    }
+    // Template option is a path.
+    else if (isTemplatePath && fs.existsSync(options.template)) {
+        tPath = options.template;
+    }
+    // Template option one of template/ directory.
+    else {
+        tPath = templatePath[options.template] || templatePath[defaultOptions.template];
+    }
+    const template = fs.readFileSync( tPath, "utf-8");
     const unindent = options.unindent || defaultOptions.unindent;
+    const fixlang = (options.fixlang != undefined) ? options.fixlang : defaultOptions.fixlang;
+
     let res;
     while (res = markdownLinkFormatRegExp.exec(content)) {
         const [all, label, originalPath] = res;
         const commands = splitLabelToCommands(label);
         if (containIncludeCommand(commands)) {
-            const lang = getLang(commands, originalPath);
+            const lang = getLang(commands, originalPath, fixlang );
             const absolutePath = path.resolve(baseDir, originalPath);
             const replacedContent = embedCode({
                 lang,

template/README.md templates/README.mdtemplate/README.md renamed to templates/README.md

@@ -17,6 +17,12 @@
 - `{{id}}`: if label contain `id:` like this `[import, id:<value>]`
 - `{{class}}`: if label contain `class:` like this `[import, class:<value>]`
 
+### ace plugin specific
+
+- {{edit}} : allow code edition
+- {{check}} : allow syntax validation
+- {{theme}} : label for the theme
+
 ## Limitation
 
 You should write with no space(indent).
@@ -68,4 +74,4 @@ to be
 
     ``` rust
     extern crate num;
-    ```
+    ```

templates/ace-template.hbs

@@ -0,0 +1,5 @@
+{% if file.type=="asciidoc" %}++++{% endif %}
+{%ace edit="{{edit}}", check="{{check}}", theme="{{theme}}", lang="{{lang}}" %}
+{{{content}}}
+{%endace%}
+{% if file.type=="asciidoc" %}++++{% endif %}

templates/acefull-template.hbs

@@ -0,0 +1,27 @@
+{{#if title}}
+{{#if id}}
+{% if file.type=="asciidoc" %}
+> [[{{id}}]]link:{{originalPath}}[{{title}}]
+{% else %}
+> <a id="{{id}}" href="{{originalPath}}">{{title}}</a>
+{% endif %}
+{{else}}
+{% if file.type=="asciidoc" %}
+> [[{{title}}]]link:{{originalPath}}[{{title}}]
+{% else %}
+> <a id="{{title}}" href="{{originalPath}}">{{title}}</a>
+{% endif %}
+{{/if}}
+{{else}}
+{% if file.type=="asciidoc" %}
+> [[{{fileName}}]]link:{{originalPath}}[{{fileName}}]
+{% else %}
+> <a id="{{fileName}}" href="{{originalPath}}">{{fileName}}</a>
+{% endif %}
+{{/if}}
+
+{% if file.type=="asciidoc" %}++++{% endif %}
+{%ace edit="{{edit}}", check="{{check}}", theme="{{theme}}", lang="{{lang}}" %}
+{{{content}}}
+{%endace%}
+{% if file.type=="asciidoc" %}++++{% endif %}