fix: Check that ace plugin is loaded after include-codeblock (#41)

gdolle · azu · commit 9d2644aad6ee · 2017-01-16T14:46:34.000+09:00
* rename and add new examples per template

* Remove unrequired plugin

Not required in fact.

`gitbook-plugin-ace` is required only if user pass "ace" or "acefull" to the template
option. It is specified in the README.md.

* Update readme

* Add check plugin load order

- Add winston-color for color logs
- produce a warning if gitbook-plugin-ace is not loaded (ace template won't work)
- produce an error if gitbook-plugin-ace is loaded but before include-codeblock

* update log message

* update travis tests

* Fix Readme

* use path package

* separate ace check
diff --git a/.travis.yml b/.travis.yml
@@ -3,4 +3,6 @@ language: node_js
 node_js: "stable"
 script:
 - npm test
-- npm run test:example
+- npm run test:example-default
+- npm run test:example-ace
+- npm run test:example-custom
diff --git a/README.md b/README.md
@@ -56,10 +56,11 @@ Templates let customize the rendered code. Several default templates are availab
 | --- | --- |
 | `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, ... |
+| `ace` | enable ace code rendering (**ace plugin required**) |
+| `acefull` | enable ace code rendering with title, label, id, ... (**ace plugin required**) |
 
-For more template, consult the list in [template/](templates/).
+- :information_source: For ace template, see [Ace section](#ace-plugin)
+- :information_source: 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.
@@ -81,7 +82,23 @@ Any contribution is welcome. Propose your new templates via pull-requests.
 
 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.
+To use ace within include-codeblock, you have to **load the ace plugin after include-codeblock!**
+and choose an ace temple (see [template/](templates/))
+
+```js
+{
+    "gitbook": "3.x.x",
+    "plugins" : [
+        "include-codeblock",
+        "ace"
+    ]
+    "pluginsConfig": {
+        "include-codeblock": {
+            "template": "ace", // or acefull
+        }
+    }
+}
+```
 
 ## Usage
 
diff --git a/examples/ace/README.md b/examples/ace/README.md
diff --git a/examples/ace/SUMMARY.md b/examples/ace/SUMMARY.md
diff --git a/examples/ace/book.js b/examples/ace/book.js
@@ -0,0 +1,14 @@
+const fs = require("fs");
+module.exports = {
+    "gitbook": "3.x.x",
+    "title": "gitbook-plugin-include-codeblock example-ace",
+    "plugins": [
+        "include-codeblock",
+        "ace"
+    ],
+    "pluginsConfig": {
+        "include-codeblock": {
+            "template": "ace"
+        }
+    }
+};
diff --git a/examples/ace/package.json b/examples/ace/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "example",
+  "name": "example-ace",
   "version": "1.0.0",
   "description": "gitbook-plugin-include-codeblock",
   "private": true,
@@ -16,6 +16,6 @@
   "license": "MIT",
   "devDependencies": {
     "gitbook-cli": "^2.1.3",
-    "gitbook-plugin-include-codeblock": "file:.."
+    "gitbook-plugin-include-codeblock": "file:../../"
   }
 }
diff --git a/examples/ace/src/line.js b/examples/ace/src/line.js
diff --git a/examples/ace/src/marker.ts b/examples/ace/src/marker.ts
diff --git a/examples/ace/src/test.js b/examples/ace/src/test.js
diff --git a/examples/ace/src/test.ts b/examples/ace/src/test.ts
diff --git a/examples/ace/test.adoc b/examples/ace/test.adoc
diff --git a/examples/ace/user-template.hbs b/examples/ace/user-template.hbs
diff --git a/examples/custom/README.md b/examples/custom/README.md
@@ -0,0 +1,28 @@
+# Example 
+
+## Usage
+
+    npm install
+    npm start
+    open http://localhost:4000/
+
+## import/include
+
+[import, test.js](./src/test.js)
+
+## Hardcoded class
+
+
+[import, test.ts, lang-typescript](src/test.ts)
+
+### Sliced Code
+
+[import:5-8](src/line.js)
+
+### Snippet code
+
+[import:marker0, lang-typescript](src/marker.ts)
+
+### Custom Title
+
+[import:marker0, title:"Custom Title", lang-typescript](src/marker.ts)
diff --git a/examples/custom/SUMMARY.md b/examples/custom/SUMMARY.md
@@ -0,0 +1,4 @@
+# SUMMARY
+
+- gitbook-plugin-include-codeblock
+- [Asciidoc](./test.adoc)
diff --git a/examples/custom/book.js b/examples/custom/book.js
@@ -1,13 +1,14 @@
+const path = require("path")
 const fs = require("fs");
 module.exports = {
     "gitbook": "3.x.x",
-    "title": "gitbook-plugin-include-codeblock example",
+    "title": "gitbook-plugin-include-codeblock example-custom",
     "plugins": [
         "include-codeblock"
     ],
     "pluginsConfig": {
         "include-codeblock": {
-            "template": __dirname + "/user-template.hbs"
+            "template": path.join(__dirname,"user-template.hbs")
         }
     }
 };
diff --git a/examples/custom/package.json b/examples/custom/package.json
@@ -0,0 +1,21 @@
+{
+  "name": "example-custom",
+  "version": "1.0.0",
+  "description": "gitbook-plugin-include-codeblock",
+  "private": true,
+  "scripts": {
+    "prepublish": "gitbook install",
+    "start": "gitbook serve",
+    "build": "gitbook build",
+    "test": "npm rm gitbook-plugin-include-codeblock && npm i && npm run build"
+  },
+  "keywords": [
+    "gitbook"
+  ],
+  "author": "azu",
+  "license": "MIT",
+  "devDependencies": {
+    "gitbook-cli": "^2.1.3",
+    "gitbook-plugin-include-codeblock": "file:../../"
+  }
+}
diff --git a/examples/custom/src/line.js b/examples/custom/src/line.js
@@ -0,0 +1,10 @@
+console.log("this is line 1");
+console.log("this is line 2");
+console.log("this is line 3");
+console.log("this is line 4");
+console.log("this is line 5");
+console.log("this is line 6");
+console.log("this is line 7");
+console.log("this is line 8");
+console.log("this is line 9");
+console.log("this is line 10");
diff --git a/examples/custom/src/marker.ts b/examples/custom/src/marker.ts
@@ -0,0 +1,9 @@
+function test(){
+    //! [marker0]
+    var a;
+    //! [marker1]
+    var b;
+    //! [marker1]
+    var c;
+    //! [marker0]
+}
diff --git a/examples/custom/src/test.js b/examples/custom/src/test.js
@@ -0,0 +1 @@
+console.log("test");
diff --git a/examples/custom/src/test.ts b/examples/custom/src/test.ts
@@ -0,0 +1 @@
+console.log("test");
diff --git a/examples/custom/test.adoc b/examples/custom/test.adoc
@@ -0,0 +1,35 @@
+# Example
+
+## Usage
+
+    npm install
+    npm start
+    open http://localhost:4000/
+
+## import/include
+
+[import, test.js](./src/test.js)
+
+## Hardcoded class
+
+
+[import, test.ts, lang-typescript](src/test.ts)
+
+### Sliced Code
+
+[import:5-8](src/line.js)
+
+### Snippet code
+
+[import:marker0, lang-typescript](src/marker.ts)
+
+
+{% if file.type=="asciidoc" %}
+> link:test.js[test.js]
+{% else %}
+> <a id="test.js" href="test.js">test.js</a>
+{% endif %}
+
+``` javascript
+console.log("test");
+```
diff --git a/examples/custom/user-template.hbs b/examples/custom/user-template.hbs
@@ -0,0 +1,5 @@
+> <a id="{{{id}}}" href="{{originalPath}}">{{fileName}}</a>
+
+``` {{lang}}
+{{{content}}}
+```
diff --git a/examples/default/README.md b/examples/default/README.md
@@ -0,0 +1,28 @@
+# Example 
+
+## Usage
+
+    npm install
+    npm start
+    open http://localhost:4000/
+
+## import/include
+
+[import, test.js](./src/test.js)
+
+## Hardcoded class
+
+
+[import, test.ts, lang-typescript](src/test.ts)
+
+### Sliced Code
+
+[import:5-8](src/line.js)
+
+### Snippet code
+
+[import:marker0, lang-typescript](src/marker.ts)
+
+### Custom Title
+
+[import:marker0, title:"Custom Title", lang-typescript](src/marker.ts)
diff --git a/examples/default/SUMMARY.md b/examples/default/SUMMARY.md
@@ -0,0 +1,4 @@
+# SUMMARY
+
+- gitbook-plugin-include-codeblock
+- [Asciidoc](./test.adoc)
diff --git a/examples/default/book.js b/examples/default/book.js
@@ -0,0 +1,8 @@
+const fs = require("fs");
+module.exports = {
+    "gitbook": "3.x.x",
+    "title": "gitbook-plugin-include-codeblock example-default",
+    "plugins": [
+        "include-codeblock"
+    ]
+};
diff --git a/examples/default/package.json b/examples/default/package.json
@@ -0,0 +1,21 @@
+{
+  "name": "example-default",
+  "version": "1.0.0",
+  "description": "gitbook-plugin-include-codeblock",
+  "private": true,
+  "scripts": {
+    "prepublish": "gitbook install",
+    "start": "gitbook serve",
+    "build": "gitbook build",
+    "test": "npm rm gitbook-plugin-include-codeblock && npm i && npm run build"
+  },
+  "keywords": [
+    "gitbook"
+  ],
+  "author": "azu",
+  "license": "MIT",
+  "devDependencies": {
+    "gitbook-cli": "^2.1.3",
+    "gitbook-plugin-include-codeblock": "file:../../"
+  }
+}
diff --git a/examples/default/src/line.js b/examples/default/src/line.js
@@ -0,0 +1,10 @@
+console.log("this is line 1");
+console.log("this is line 2");
+console.log("this is line 3");
+console.log("this is line 4");
+console.log("this is line 5");
+console.log("this is line 6");
+console.log("this is line 7");
+console.log("this is line 8");
+console.log("this is line 9");
+console.log("this is line 10");
diff --git a/examples/default/src/marker.ts b/examples/default/src/marker.ts
@@ -0,0 +1,9 @@
+function test(){
+    //! [marker0]
+    var a;
+    //! [marker1]
+    var b;
+    //! [marker1]
+    var c;
+    //! [marker0]
+}
diff --git a/examples/default/src/test.js b/examples/default/src/test.js
@@ -0,0 +1 @@
+console.log("test");
diff --git a/examples/default/src/test.ts b/examples/default/src/test.ts
@@ -0,0 +1 @@
+console.log("test");
diff --git a/examples/default/test.adoc b/examples/default/test.adoc
@@ -0,0 +1,35 @@
+# Example
+
+## Usage
+
+    npm install
+    npm start
+    open http://localhost:4000/
+
+## import/include
+
+[import, test.js](./src/test.js)
+
+## Hardcoded class
+
+
+[import, test.ts, lang-typescript](src/test.ts)
+
+### Sliced Code
+
+[import:5-8](src/line.js)
+
+### Snippet code
+
+[import:marker0, lang-typescript](src/marker.ts)
+
+
+{% if file.type=="asciidoc" %}
+> link:test.js[test.js]
+{% else %}
+> <a id="test.js" href="test.js">test.js</a>
+{% endif %}
+
+``` javascript
+console.log("test");
+```
diff --git a/package.json b/package.json
@@ -27,7 +27,9 @@
     "watch": "babel src --out-dir lib --watch --source-maps",
     "prepublish": "npm run --if-present build",
     "test": "mocha",
-    "test:example": "cd example && npm i && npm run build"
+    "test:example-default": "cd examples/default && npm i && npm run build",
+    "test:example-ace": "cd examples/ace && npm i && npm run build",
+    "test:example-custom": "cd examples/custom && npm i && npm run build"
   },
   "keywords": [
     "gitbook",
@@ -74,7 +76,7 @@
   "dependencies": {
     "language-map": "^1.1.1",
     "handlebars": "^4.0.5",
-    "ace": "^0.3.2"
+    "winston-color": "^1.0.0"
   },
   "devDependencies": {
     "babel-cli": "^6.7.7",
diff --git a/src/ace-check.js b/src/ace-check.js
@@ -0,0 +1,20 @@
+var logger = require('winston-color');
+// Check that ace plugin is loaded after include-codeblock
+export function aceCheck() {
+    // Check ace is used.
+    try {
+        require.resolve("gitbook-plugin-ace");
+
+        // Check is not currently loaded.
+        const aceLoaded = !! require('module')._cache[require.resolve('gitbook-plugin-ace')];
+        if(aceLoaded) {
+            console.log(""); // flush
+            logger.error("`gitbook-plugin-include-codeblock` plugin must be loaded before `gitbook-plugin-ace`!");
+            process.exit(1);
+        }
+    } catch(e) {
+        console.log(""); // flush
+        logger.warn("ace features disabled (`gitbook-plugin-ace` required)");
+
+    }
+}
diff --git a/src/include-codeblock.js b/src/include-codeblock.js

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "example",`
	`2`	`+ "name": "example-ace",`
`3`	`3`	`"version": "1.0.0",`
`4`	`4`	`"description": "gitbook-plugin-include-codeblock",`
`5`	`5`	`"private": true,`
`@@ -16,6 +16,6 @@`
`16`	`16`	`"license": "MIT",`
`17`	`17`	`"devDependencies": {`
`18`	`18`	`"gitbook-cli": "^2.1.3",`
`19`		`- "gitbook-plugin-include-codeblock": "file:.."`
	`19`	`+ "gitbook-plugin-include-codeblock": "file:../../"`
`20`	`20`	`}`
`21`	`21`	`}`