honkit 3.6.21

package/lib/output/generatePages.js

@@ -0,0 +1,52 @@
+"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 promise_1 = __importDefault(require("../utils/promise"));
+const generatePage_1 = __importDefault(require("./generatePage"));
+const page_cache_1 = require("./page-cache");
+/**
+ Output all pages using a generator
+
+ @param {Generator} generator
+ @param {Output} output
+ @return {Promise<Output>}
+ */
+function generatePages(generator, output) {
+    const cache = page_cache_1.getCache();
+    const pages = output.getPages();
+    const logger = output.getLogger();
+    // Is generator ignoring assets?
+    if (!generator.onPage) {
+        return promise_1.default(output);
+    }
+    const root = output.book.getContentRoot();
+    const isIncrementBuilding = output.incrementalChangeFileSet.size !== 0;
+    const pageList = pages.map((page) => {
+        const file = page.getFile();
+        const absoluteFilePath = path_1.default.join(root, file.getPath());
+        // When incremental build
+        if (isIncrementBuilding && !output.incrementalChangeFileSet.has(absoluteFilePath)) {
+            logger.debug.ln(`skip generate page "${file.getPath()}"`);
+            return; // Skip build
+        }
+        return generatePage_1.default(output, page)
+            .then((resultPage) => {
+            // It call renderToString
+            // Create page file
+            return generator.onPage(output, resultPage);
+        })
+            .fail((err) => {
+            logger.error.ln(`error while generating page "${file.getPath()}":`);
+            throw err;
+        });
+    });
+    return promise_1.default.all(pageList.toArray()).then(() => {
+        // update caches
+        cache.save();
+        return output;
+    });
+}
+exports.default = generatePages;

package/lib/output/getModifiers.js

@@ -0,0 +1,63 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const modifiers_1 = __importDefault(require("./modifiers"));
+const resolveFileToURL_1 = __importDefault(require("./helper/resolveFileToURL"));
+const api_1 = __importDefault(require("../api"));
+const plugins_1 = __importDefault(require("../plugins"));
+const promise_1 = __importDefault(require("../utils/promise"));
+const defaultBlocks_1 = __importDefault(require("../constants/defaultBlocks"));
+const fileToOutput_1 = __importDefault(require("./helper/fileToOutput"));
+const CODEBLOCK = "code";
+/**
+ * Return default modifier to prepare a page for
+ * rendering.
+ *
+ * @return {Array<Modifier>}
+ */
+function getModifiers(output, page) {
+    const book = output.getBook();
+    const plugins = output.getPlugins();
+    const glossary = book.getGlossary();
+    const file = page.getFile();
+    // Glossary entries
+    const entries = glossary.getEntries();
+    const glossaryFile = glossary.getFile();
+    const glossaryFilename = fileToOutput_1.default(output, glossaryFile.getPath());
+    // Current file path
+    const currentFilePath = file.getPath();
+    // Get TemplateBlock for highlighting
+    const blocks = plugins_1.default.listBlocks(plugins);
+    const code = blocks.get(CODEBLOCK) || defaultBlocks_1.default.get(CODEBLOCK);
+    // Current context
+    const context = api_1.default.encodeGlobal(output);
+    return [
+        // Normalize IDs on headings
+        modifiers_1.default.addHeadingId,
+        // Annotate text with glossary entries
+        modifiers_1.default.annotateText.bind(null, entries, glossaryFilename),
+        // Resolve images
+        modifiers_1.default.resolveImages.bind(null, currentFilePath),
+        // Resolve links (.md -> .html)
+        modifiers_1.default.resolveLinks.bind(null, currentFilePath, resolveFileToURL_1.default.bind(null, output)),
+        // Highlight code blocks using "code" block
+        modifiers_1.default.highlightCode.bind(null, (lang, source) => {
+            return promise_1.default(code.applyBlock({
+                body: source,
+                kwargs: {
+                    language: lang,
+                },
+            }, context)).then((result) => {
+                if (result.html === false) {
+                    return { text: result.body };
+                }
+                else {
+                    return { html: result.body };
+                }
+            });
+        }),
+    ];
+}
+exports.default = getModifiers;

