honkit 3.6.21

package/lib/output/modifiers/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const modifyHTML_1 = __importDefault(require("./modifyHTML"));
+const inlineAssets_1 = __importDefault(require("./inlineAssets"));
+const addHeadingId_1 = __importDefault(require("./addHeadingId"));
+const svgToImg_1 = __importDefault(require("./svgToImg"));
+const fetchRemoteImages_1 = __importDefault(require("./fetchRemoteImages"));
+const resolveLinks_1 = __importDefault(require("./resolveLinks"));
+const resolveImages_1 = __importDefault(require("./resolveImages"));
+const annotateText_1 = __importDefault(require("./annotateText"));
+const highlightCode_1 = __importDefault(require("./highlightCode"));
+exports.default = {
+    modifyHTML: modifyHTML_1.default,
+    inlineAssets: inlineAssets_1.default,
+    // HTML transformations
+    addHeadingId: addHeadingId_1.default,
+    svgToImg: svgToImg_1.default,
+    fetchRemoteImages: fetchRemoteImages_1.default,
+    resolveLinks: resolveLinks_1.default,
+    resolveImages: resolveImages_1.default,
+    annotateText: annotateText_1.default,
+    highlightCode: highlightCode_1.default,
+};

package/lib/output/modifiers/inlineAssets.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const resolveImages_1 = __importDefault(require("./resolveImages"));
+const fetchRemoteImages_1 = __importDefault(require("./fetchRemoteImages"));
+const svgToImg_1 = __importDefault(require("./svgToImg"));
+const inlineSvg_1 = __importDefault(require("./inlineSvg"));
+const inlinePng_1 = __importDefault(require("./inlinePng"));
+const promise_1 = __importDefault(require("../../utils/promise"));
+/**
+ Inline all assets in a page
+
+ @param {string} rootFolder
+ */
+function inlineAssets(rootFolder, currentFile) {
+    return function ($) {
+        return (promise_1.default()
+            // Resolving images and fetching external images should be
+            // done before svg conversion
+            .then(resolveImages_1.default.bind(null, currentFile, $))
+            .then(fetchRemoteImages_1.default.bind(null, rootFolder, currentFile, $))
+            .then(svgToImg_1.default.bind(null, rootFolder, currentFile, $))
+            .then(inlineSvg_1.default.bind(null, rootFolder, currentFile, $))
+            .then(inlinePng_1.default.bind(null, rootFolder, currentFile, $)));
+    };
+}
+exports.default = inlineAssets;

package/lib/output/modifiers/inlinePng.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 crc_1 = __importDefault(require("crc"));
+const path_1 = __importDefault(require("path"));
+const images_1 = __importDefault(require("../../utils/images"));
+const fs_1 = __importDefault(require("../../utils/fs"));
+const location_1 = __importDefault(require("../../utils/location"));
+const editHTMLElement_1 = __importDefault(require("./editHTMLElement"));
+/**
+ Convert all inline PNG images to PNG file
+
+ @param {string} rootFolder
+ @param {HTMLDom} $
+ @return {Promise}
+ */
+function inlinePng(rootFolder, currentFile, $) {
+    const currentDirectory = path_1.default.dirname(currentFile);
+    return editHTMLElement_1.default($, "img", ($img) => {
+        const src = $img.attr("src");
+        if (!location_1.default.isDataURI(src)) {
+            return;
+        }
+        // We avoid generating twice the same PNG
+        const hash = crc_1.default.crc32(src).toString(16);
+        let fileName = `${hash}.png`;
+        // Result file path
+        const filePath = path_1.default.join(rootFolder, fileName);
+        return fs_1.default
+            .assertFile(filePath, () => {
+            return images_1.default.convertInlinePNG(src, filePath);
+        })
+            .then(() => {
+            // Convert filename to a relative filename
+            fileName = location_1.default.relative(currentDirectory, fileName);
+            // Replace src
+            $img.attr("src", fileName);
+        });
+    });
+}
+exports.default = inlinePng;

package/lib/output/modifiers/inlineSvg.js

@@ -0,0 +1,39 @@
+"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 fs_1 = __importDefault(require("../../utils/fs"));
+const location_1 = __importDefault(require("../../utils/location"));
+const editHTMLElement_1 = __importDefault(require("./editHTMLElement"));
+const cheerio_1 = __importDefault(require("cheerio"));
+/**
+ Inline SVG images as needed
+
+ @param {string} rootFolder
+ @param {HTMLDom} $
+ @return {Promise}
+ */
+function inlineSvg(rootFolder, currentFile, $) {
+    const currentDirectory = path_1.default.dirname(currentFile);
+    return editHTMLElement_1.default($, "img", ($img) => {
+        let src = $img.attr("src");
+        if (path_1.default.extname(src) !== ".svg") {
+            return;
+        }
+        // Calcul absolute path for this
+        src = location_1.default.toAbsolute(src, currentDirectory, ".");
+        const inputPath = path_1.default.join(rootFolder, src);
+        return fs_1.default.readFile(inputPath).then((svgContext) => {
+            const $ = cheerio_1.default.load(svgContext, { xmlMode: true });
+            const $svg = $("svg");
+            if ($svg.attr("style")) {
+                return;
+            }
+            $svg.attr("fill", "currentColor");
+            $img.replaceWith($svg);
+        });
+    });
+}
+exports.default = inlineSvg;

