honkit 3.6.21

package/lib/modifiers/summary/unshiftArticle.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const summaryArticle_1 = __importDefault(require("../../models/summaryArticle"));
+const summaryPart_1 = __importDefault(require("../../models/summaryPart"));
+const indexLevels_1 = __importDefault(require("./indexLevels"));
+/**
+ Insert an article at the beginning of summary
+
+ @param {Summary} summary
+ @param {Article} article
+ @return {Summary}
+ */
+function unshiftArticle(summary, article) {
+    article = new summaryArticle_1.default(article);
+    let parts = summary.getParts();
+    let part = parts.get(0) || new summaryPart_1.default();
+    let articles = part.getArticles();
+    articles = articles.unshift(article);
+    part = part.set("articles", articles);
+    parts = parts.set(0, part);
+    summary = summary.set("parts", parts);
+    return indexLevels_1.default(summary);
+}
+exports.default = unshiftArticle;

package/lib/output/__tests__/ebook.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const generateMock_1 = __importDefault(require("../testing/generateMock"));
+const ebook_1 = __importDefault(require("../ebook"));
+describe("EbookGenerator", () => {
+    test("should generate a SUMMARY.html", () => {
+        return generateMock_1.default(ebook_1.default, {
+            "README.md": "Hello World"
+        }).then((folder) => {
+            expect(folder).toHaveFile("SUMMARY.html");
+            expect(folder).toHaveFile("index.html");
+        });
+    });
+});

package/lib/output/__tests__/json.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const generateMock_1 = __importDefault(require("../testing/generateMock"));
+const json_1 = __importDefault(require("../json"));
+describe("JSONGenerator", () => {
+    test("should generate a README.json", () => {
+        return generateMock_1.default(json_1.default, {
+            "README.md": "Hello World"
+        }).then((folder) => {
+            expect(folder).toHaveFile("README.json");
+        });
+    });
+    test("should generate a json file for each articles", () => {
+        return generateMock_1.default(json_1.default, {
+            "README.md": "Hello World",
+            "SUMMARY.md": "# Summary\n\n* [Page](test/page.md)",
+            test: {
+                "page.md": "Hello 2"
+            }
+        }).then((folder) => {
+            expect(folder).toHaveFile("README.json");
+            expect(folder).toHaveFile("test/page.json");
+        });
+    });
+    test("should generate a multilingual book", () => {
+        return generateMock_1.default(json_1.default, {
+            "LANGS.md": "# Languages\n\n* [en](en)\n* [fr](fr)",
+            en: {
+                "README.md": "Hello"
+            },
+            fr: {
+                "README.md": "Bonjour"
+            }
+        }).then((folder) => {
+            expect(folder).toHaveFile("en/README.json");
+            expect(folder).toHaveFile("fr/README.json");
+            expect(folder).toHaveFile("README.json");
+        });
+    });
+});

package/lib/output/__tests__/plugin-hooks.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert_1 = __importDefault(require("assert"));
+const generateMock_1 = require("../testing/generateMock");
+const immutable_1 = __importDefault(require("immutable"));
+const generatePages_1 = __importDefault(require("../generatePages"));
+const plugin_1 = __importDefault(require("../../models/plugin"));
+const json_1 = __importDefault(require("../json"));
+const createOutputWithPlugin = async ({ Generator, plugin, files }) => {
+    const { output } = await generateMock_1.generateMockBook(Generator, files);
+    // add plugin
+    return output.merge({
+        plugins: [plugin],
+    });
+};
+describe("plugin-hooks", function () {
+    it(`should be called "page" and "page:before" when generate each pages`, async () => {
+        let onPageBeforeCount = 0;
+        let onPageCount = 0;
+        const plugin = new plugin_1.default({
+            name: "testplugin",
+            version: "*",
+            path: "test.js",
+            package: immutable_1.default.fromJS({
+                name: "testplugin",
+            }),
+            content: immutable_1.default.fromJS({
+                hooks: {
+                    "page:before": function (page) {
+                        onPageBeforeCount++;
+                        return page;
+                    },
+                    page: function (page) {
+                        onPageCount++;
+                        return page;
+                    },
+                },
+            }),
+        });
+        const output = await createOutputWithPlugin({
+            Generator: json_1.default,
+            plugin,
+            files: {
+                "README.md": "Hello World",
+            },
+        });
+        // call twice
+        await generatePages_1.default(json_1.default, output);
+        await generatePages_1.default(json_1.default, output);
+        // assert
+        assert_1.default.strictEqual(onPageBeforeCount, 2);
+        assert_1.default.strictEqual(onPageCount, 2);
+    });
+});