package/lib/output/helper/fileToOutput.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 path_2 = __importDefault(require("../../utils/path"));
+const location_1 = __importDefault(require("../../utils/location"));
+const OUTPUT_EXTENSION = ".html";
+/**
+ * Convert a filePath (absolute) to a filename for output
+ *
+ * @param {Output} output
+ * @param {string} filePath
+ * @return {string}
+ */
+function fileToOutput(output, filePath) {
+    const book = output.getBook();
+    const readme = book.getReadme();
+    const fileReadme = readme.getFile();
+    if (path_1.default.basename(filePath, path_1.default.extname(filePath)) == "README" ||
+        (fileReadme.exists() && filePath == fileReadme.getPath())) {
+        filePath = path_1.default.join(path_1.default.dirname(filePath), `index${OUTPUT_EXTENSION}`);
+    }
+    else {
+        filePath = path_2.default.setExtension(filePath, OUTPUT_EXTENSION);
+    }
+    return location_1.default.normalize(filePath);
+}
+exports.default = fileToOutput;

package/lib/output/helper/fileToURL.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 fileToOutput_1 = __importDefault(require("./fileToOutput"));
+/**
+ Convert a filePath (absolute) to an url (without hostname).
+ It returns an absolute path.
+
+ "README.md" -> "/"
+ "test/hello.md" -> "test/hello.html"
+ "test/README.md" -> "test/"
+
+ @param {Output} output
+ @param {string} filePath
+ @return {string}
+ */
+function fileToURL(output, filePath) {
+    const options = output.getOptions();
+    const directoryIndex = options.get("directoryIndex");
+    filePath = fileToOutput_1.default(output, filePath);
+    if (directoryIndex && path_1.default.basename(filePath) == "index.html") {
+        filePath = `${path_1.default.dirname(filePath)}/`;
+    }
+    return location_1.default.normalize(filePath);
+}
+exports.default = fileToURL;

package/lib/output/helper/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {};

package/lib/output/helper/resolveFileToURL.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 location_1 = __importDefault(require("../../utils/location"));
+const fileToURL_1 = __importDefault(require("./fileToURL"));
+/**
+ * Resolve an absolute path (extracted from a link)
+ *
+ * @param {Output} output
+ * @param {string} filePath
+ * @return {string}
+ */
+function resolveFileToURL(output, filePath) {
+    // Convert /test.png -> test.png
+    filePath = location_1.default.toAbsolute(filePath, "", "");
+    const page = output.getPage(filePath);
+    // if file is a page, return correct .html url
+    if (page) {
+        filePath = fileToURL_1.default(output, filePath);
+    }
+    return location_1.default.normalize(filePath);
+}
+exports.default = resolveFileToURL;

package/lib/output/helper/writeFile.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 path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("../../utils/fs"));
+/**
+ Write a file to the output folder
+
+ @param {Output} output
+ @param {string} filePath
+ @param {Buffer|String} content
+ @return {Promise}
+ */
+function writeFile(output, filePath, content) {
+    const rootFolder = output.getRoot();
+    filePath = path_1.default.join(rootFolder, filePath);
+    return fs_1.default
+        .ensureFile(filePath)
+        .then(() => {
+        return fs_1.default.writeFile(filePath, content);
+    })
+        .thenResolve(output);
+}
+exports.default = writeFile;

package/lib/output/index.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 immutable_1 = __importDefault(require("immutable"));
+const generateBook_1 = require("./generateBook");
+const json_1 = __importDefault(require("./json"));
+const website_1 = __importDefault(require("./website"));
+const ebook_1 = __importDefault(require("./ebook"));
+const generators = immutable_1.default.List([json_1.default, website_1.default, ebook_1.default]);
+/**
+ Return a specific generator by its name
+
+ @param {string}
+ @return {Generator}
+ */
+function getGenerator(name) {
+    return generators.find((generator) => {
+        return generator.name == name;
+    });
+}
+exports.default = {
+    generate: generateBook_1.generateBook,
+    incrementalBuild: generateBook_1.incrementalBuild,
+    getGenerator: getGenerator,
+};

