honkit 3.6.23 → 3.7.2

package/lib/constants/defaultPlugins.js

@@ -12,9 +12,8 @@ const pkg = require("../../package.json");
  * @return {PluginDependency}
  */
 function createFromDependency(pluginName) {
-    const npmID = pluginDependency_1.default.nameToNpmID(pluginName);
+    const npmID = "gitbook-plugin-" + pluginName;
     const version = pkg.dependencies[npmID];
-    // @ts-expect-error ts-migrate(2339) FIXME: Property 'create' does not exist on type 'Class'.
     return pluginDependency_1.default.create(pluginName, version);
 }
 exports.default = immutable_1.default.List(["highlight", "search", "lunr", "fontsettings", "theme-default"]).map(createFromDependency);

package/lib/json/encodePage.js

@@ -24,6 +24,13 @@ function encodePage(page, summary) {
         if (prevArticle) {
             result.previous = (0, encodeSummaryArticle_1.default)(prevArticle);
         }
+        const articles = article
+            .getArticles()
+            .map((article) => (0, encodeSummaryArticle_1.default)(article))
+            .toJS();
+        if (articles.length > 0) {
+            result.articles = articles;
+        }
     }
     result.content = page.getContent();
     result.dir = page.getDir();

package/lib/json/encodeSummaryArticle.js