package/lib/output/__tests__/website.js

@@ -0,0 +1,121 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const generateMock_1 = __importDefault(require("../testing/generateMock"));
+const website_1 = __importDefault(require("../website"));
+const longTest = (name, fn) => test(name, fn, 1000 * 30);
+describe("WebsiteGenerator", () => {
+    test("should generate an index.html", async () => {
+        const folder = await generateMock_1.default(website_1.default, {
+            "README.md": "Hello World"
+        });
+        expect(folder).toHaveFile("index.html");
+    });
+    describe("Glossary", () => {
+        let folder;
+        beforeAll(() => {
+            return generateMock_1.default(website_1.default, {
+                "README.md": "Hello World",
+                "SUMMARY.md": "* [Deep](folder/page.md)",
+                folder: {
+                    "page.md": "Hello World"
+                },
+                "GLOSSARY.md": "# Glossary\n\n## Hello\n\nHello World"
+            }).then((_folder) => {
+                folder = _folder;
+            });
+        });
+        longTest("should generate a GLOSSARY.html", () => {
+            expect(folder).toHaveFile("GLOSSARY.html");
+        });
+        longTest("should correctly resolve glossary links in README", () => {
+            const html = fs_1.default.readFileSync(`${folder}/index.html`, "utf8");
+            expect(html).toHaveDOMElement(".page-inner a[href=\"GLOSSARY.html#hello\"]");
+        });
+        longTest("should correctly resolve glossary links in directory", () => {
+            const html = fs_1.default.readFileSync(`${folder}/folder/page.html`, "utf8");
+            expect(html).toHaveDOMElement(".page-inner a[href=\"../GLOSSARY.html#hello\"]");
+        });
+        longTest("should accept a custom glossary file", () => {
+            return generateMock_1.default(website_1.default, {
+                "README.md": "Hello World",
+                "book.json": "{ \"structure\": { \"glossary\": \"custom.md\" } }",
+                "custom.md": "# Glossary\n\n## Hello\n\nHello World"
+            }).then((folder) => {
+                expect(folder).toHaveFile("custom.html");
+                expect(folder).not.toHaveFile("GLOSSARY.html");
+                const html = fs_1.default.readFileSync(`${folder}/index.html`, "utf8");
+                expect(html).toHaveDOMElement(".page-inner a[href=\"custom.html#hello\"]");
+            });
+        });
+    });
+    test.skip("should copy asset files", () => {
+        return generateMock_1.default(website_1.default, {
+            "README.md": "Hello World",
+            "myJsFile.js": "var a = \"test\";",
+            folder: {
+                "AnotherAssetFile.md": "# Even md"
+            }
+        }).then((folder) => {
+            expect(folder).toHaveFile("index.html");
+            expect(folder).toHaveFile("myJsFile.js");
+            expect(folder).toHaveFile("folder/AnotherAssetFile.md");
+        });
+    });
+    test.skip("should generate an index.html for AsciiDoc", async () => {
+        const folder = await generateMock_1.default(website_1.default, {
+            "README.adoc": "Hello World"
+        });
+        expect(folder).toHaveFile("index.html");
+    });
+    longTest("should generate an HTML file for each articles", () => {
+        return generateMock_1.default(website_1.default, {
+            "README.md": "Hello World",
+            "SUMMARY.md": "# Summary\n\n* [Page](test/page.md)",
+            test: {
+                "page.md": "Hello 2"
+            }
+        }).then((folder) => {
+            expect(folder).toHaveFile("index.html");
+            expect(folder).toHaveFile("test/page.html");
+        });
+    });
+    longTest("should not generate file if entry file doesn't exist", () => {
+        return generateMock_1.default(website_1.default, {
+            "README.md": "Hello World",
+            "SUMMARY.md": "# Summary\n\n* [Page 1](page.md)\n* [Page 2](test/page.md)",
+            test: {
+                "page.md": "Hello 2"
+            }
+        }).then((folder) => {
+            expect(folder).toHaveFile("index.html");
+            expect(folder).not.toHaveFile("page.html");
+            expect(folder).toHaveFile("test/page.html");
+        });
+    });
+    longTest("should generate a multilingual book", () => {
+        return generateMock_1.default(website_1.default, {
+            "LANGS.md": "# Languages\n\n* [en](en)\n* [fr](fr)",
+            en: {
+                "README.md": "Hello"
+            },
+            fr: {
+                "README.md": "Bonjour"
+            }
+        }).then((folder) => {
+            // It should generate languages
+            expect(folder).toHaveFile("en/index.html");
+            expect(folder).toHaveFile("fr/index.html");
+            // Should not copy languages as assets
+            expect(folder).not.toHaveFile("en/README.md");
+            expect(folder).not.toHaveFile("fr/README.md");
+            // Should copy assets only once
+            expect(folder).toHaveFile("gitbook/style.css");
+            expect(folder).not.toHaveFile("en/gitbook/style.css");
+            expect(folder).toHaveFile("index.html");
+        });
+    });
+});