package/lib/output/json/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const onFinish_1 = require("./onFinish");
+const onPage_1 = require("./onPage");
+const options_1 = __importDefault(require("./options"));
+exports.default = {
+    name: "json",
+    Options: options_1.default,
+    onPage: onPage_1.onPage,
+    onFinish: onFinish_1.onFinish,
+};

package/lib/output/json/onFinish.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 });
+exports.onFinish = void 0;
+const path_1 = __importDefault(require("path"));
+const promise_1 = __importDefault(require("../../utils/promise"));
+const fs_1 = __importDefault(require("../../utils/fs"));
+const json_1 = __importDefault(require("../../json"));
+/**
+ Finish the generation
+ @param {Output} output
+ @return {Output}
+ */
+function onFinish(output) {
+    const book = output.getBook();
+    const outputRoot = output.getRoot();
+    if (!book.isMultilingual()) {
+        return promise_1.default(output);
+    }
+    // Get main language
+    const languages = book.getLanguages();
+    const mainLanguage = languages.getDefaultLanguage();
+    // Read the main JSON
+    return (fs_1.default
+        .readFile(path_1.default.resolve(outputRoot, mainLanguage.getID(), "README.json"), "utf8")
+        // Extend the JSON
+        .then((content) => {
+        const json = JSON.parse(content);
+        json.languages = json_1.default.encodeLanguages(languages);
+        return json;
+    })
+        .then((json) => {
+        return fs_1.default.writeFile(path_1.default.resolve(outputRoot, "README.json"), JSON.stringify(json, null, 4));
+    })
+        .thenResolve(output));
+}
+exports.onFinish = onFinish;

package/lib/output/json/onPage.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onPage = void 0;
+const json_1 = __importDefault(require("../../json"));
+const path_1 = __importDefault(require("../../utils/path"));
+const modifiers_1 = __importDefault(require("../modifiers"));
+const writeFile_1 = __importDefault(require("../helper/writeFile"));
+const getModifiers_1 = __importDefault(require("../getModifiers"));
+const JSON_VERSION = "3";
+/**
+ * Write a page as a json file
+ *
+ * @param {Output} output
+ * @param {Page} page
+ */
+function onPage(output, page) {
+    const file = page.getFile();
+    const readme = output.getBook().getReadme().getFile();
+    return modifiers_1.default.modifyHTML(page, getModifiers_1.default(output, page)).then((resultPage) => {
+        // Generate the JSON
+        const json = json_1.default.encodeBookWithPage(output.getBook(), resultPage);
+        // Delete some private properties
+        delete json.config;
+        // Specify JSON output version
+        // @ts-expect-error ts-migrate(2339) FIXME: Property 'version' does not exist on type '{ summa... Remove this comment to see the full error message
+        json.version = JSON_VERSION;
+        // File path in the output folder
+        let filePath = file.getPath() == readme.getPath() ? "README.json" : file.getPath();
+        filePath = path_1.default.setExtension(filePath, ".json");
+        // Write it to the disk
+        return writeFile_1.default(output, filePath, JSON.stringify(json, null, 4));
+    });
+}
+exports.onPage = onPage;

package/lib/output/json/options.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const immutable_1 = __importDefault(require("immutable"));
+const Options = immutable_1.default.Record({
+    // Root folder for the output
+    root: String(),
+});
+exports.default = Options;