@@ -5,13 +5,17 @@
  @param {SummaryArticle}
  @return {Object}
  */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const encodeSummaryArticleWithCache_1 = __importDefault(require("./encodeSummaryArticleWithCache"));
 function encodeSummaryArticle(article, recursive) {
     let articles = undefined;
     if (recursive !== false) {
         articles = article
             .getArticles()
-            .map((article) => encodeSummaryArticle(article))
+            .map((article) => (0, encodeSummaryArticleWithCache_1.default)(article))
             .toJS();
     }
     return {

package/lib/json/encodeSummaryArticleWithCache.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ Encode a SummaryArticle to JSON
+
+ @param {SummaryArticle}
+ @return {Object}
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const lru_map_1 = require("lru_map");
+const LRU_MAP_LIMIT = 1000;
+const articleCacheMap = new lru_map_1.LRUMap(LRU_MAP_LIMIT);
+function encodeSummaryArticleWithCache(article, recursive) {
+    if (articleCacheMap.has(article)) {
+        return articleCacheMap.get(article);
+    }
+    let articles = undefined;
+    if (recursive !== false) {
+        articles = article
+            .getArticles()
+            .map((article) => encodeSummaryArticleWithCache(article))
+            .toJS();
+    }
+    const encodedArticle = {
+        title: article.getTitle(),
+        level: article.getLevel(),
+        depth: article.getDepth(),
+        anchor: article.getAnchor(),
+        url: article.getUrl(),
+        path: article.getPath(),
+        ref: article.getRef(),
+        articles: articles,
+    };
+    articleCacheMap.set(article, encodedArticle);
+    return encodedArticle;
+}
+exports.default = encodeSummaryArticleWithCache;

package/lib/models/__tests__/plugin.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const plugin_1 = __importDefault(require("../plugin"));
+const immutable_1 = __importDefault(require("immutable"));
 describe("Plugin", () => {
     describe("createFromString", () => {
         test("must parse name", () => {
@@ -17,6 +18,29 @@ describe("Plugin", () => {
             expect(plugin.getVersion()).toBe("1.0.0");
         });
     });
+    describe("getNpmId", () => {
+        it("should return package's name", () => {
+            const plugin = new plugin_1.default({
+                name: "testplugin",
+                version: "*",
+                path: "test.js",
+                package: immutable_1.default.fromJS({
+                    name: "testplugin-name"
+                }),
+                content: immutable_1.default.fromJS({
+                    hooks: {
+                        "page:before": function (page) {
+                            return page;
+                        },
+                        page: function (page) {
+                            return page;
+                        }
+                    }
+                })
+            });
+            expect(plugin.getNpmID()).toBe("testplugin-name");
+        });
+    });
     describe("isLoaded", () => {
         test("must return false for empty plugin", () => {
             const plugin = plugin_1.default.createFromString("hello");

package/lib/models/__tests__/summaryArticle.js

@@ -5,6 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const summaryArticle_1 = __importDefault(require("../summaryArticle"));
 const file_1 = __importDefault(require("../file"));
+const encodeSummaryArticleWithCache_1 = __importDefault(require("../../json/encodeSummaryArticleWithCache"));
+const encodeSummaryArticle_1 = __importDefault(require("../../json/encodeSummaryArticle"));
 describe("SummaryArticle", () => {
     describe("createChildLevel", () => {
         test("must create the right level", () => {
@@ -59,4 +61,57 @@ describe("SummaryArticle", () => {
             expect(article.hasAnchor()).toBe(true);
         });
     });
+    describe("withCache", function () {
+        it("encodeSummaryArticle (non cached) should return an object", function () {
+            var article = summaryArticle_1.default.create({
+                ref: "1-1.md",
+            }, "1.1");
+            expect((0, encodeSummaryArticle_1.default)(article)).toBeInstanceOf(Object);
+        });
+        it("encodeSummaryArticleWithCache (cached) should return an object", function () {
+            var article = summaryArticle_1.default.create({
+                ref: "1-1.md",
+            }, "1.1");
+            expect((0, encodeSummaryArticleWithCache_1.default)(article)).toBeInstanceOf(Object);
+        });
+        it("encodeSummaryArticle (non cached) should return different object when pass difference SummaryArticle", function () {
+            var article_1 = summaryArticle_1.default.create({
+                ref: "1-1.md"
+            }, "1.1");
+            var article_2 = summaryArticle_1.default.create({
+                ref: "1-2.md"
+            }, "1.2");
+            expect((0, encodeSummaryArticle_1.default)(article_1)).not.toStrictEqual((0, encodeSummaryArticle_1.default)(article_2));
+        });
+        it("encodeSummaryArticle (non cached) should return same object when pass same SummaryArticle", function () {
+            var article = summaryArticle_1.default.create({
+                ref: "1-1.md"
+            }, "1.1");
+            expect((0, encodeSummaryArticle_1.default)(article)).toStrictEqual((0, encodeSummaryArticle_1.default)(article));
+        });
+        it("encodeSummaryArticleWithCache (cached) should return different object when pass difference SummaryArticle", function () {
+            var article_1 = summaryArticle_1.default.create({
+                ref: "1-1.md"
+            }, "1.1");
+            var article_2 = summaryArticle_1.default.create({
+                ref: "1-2.md"
+            }, "1.2");
+            expect((0, encodeSummaryArticle_1.default)(article_1)).not.toStrictEqual((0, encodeSummaryArticleWithCache_1.default)(article_2));
+        });
+        it("encodeSummaryArticleWithCache (cached) should return same object when pass same SummaryArticle", function () {
+            var article = summaryArticle_1.default.create({
+                ref: "1-1.md"
+            }, "1.1");
+            expect((0, encodeSummaryArticle_1.default)(article)).toStrictEqual((0, encodeSummaryArticle_1.default)(article));
+        });
+        it("encodeSummaryArticle (non cached) and encodeSummaryArticleWithCache (cached) should return same object when pass same SummaryArticle", function () {
+            var article = summaryArticle_1.default.create({
+                ref: "1-1.md",
+                articles: [summaryArticle_1.default.create({
+                        ref: "2-1.md",
+                    }, "2.1")]
+            }, "1.1");
+            expect((0, encodeSummaryArticle_1.default)(article)).toStrictEqual((0, encodeSummaryArticleWithCache_1.default)(article));
+        });
+    });
 });

package/lib/models/plugin.js

@@ -5,7 +5,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const immutable_1 = __importDefault(require("immutable"));
 const templateBlock_1 = __importDefault(require("./templateBlock"));
-const pluginDependency_1 = __importDefault(require("./pluginDependency"));
 const themePrefix_1 = __importDefault(require("../constants/themePrefix"));
 const DEFAULT_VERSION = "*";
 class Plugin extends immutable_1.default.Record({
@@ -46,10 +45,15 @@ class Plugin extends immutable_1.default.Record({
     }
     /**
      * Return the ID on NPM for this plugin
+     * return package.json's name
      * @return {string}
      */
     getNpmID() {
-        return pluginDependency_1.default.nameToNpmID(this.getName());
+        const pkg = this.getPackage().toJS();
+        if ("name" in pkg) {
+            return pkg["name"];
+        }
+        throw new Error(`${this.getName()} plugin's package.json does not have "name" fields.`);
     }
     /**
      * Check if a plugin is loaded
@@ -112,8 +116,8 @@ class Plugin extends immutable_1.default.Record({
     }
     /**
      * Create a plugin from a string
-     * @param {string}
      * @return {Plugin}
+     * @param s
      */
     static createFromString(s) {
         const parts = s.split("@");
@@ -135,5 +139,4 @@ class Plugin extends immutable_1.default.Record({
         });
     }
 }
-Plugin.nameToNpmID = pluginDependency_1.default.nameToNpmID;
 exports.default = Plugin;

package/lib/models/pluginDependency.js

@@ -6,10 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const is_1 = __importDefault(require("is"));
 const semver_1 = __importDefault(require("semver"));
 const immutable_1 = __importDefault(require("immutable"));
-const pluginPrefix_1 = __importDefault(require("../constants/pluginPrefix"));
 const DEFAULT_VERSION = "*";
 /*
- * PluginDependency represents the informations about a plugin
+ * PluginDependency represents the information about a plugin
  * stored in config.plugins
  */
 class PluginDependency extends immutable_1.default.Record({
@@ -43,13 +42,6 @@ class PluginDependency extends immutable_1.default.Record({
         }
         return this.set("enabled", state);
     }
-    /**
-     * Return NPM ID for the dependency
-     * @return {string}
-     */
-    getNpmID() {
-        return PluginDependency.nameToNpmID(this.getName());
-    }
     /**
      * Is the plugin using a git dependency
      * @return {boolean}
@@ -59,7 +51,6 @@ class PluginDependency extends immutable_1.default.Record({
     }
     /**
      * Create a plugin with a name and a plugin
-     * @param {string}
      * @return {Plugin|undefined}
      */
     static create(name, version, enabled) {
@@ -180,13 +171,5 @@ class PluginDependency extends immutable_1.default.Record({
         })
             .toJS();
     }
-    /**
-     * Return NPM id for a plugin name
-     * @param {string}
-     * @return {string}
-     */
-    static nameToNpmID(s) {
-        return pluginPrefix_1.default + s;
-    }
 }
 exports.default = PluginDependency;

package/lib/modifiers/config/addPlugin.js

@@ -19,7 +19,6 @@ function addPlugin(config, pluginName, version) {
         return (0, togglePlugin_1.default)(config, pluginName, true);
     }
     let deps = config.getPluginDependencies();
-    // @ts-expect-error ts-migrate(2339) FIXME: Property 'create' does not exist on type 'Class'.
     const dep = pluginDependency_1.default.create(pluginName, version);
     deps = deps.push(dep);
     return config.setPluginDependencies(deps);

package/lib/output/website/copyPluginAssets.js

@@ -59,8 +59,6 @@ function copyAssets(output, plugin) {
 }
 /**
  Copy resources from a plugin
-
- @param {Plugin}
  @return {Promise}
  */
 function copyResources(output, plugin) {

package/lib/output/website/createTemplateEngine.js

@@ -37,7 +37,6 @@ function templateFolder(dir) {
 function createTemplateEngine(output, currentFile) {
     const book = output.getBook();
     const state = output.getState();
-    // @ts-expect-error: state type
     const i18n = state.getI18n();
     const config = book.getConfig();
     const summary = book.getSummary();

package/lib/plugins/listResources.js

@@ -9,9 +9,6 @@ const location_1 = __importDefault(require("../utils/location"));
 const pluginResources_1 = __importDefault(require("../constants/pluginResources"));
 /**
  List all resources from a list of plugins
-
- @param {OrderedMap<String:Plugin>}
- @param {string} type
  @return {Map<String:List<{url, path}>}
  */
 function listResources(plugins, resources) {

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "honkit",
-  "version": "3.6.23",
+  "version": "3.7.2",
   "description": "HonKit is building beautiful books using Markdown.",
   "keywords": [
     "git",
+    "markdown",
     "book",
     "honkit",
     "gitbook"
@@ -80,6 +81,7 @@
     "json-schema-defaults": "^0.1.1",
     "jsonschema": "1.1.0",
     "juice": "^6.0.0",
+    "lru_map": "^0.4.1",
     "memoize-one": "^5.1.1",
     "mkdirp": "^1.0.4",
     "moment": "^2.24.0",
@@ -107,5 +109,5 @@
     "rimraf": "^3.0.2",
     "typescript": "^4.1.3"
   },
-  "gitHead": "d0598737355bdcebc5c472e7a59e53ec2272a402"
+  "gitHead": "89e4ff9d86596d7c650c5e83e2d768435d6eef20"
 }

package/lib/plugins/__tests__/findInstalled.js

@@ -1,25 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const immutable_1 = __importDefault(require("immutable"));
-const findInstalled_1 = __importDefault(require("../findInstalled"));
-describe("findInstalled", () => {
-    test.skip("must list default plugins for gitbook directory", () => {
-        // Read gitbook-plugins from package.json
-        const pkg = require(path_1.default.resolve(__dirname, "../../../package.json"));
-        const gitbookPlugins = immutable_1.default.Seq(pkg.dependencies)
-            .filter((v, k) => {
-            return k.indexOf("gitbook-plugin") === 0;
-        })
-            // @ts-expect-error
-            .cacheResult();
-        return (0, findInstalled_1.default)(path_1.default.resolve(__dirname, "../../../")).then((plugins) => {
-            expect(plugins.size >= gitbookPlugins.size).toBeTruthy();
-            expect(plugins.has("fontsettings")).toBe(true);
-            expect(plugins.has("search")).toBe(true);
-        });
-    });
-});

package/lib/plugins/findInstalled.js

@@ -1,87 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const read_installed_1 = __importDefault(require("read-installed"));
-const immutable_1 = __importDefault(require("immutable"));
-const path_1 = __importDefault(require("path"));
-const promise_1 = __importDefault(require("../utils/promise"));
-const fs_1 = __importDefault(require("../utils/fs"));
-const plugin_1 = __importDefault(require("../models/plugin"));
-const pluginPrefix_1 = __importDefault(require("../constants/pluginPrefix"));
-/**
- * Validate if a package name is a GitBook/HonKit plugin
- *
- * @return {boolean}
- */
-function validateId(name) {
-    return name && name.indexOf(pluginPrefix_1.default) === 0;
-}
-/**
- * List all packages installed inside a folder
- *
- * @param {string} folder
- * @return {OrderedMap<String:Plugin>}
- */
-function findInstalled(folder) {
-    const options = {
-        dev: false,
-        log: function () { },
-        depth: 4,
-    };
-    let results = immutable_1.default.OrderedMap();
-    function onPackage(pkg, parent) {
-        if (!pkg.name)
-            return;
-        const name = pkg.name;
-        const version = pkg.version;
-        const pkgPath = pkg.realPath;
-        const depth = pkg.depth;
-        const dependencies = pkg.dependencies;
-        const pluginName = name.slice(pluginPrefix_1.default.length);
-        if (!validateId(name)) {
-            if (parent)
-                return;
-        }
-        else {
-            results = results.set(pluginName, new plugin_1.default({
-                name: pluginName,
-                version: version,
-                path: pkgPath,
-                depth: depth,
-                parent: parent,
-            }));
-        }
-        immutable_1.default.Map(dependencies).forEach((dep) => {
-            onPackage(dep, pluginName);
-        });
-    }
-    // Search for gitbook-plugins in node_modules folder
-    const node_modules = path_1.default.join(folder, "node_modules");
-    // List all folders in node_modules
-    return fs_1.default
-        .readdir(node_modules)
-        .fail(() => {
-        return (0, promise_1.default)([]);
-    })
-        .then((modules) => {
-        return promise_1.default.serie(modules, (module) => {
-            // Not a gitbook-plugin
-            if (!validateId(module)) {
-                return (0, promise_1.default)();
-            }
-            // Read gitbook-plugin package details
-            const module_folder = path_1.default.join(node_modules, module);
-            return promise_1.default.nfcall(read_installed_1.default, module_folder, options).then((data) => {
-                // @ts-expect-error ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
-                onPackage(data);
-            });
-        });
-    })
-        .then(() => {
-        // Return installed plugins
-        return results;
-    });
-}
-exports.default = findInstalled;