Parser refactor

[gdolle]

Major refactoring for the parser. Breaking changes (3.1.0 ?)

Changelog

• Fix options bugs (random behaviour between book.json and local command, ace plugin does not support quotes in command options)
• Add Url support #42 (sync http request using sync-request modules + check url valid-url)
• Refactor options using immutable maps (more robust). It makes easier future new options, see src/options.js
• Support real types (not retrocompatible for book options). For example edit:true instead of edit:"true", to be more consistent (this fix an ace plugin bug).
• Add parser checks for types.
• Add different warn level.
• template, fixlang, lang, theme are now also local/global options. We can set a template per code, a theme per code, etc.. or globally.
• Refactor test for these last changes.
• Add new tests for URL
• End support of lang-typescript to use uniform options lang:"typescript" to be consistent with other options and to simplify functions.
• Support multiple snippet codes. Now we can do [import:"tag0,tag1,..."](fixtures/test.js) to import several snippets into one codeblock , for example

  //! [tag0]
  int a;
  //! [tag0]
  // A comment or a code
  //! [tag1]
  int b;
  //! [tag1]

  will produce

  int a;
  int b;

It should work far better with this PR :)

I've been noticed that ace plugin might crash after a page reload in previous version, but I couldn't reproduce that problem. However, these changes fix some bugs and "might" be fix for that behaviour, we will see.

NB: It might be interesting to have a look to async operation in the future to optimize the code.

@azu waiting for your review, you'll have some work ;)

[azu]

Oh, large diff.. I'll look it lator. Can you separate refactor PR and feature PR if possible.

[gdolle]

@azu Actually, features are minors and deeply dependent of the of refactor. It'd be quite difficult to separate now.

Would it be ok to keep it as one PR ?

The related features changes are

• multiple markers (parseVariableFromLabel => change the regex to have several comma ~1line)
• URL parser ( getContent => load url or file ~5lines)
• the 1 tests for each in test-parser.js

(I added comments on file changes to help)

[azu]

@gdolle fmm, I want to separate big PR to smll PRs by following reasons.

Add Url support #42 (sync http request using sync-request modules + check url valid-url)

Sync request is simple solution, but it is not correct solution. Because GitBook support async hook.

• https://toolchain.gitbook.com/plugins/hooks.html

(Not actuall code)

// THIS IS IMAGINE
module.exports = {
    hooks: {
        "page:before": function(page) {
            var options = this.options.pluginsConfig["include-codeblock"];
            var pageDir = path.dirname(page.rawPath);
            var parseResults = parse(page.content, pageDir, options);
            var promises = results.map(result => {
                return requestUrlAndCreateReplaceContent(result).then(newContent => {
                     replaceContent(page, newContent);
                });
            });
            return Promise.all(promises); // GitBook support async by returing promise
        }
    }
};

and

Immutable.js is overlarge for this project. I recommened that use ES2015 Map + Poilyfill insteadof immutable.js.

---

Of course, Welcome to bugfix, but the bugfix should not contains other feature. I hesitate to merge the bugfix PR.

Sorry, slow response.

[gdolle]

Does ES2015 Map guaranty const Map values ?

Actually refactor parser:

1. immutable Map for read only (more robust to my opinion)
2. handle key-val types (boolean, string, number). The "bug fix" is a consequence of the parser refactor (maybe my single comment is error prone) it's not really a feature.

I agree for the url feature, it is from far not perfect. I'll separate it in another PR.

[azu]

(Currently, this project mixed codeing style, We should apply ESLint #39)

[gdolle]

@azu I updated the code.

• Remove immutable: I used object instead of Map and froze object that should be immutable. It should be understandable for future contributors.
• Remove URL feature.

I didn't apply yet Eslint, I'll have a look into that.

[gdolle]

@azu I added eslint config following #39 and fix current code following the convention. I also added a "check" script which test eslint on src/ and test/. This script is executed in travis, therefore we can see if something is not good with respect to the coding style. Let me know if it's ok for you like that. ;)

[gdolle]

Sorry for the late reply. I updated the code relatively to your last review

[azu]

@gdolle Thanks for great work!