package/lib/output/modifiers/modifyHTML.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 cheerio_1 = __importDefault(require("cheerio"));
+const promise_1 = __importDefault(require("../../utils/promise"));
+/**
+ Apply a list of operations to a page and
+ output the new page.
+
+ @param {Page}
+ @param {List|Array<Transformation>}
+ @return {Promise<Page>}
+ */
+function modifyHTML(page, operations) {
+    const html = page.getContent();
+    const $ = cheerio_1.default.load(html);
+    return promise_1.default.forEach(operations, (op) => {
+        return op($);
+    }).then(() => {
+        const resultHTML = $.html();
+        const unescapedHtml = resultHTML.replace(/&#x([0-9a-f]{2,});/gi, (_, code) => String.fromCodePoint(parseInt(code, 16)));
+        return page.set("content", unescapedHtml);
+    });
+}
+exports.default = modifyHTML;

package/lib/output/modifiers/resolveImages.js

@@ -0,0 +1,30 @@
+"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 location_1 = __importDefault(require("../../utils/location"));
+const editHTMLElement_1 = __importDefault(require("./editHTMLElement"));
+/**
+ Resolve all HTML images:
+ - /test.png in hello -> ../test.html
+
+ @param {string} currentFile
+ @param {HTMLDom} $
+ */
+function resolveImages(currentFile, $) {
+    const currentDirectory = path_1.default.dirname(currentFile);
+    return editHTMLElement_1.default($, "img", ($img) => {
+        let src = $img.attr("src");
+        if (src === null || src === undefined || location_1.default.isExternal(src) || location_1.default.isDataURI(src)) {
+            return;
+        }
+        // Calcul absolute path for this
+        src = location_1.default.toAbsolute(src, currentDirectory, ".");
+        // Convert back to relative
+        src = location_1.default.relative(currentDirectory, src);
+        $img.attr("src", src);
+    });
+}
+exports.default = resolveImages;

package/lib/output/modifiers/resolveLinks.js

@@ -0,0 +1,46 @@
+"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 url_1 = __importDefault(require("url"));
+const location_1 = __importDefault(require("../../utils/location"));
+const editHTMLElement_1 = __importDefault(require("./editHTMLElement"));
+/**
+ Resolve all HTML links:
+ - /test.md in hello -> ../test.html
+
+ @param {string} currentFile
+ @param {Function(String) -> String} resolveFile
+ @param {HTMLDom} $
+ */
+function resolveLinks(currentFile, resolveFile, $) {
+    const currentDirectory = path_1.default.dirname(currentFile);
+    return editHTMLElement_1.default($, "a", ($a) => {
+        let href = $a.attr("href");
+        // Don't change a tag without href
+        if (!href) {
+            return;
+        }
+        if (location_1.default.isExternal(href)) {
+            $a.attr("target", "_blank");
+            return;
+        }
+        // Split anchor
+        const parsed = url_1.default.parse(href);
+        href = parsed.pathname || "";
+        if (href) {
+            // Calcul absolute path for this
+            href = location_1.default.toAbsolute(href, currentDirectory, ".");
+            // Resolve file
+            href = resolveFile(href);
+            // Convert back to relative
+            href = location_1.default.relative(currentDirectory, href);
+        }
+        // Add back anchor
+        href = href + (parsed.hash || "");
+        $a.attr("href", href);
+    });
+}
+exports.default = resolveLinks;

package/lib/output/modifiers/svgToImg.js

@@ -0,0 +1,58 @@
+"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 crc_1 = __importDefault(require("crc"));
+const dom_serializer_1 = __importDefault(require("dom-serializer"));
+const editHTMLElement_1 = __importDefault(require("./editHTMLElement"));
+const fs_1 = __importDefault(require("../../utils/fs"));
+const location_1 = __importDefault(require("../../utils/location"));
+/**
+ Render a cheerio DOM as html
+
+ @param {HTMLDom} $
+ @param {HTMLElement} dom
+ @param {Object}
+ @return {string}
+ */
+function renderDOM($, dom, options) {
+    if (!dom && $._root && $._root.children) {
+        dom = $._root.children;
+    }
+    options = options || dom.options || $._options;
+    return dom_serializer_1.default(dom, options);
+}
+/**
+ Replace SVG tag by IMG
+
+ @param {string} baseFolder
+ @param {HTMLDom} $
+ */
+function svgToImg(baseFolder, currentFile, $) {
+    const currentDirectory = path_1.default.dirname(currentFile);
+    return editHTMLElement_1.default($, "svg", ($svg) => {
+        if ($svg.attr("fill")) {
+            return;
+        }
+        // @ts-expect-error ts-migrate(2554) FIXME: Expected 3 arguments, but got 2.
+        const content = `<?xml version="1.0" encoding="UTF-8"?>${renderDOM($, $svg)}`;
+        // We avoid generating twice the same PNG
+        const hash = crc_1.default.crc32(content).toString(16);
+        const fileName = `${hash}.svg`;
+        const filePath = path_1.default.join(baseFolder, fileName);
+        // Write the svg to the file
+        return (fs_1.default
+            .assertFile(filePath, () => {
+            // @ts-expect-error ts-migrate(2554) FIXME: Expected 2 arguments, but got 3.
+            return fs_1.default.writeFile(filePath, content, "utf8");
+        })
+            // Return as image
+            .then(() => {
+            const src = location_1.default.relative(currentDirectory, fileName);
+            $svg.replaceWith(`<img src="${src}" />`);
+        }));
+    });
+}
+exports.default = svgToImg;

package/lib/output/page-cache.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearCache = exports.getCache = void 0;
+const flat_cache_1 = __importDefault(require("flat-cache"));
+const getCache = () => {
+    return flat_cache_1.default.create("honkit-3.6.7");
+};
+exports.getCache = getCache;
+const clearCache = () => {
+    return flat_cache_1.default.clearCacheById("honkit-3.6.7");
+};
+exports.clearCache = clearCache;

package/lib/output/prepareAssets.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const parse_1 = __importDefault(require("../parse"));
+/**
+ List all assets in the book
+
+ @param {Output}
+ @return {Promise<Output>}
+ */
+function prepareAssets(output) {
+    const book = output.getBook();
+    const pages = output.getPages();
+    const logger = output.getLogger();
+    return parse_1.default.listAssets(book, pages).then((assets) => {
+        logger.info.ln("found", assets.size, "asset files");
+        return output.set("assets", assets);
+    });
+}
+exports.default = prepareAssets;

package/lib/output/preparePages.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const parse_1 = __importDefault(require("../parse"));
+const promise_1 = __importDefault(require("../utils/promise"));
+/**
+ List and prepare all pages
+
+ @param {Output}
+ @return {Promise<Output>}
+ */
+function preparePages(output) {
+    const book = output.getBook();
+    const logger = book.getLogger();
+    if (book.isMultilingual()) {
+        return promise_1.default(output);
+    }
+    return parse_1.default.parsePagesList(book).then((pages) => {
+        logger.info.ln("found", pages.size, "pages");
+        return output.set("pages", pages);
+    });
+}
+exports.default = preparePages;

package/lib/output/preparePlugins.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const plugins_1 = __importDefault(require("../plugins"));
+const promise_1 = __importDefault(require("../utils/promise"));
+/**
+ * Load and setup plugins
+ *
+ * @param {Output}
+ * @return {Promise<Output>}
+ */
+function preparePlugins(output) {
+    const book = output.getBook();
+    return (promise_1.default()
+        // Only load plugins for main book
+        .then(() => {
+        if (book.isLanguageBook()) {
+            return output.getPlugins();
+        }
+        else {
+            return plugins_1.default.loadForBook(book);
+        }
+    })
+        // Update book's configuration using the plugins
+        .then((plugins) => {
+        return plugins_1.default.validateConfig(book, plugins).then((newBook) => {
+            return output.merge({
+                book: newBook,
+                plugins: plugins,
+            });
+        });
+    }));
+}
+exports.default = preparePlugins;

package/lib/output/testing/createMock.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mock_1 = __importDefault(require("../../fs/mock"));
+const immutable_1 = __importDefault(require("immutable"));
+const output_1 = __importDefault(require("../../models/output"));
+const book_1 = __importDefault(require("../../models/book"));
+const parseBook_1 = __importDefault(require("../../parse/parseBook"));
+const preparePlugins_1 = __importDefault(require("../preparePlugins"));
+/**
+ * Create an output using a generator
+ *
+ * FOR TESTING PURPOSE ONLY
+ *
+ * @param {Generator} generator
+ * @param {Map<String:String|Map>} files
+ * @param {*} [options]
+ * @return {Promise<Output>}
+ */
+function createMockOutput(generator, files, options) {
+    const fs = mock_1.default(files);
+    let book = book_1.default.createForFS(fs);
+    const state = generator.State ? new generator.State({}) : immutable_1.default.Map();
+    book = book.setLogLevel("disabled");
+    options = generator.Options(options);
+    return parseBook_1.default(book)
+        .then((resultBook) => {
+        return new output_1.default({
+            book: resultBook,
+            options: options,
+            state: state,
+            generator: generator.name,
+        });
+    })
+        .then(preparePlugins_1.default);
+}
+exports.default = createMockOutput;