package/lib/output/callHook.js

@@ -0,0 +1,51 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const promise_1 = __importDefault(require("../utils/promise"));
+const timing_1 = __importDefault(require("../utils/timing"));
+const api_1 = __importDefault(require("../api"));
+function defaultGetArgument() {
+    return undefined;
+}
+function defaultHandleResult(output, result) {
+    return output;
+}
+/**
+ Call a "global" hook for an output
+
+ @param {string} name
+ @param {Function(Output) -> Mixed} getArgument
+ @param {Function(Output, result) -> Output} handleResult
+ @param {Output} output
+ @return {Promise<Output>}
+ */
+function callHook(name, getArgument, handleResult, output) {
+    getArgument = getArgument || defaultGetArgument;
+    handleResult = handleResult || defaultHandleResult;
+    const logger = output.getLogger();
+    const plugins = output.getPlugins();
+    logger.debug.ln(`calling hook "${name}"`);
+    // Create the JS context for plugins
+    const context = api_1.default.encodeGlobal(output);
+    return timing_1.default.measure(`call.hook.${name}`, 
+    // Get the arguments
+    promise_1.default(getArgument(output))
+        // Call the hooks in serie
+        .then((arg) => {
+        return promise_1.default.reduce(plugins, (prev, plugin) => {
+            const hook = plugin.getHook(name);
+            if (!hook) {
+                return prev;
+            }
+            return hook.call(context, prev);
+        }, arg);
+    })
+        // Handle final result
+        .then((result) => {
+        output = api_1.default.decodeGlobal(output, context);
+        return handleResult(output, result);
+    }));
+}
+exports.default = callHook;

package/lib/output/callPageHook.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const api_1 = __importDefault(require("../api"));
+const callHook_1 = __importDefault(require("./callHook"));
+/**
+ Call a hook for a specific page
+
+ @param {string} name
+ @param {Output} output
+ @param {Page} page
+ @return {Promise<Page>}
+ */
+function callPageHook(name, output, page) {
+    return callHook_1.default(name, (out) => {
+        return api_1.default.encodePage(out, page);
+    }, (out, result) => {
+        return api_1.default.decodePage(out, page, result);
+    }, output);
+}
+exports.default = callPageHook;