package/lib/output/modifiers/__tests__/addHeadingId.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 cheerio_1 = __importDefault(require("cheerio"));
+const addHeadingId_1 = __importDefault(require("../addHeadingId"));
+describe("addHeadingId", () => {
+    test("should add an ID if none", () => {
+        const $ = cheerio_1.default.load("<h1>Hello World</h1><h2>Cool !!</h2>");
+        return addHeadingId_1.default($).then(() => {
+            const html = $.html();
+            expect(html).toBe("<h1 id=\"hello-world\">Hello World</h1><h2 id=\"cool-\">Cool !!</h2>");
+        });
+    });
+    test("should not change existing IDs", () => {
+        const $ = cheerio_1.default.load("<h1 id=\"awesome\">Hello World</h1>");
+        return addHeadingId_1.default($).then(() => {
+            const html = $.html();
+            expect(html).toBe("<h1 id=\"awesome\">Hello World</h1>");
+        });
+    });
+});

package/lib/output/modifiers/__tests__/annotateText.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 immutable_1 = __importDefault(require("immutable"));
+const cheerio_1 = __importDefault(require("cheerio"));
+const glossaryEntry_1 = __importDefault(require("../../../models/glossaryEntry"));
+const annotateText_1 = __importDefault(require("../annotateText"));
+describe("annotateText", () => {
+    const entries = immutable_1.default.List([
+        new glossaryEntry_1.default({ name: "Word" }),
+        new glossaryEntry_1.default({ name: "Multiple Words" }),
+    ]);
+    test("should annotate text", () => {
+        const $ = cheerio_1.default.load("<p>This is a word, and multiple words</p>");
+        annotateText_1.default(entries, "GLOSSARY.md", $);
+        const links = $("a");
+        expect(links.length).toBe(2);
+        const word = $(links.get(0));
+        expect(word.attr("href")).toBe("/GLOSSARY.md#word");
+        expect(word.text()).toBe("word");
+        expect(word.hasClass("glossary-term")).toBeTruthy();
+        const words = $(links.get(1));
+        expect(words.attr("href")).toBe("/GLOSSARY.md#multiple-words");
+        expect(words.text()).toBe("multiple words");
+        expect(words.hasClass("glossary-term")).toBeTruthy();
+    });
+    test("should not annotate scripts", () => {
+        const $ = cheerio_1.default.load("<script>This is a word, and multiple words</script>");
+        annotateText_1.default(entries, "GLOSSARY.md", $);
+        expect($("a").length).toBe(0);
+    });
+    test('should not annotate when has class "no-glossary"', () => {
+        const $ = cheerio_1.default.load('<p class="no-glossary">This is a word, and multiple words</p>');
+        annotateText_1.default(entries, "GLOSSARY.md", $);
+        expect($("a").length).toBe(0);
+    });
+});

package/lib/output/modifiers/__tests__/fetchRemoteImages.js

@@ -0,0 +1,32 @@
+"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 tmp_1 = __importDefault(require("tmp"));
+const path_1 = __importDefault(require("path"));
+const fetchRemoteImages_1 = __importDefault(require("../fetchRemoteImages"));
+const URL = "https://upload.wikimedia.org/wikipedia/commons/thumb/4/47/PNG_transparency_demonstration_1.png/280px-PNG_transparency_demonstration_1.png";
+describe.skip("fetchRemoteImages", () => {
+    let dir;
+    beforeEach(() => {
+        dir = tmp_1.default.dirSync();
+    });
+    test("should download image file", () => {
+        const $ = cheerio_1.default.load(`<img src="${URL}" />`);
+        return fetchRemoteImages_1.default(dir.name, "index.html", $).then(() => {
+            const $img = $("img");
+            const src = $img.attr("src");
+            expect(dir.name).toHaveFile(src);
+        });
+    });
+    test("should download image file and replace with relative path", () => {
+        const $ = cheerio_1.default.load(`<img src="${URL}" />`);
+        return fetchRemoteImages_1.default(dir.name, "test/index.html", $).then(() => {
+            const $img = $("img");
+            const src = $img.attr("src");
+            expect(dir.name).toHaveFile(path_1.default.join("test", src));
+        });
+    });
+});