package/lib/output/createTemplateEngine.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const templating_1 = __importDefault(require("../templating"));
+const templateEngine_1 = __importDefault(require("../models/templateEngine"));
+const api_1 = __importDefault(require("../api"));
+const plugins_1 = __importDefault(require("../plugins"));
+const defaultBlocks_1 = __importDefault(require("../constants/defaultBlocks"));
+const defaultFilters_1 = __importDefault(require("../constants/defaultFilters"));
+/**
+ Create template engine for an output.
+ It adds default filters/blocks, then add the ones from plugins
+
+ @param {Output} output
+ @return {TemplateEngine}
+ */
+function createTemplateEngine(output) {
+    const plugins = output.getPlugins();
+    const book = output.getBook();
+    const rootFolder = book.getContentRoot();
+    const logger = book.getLogger();
+    let filters = plugins_1.default.listFilters(plugins);
+    let blocks = plugins_1.default.listBlocks(plugins);
+    // Extend with default
+    blocks = defaultBlocks_1.default.merge(blocks);
+    filters = defaultFilters_1.default.merge(filters);
+    // Create loader
+    const transformFn = templating_1.default.replaceShortcuts.bind(null, blocks);
+    // @ts-expect-error: Expected 0 arguments, but got 3.
+    const loader = new templating_1.default.ConrefsLoader(rootFolder, transformFn, logger);
+    // Create API context
+    const context = api_1.default.encodeGlobal(output);
+    return new templateEngine_1.default({
+        filters: filters,
+        blocks: blocks,
+        loader: loader,
+        context: context,
+    });
+}
+exports.default = createTemplateEngine;

package/lib/output/ebook/getConvertOptions.js

@@ -0,0 +1,69 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const extend_1 = __importDefault(require("extend"));
+const promise_1 = __importDefault(require("../../utils/promise"));
+const getPDFTemplate_1 = __importDefault(require("./getPDFTemplate"));
+const getCoverPath_1 = __importDefault(require("./getCoverPath"));
+/**
+ Generate options for ebook-convert
+
+ @param {Output}
+ @return {Promise<Object>}
+ */
+function getConvertOptions(output) {
+    const options = output.getOptions();
+    const format = options.get("format");
+    const book = output.getBook();
+    const config = book.getConfig();
+    return promise_1.default().then(() => {
+        const coverPath = getCoverPath_1.default(output);
+        let options = {
+            "--cover": coverPath,
+            "--title": config.getValue("title"),
+            "--comments": config.getValue("description"),
+            "--isbn": config.getValue("isbn"),
+            "--authors": config.getValue("author"),
+            "--author-sort": config.getValue("authorSort"),
+            "--language": book.getLanguage() || config.getValue("language"),
+            "--book-producer": config.getValue("producer") || "HonKit",
+            "--publisher": config.getValue("publisher") || "HonKit",
+            "--pubdate": config.getValue("pubdate"),
+            "--series": config.getValue("series"),
+            "--series-index": config.getValue("seriesIndex"),
+            "--chapter": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter ')]",
+            "--level1-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-1 ')]",
+            "--level2-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-2 ')]",
+            "--level3-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-3 ')]",
+            "--max-levels": "1",
+            "--no-chapters-in-toc": true,
+            "--breadth-first": true,
+            "--dont-split-on-page-breaks": format === "epub" ? true : undefined,
+        };
+        if (format !== "pdf") {
+            return options;
+        }
+        return promise_1.default.all([getPDFTemplate_1.default(output, "header"), getPDFTemplate_1.default(output, "footer")]).spread((headerTpl, footerTpl) => {
+            const pdfOptions = config.getValue("pdf").toJS();
+            return (options = extend_1.default(options, {
+                "--chapter-mark": String(pdfOptions.chapterMark),
+                "--page-breaks-before": String(pdfOptions.pageBreaksBefore),
+                "--pdf-page-margin-left": String(pdfOptions.margin.left),
+                "--pdf-page-margin-right": String(pdfOptions.margin.right),
+                "--pdf-page-margin-top": String(pdfOptions.margin.top),
+                "--pdf-page-margin-bottom": String(pdfOptions.margin.bottom),
+                "--pdf-default-font-size": String(pdfOptions.fontSize),
+                "--pdf-mono-font-size": String(pdfOptions.fontSize),
+                "--paper-size": String(pdfOptions.paperSize),
+                "--pdf-page-numbers": Boolean(pdfOptions.pageNumbers),
+                "--pdf-sans-family": String(pdfOptions.fontFamily),
+                "--pdf-header-template": headerTpl,
+                "--pdf-footer-template": footerTpl,
+                "--embed-all-fonts": Boolean(pdfOptions.embedFonts),
+            }));
+        });
+    });
+}
+exports.default = getConvertOptions;