honkit 3.6.21

package/lib/output/testing/generateMock.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateMockBook = void 0;
+const mock_1 = __importDefault(require("../../fs/mock"));
+const tmp_1 = __importDefault(require("tmp"));
+const book_1 = __importDefault(require("../../models/book"));
+const parseBook_1 = __importDefault(require("../../parse/parseBook"));
+const generateBook_1 = require("../generateBook");
+/**
+ * Generate a book using a generator
+ * And returns the path to the output dir.
+ *
+ * FOR TESTING PURPOSE ONLY
+ *
+ * @param Generator
+ * @param {Map<String:String|Map>} files
+ * @return {Promise<String>}
+ */
+function generateMockBook(Generator, files) {
+    const fs = mock_1.default(files);
+    let book = book_1.default.createForFS(fs);
+    const dir = tmp_1.default.dirSync();
+    book = book.setLogLevel("disabled");
+    return parseBook_1.default(book)
+        .then((resultBook) => {
+        return generateBook_1.generateBook(Generator, resultBook, {
+            root: dir.name,
+        });
+    })
+        .then((output) => {
+        return {
+            book,
+            output,
+            dir: dir.name,
+        };
+    });
+}
+exports.generateMockBook = generateMockBook;
+/**
+ * Generate a book using a generator
+ * And returns the path to the output dir.
+ *
+ * FOR TESTING PURPOSE ONLY
+ *
+ * @param Generator
+ * @param {Map<String:String|Map>} files
+ * @return {Promise<String>}
+ */
+function generateMock(Generator, files) {
+    return generateMockBook(Generator, files).then((ret) => ret.dir);
+}
+exports.default = generateMock;

package/lib/output/website/__tests__/i18n.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const createTemplateEngine_1 = __importDefault(require("../createTemplateEngine"));
+const createMock_1 = __importDefault(require("../../testing/createMock"));
+const prepareI18n_1 = __importDefault(require("../prepareI18n"));
+const __1 = __importDefault(require("../"));
+describe("i18n", () => {
+    test("should correctly use english as default language", () => {
+        // @ts-expect-error
+        return createMock_1.default(__1.default, {
+            "README.md": "Hello World"
+        })
+            .then((output) => {
+            return prepareI18n_1.default(output);
+        })
+            .then((output) => {
+            const engine = createTemplateEngine_1.default(output, "README.md");
+            const t = engine.getFilters().get("t");
+            expect(t("SUMMARY_INTRODUCTION")).toEqual("Introduction");
+        });
+    });
+    test("should correctly use language from book.json", () => {
+        // @ts-expect-error
+        return createMock_1.default(__1.default, {
+            "README.md": "Hello World",
+            "book.json": JSON.stringify({ language: "fr" })
+        })
+            .then((output) => {
+            return prepareI18n_1.default(output);
+        })
+            .then((output) => {
+            const engine = createTemplateEngine_1.default(output, "README.md");
+            const t = engine.getFilters().get("t");
+            expect(t("GITBOOK_LINK")).toEqual("Publié avec HonKit");
+        });
+    });
+});

package/lib/output/website/copyPluginAssets.js

@@ -0,0 +1,92 @@
+"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 pluginAssetsFolder_1 = __importDefault(require("../../constants/pluginAssetsFolder"));
+const promise_1 = __importDefault(require("../../utils/promise"));
+const fs_1 = __importDefault(require("../../utils/fs"));
+/**
+ Copy all assets from plugins.
+ Assets are files stored in "_assets"
+ nd resources declared in the plugin itself.
+
+ @param {Output}
+ @return {Promise}
+ */
+function copyPluginAssets(output) {
+    const book = output.getBook();
+    // Don't copy plugins assets for language book
+    // It'll be resolved to the parent folder
+    if (book.isLanguageBook()) {
+        return promise_1.default(output);
+    }
+    const plugins = output
+        .getPlugins()
+        // We reverse the order of plugins to copy
+        // so that first plugins can replace assets from other plugins.
+        .reverse();
+    return promise_1.default.forEach(plugins, (plugin) => {
+        return copyAssets(output, plugin).then(() => {
+            return copyResources(output, plugin);
+        });
+    }).thenResolve(output);
+}
+/**
+ Copy assets from a plugin
+
+ @param {Plugin}
+ @return {Promise}
+ */
+function copyAssets(output, plugin) {
+    const logger = output.getLogger();
+    const pluginRoot = plugin.getPath();
+    const options = output.getOptions();
+    const outputRoot = options.get("root");
+    const assetOutputFolder = path_1.default.join(outputRoot, "gitbook");
+    const prefix = options.get("prefix");
+    const assetFolder = path_1.default.join(pluginRoot, pluginAssetsFolder_1.default, prefix);
+    if (!fs_1.default.existsSync(assetFolder)) {
+        return promise_1.default();
+    }
+    logger.debug.ln("copy assets from theme", assetFolder);
+    return fs_1.default.copyDir(assetFolder, assetOutputFolder, {
+        deleteFirst: false,
+        overwrite: true,
+        confirm: false,
+    });
+}
+/**
+ Copy resources from a plugin
+
+ @param {Plugin}
+ @return {Promise}
+ */
+function copyResources(output, plugin) {
+    const logger = output.getLogger();
+    const options = output.getOptions();
+    const outputRoot = options.get("root");
+    const state = output.getState();
+    const resources = state.getResources();
+    const pluginRoot = plugin.getPath();
+    const pluginResources = resources.get(plugin.getName());
+    let assetsFolder = pluginResources.get("assets");
+    const assetOutputFolder = path_1.default.join(outputRoot, "gitbook", plugin.getNpmID());
+    if (!assetsFolder) {
+        return promise_1.default();
+    }
+    // Resolve assets folder
+    assetsFolder = path_1.default.resolve(pluginRoot, assetsFolder);
+    if (!fs_1.default.existsSync(assetsFolder)) {
+        logger.warn.ln(`assets folder for plugin "${plugin.getName()}" doesn't exist`);
+        return promise_1.default();
+    }
+    logger.debug.ln("copy resources from plugin", assetsFolder);
+    return fs_1.default.copyDir(assetsFolder, assetOutputFolder, {
+        deleteFirst: false,
+        overwrite: true,
+        confirm: false,
+    });
+}
+exports.default = copyPluginAssets;

package/lib/output/website/createTemplateEngine.js

@@ -0,0 +1,136 @@
+"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 nunjucks_1 = __importDefault(require("nunjucks"));
+const nunjucks_do_1 = __importDefault(require("nunjucks-do"));
+const DoExtension = nunjucks_do_1.default(nunjucks_1.default);
+const memoize_one_1 = __importDefault(require("memoize-one"));
+const api_1 = __importDefault(require("../../api"));
+const deprecate_1 = __importDefault(require("../../api/deprecate"));
+const json_1 = __importDefault(require("../../json"));
+const location_1 = __importDefault(require("../../utils/location"));
+const fs_1 = __importDefault(require("../../utils/fs"));
+const path_2 = __importDefault(require("../../utils/path"));
+const templateEngine_1 = __importDefault(require("../../models/templateEngine"));
+const templatesFolder_1 = __importDefault(require("../../constants/templatesFolder"));
+const defaultFilters_1 = __importDefault(require("../../constants/defaultFilters"));
+const templating_1 = __importDefault(require("../../templating"));
+const listSearchPaths_1 = __importDefault(require("./listSearchPaths"));
+const fileToURL_1 = __importDefault(require("../helper/fileToURL"));
+const resolveFileToURL_1 = __importDefault(require("../helper/resolveFileToURL"));
+/**
+ * Directory for a theme with the templates
+ */
+function templateFolder(dir) {
+    return path_1.default.join(dir, templatesFolder_1.default);
+}
+/**
+ * Create templating engine to render themes
+ *
+ * @param {Output} output
+ * @param {string} currentFile
+ * @return {TemplateEngine}
+ */
+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();
+    const outputFolder = output.getRoot();
+    // Search paths for templates
+    const searchPaths = listSearchPaths_1.default(output);
+    const tplSearchPaths = searchPaths.map(templateFolder);
+    // Create loader
+    // @ts-expect-error: Expected 0 arguments, but got 1.
+    const loader = new templating_1.default.ThemesLoader(tplSearchPaths);
+    // Get languages
+    const language = config.getValue("language");
+    // Create API context
+    const context = api_1.default.encodeGlobal(output);
+    /**
+     * Check if a file exists
+     * @param {string} fileName
+     * @return {boolean}
+     */
+    function fileExists(fileName) {
+        if (!fileName) {
+            return false;
+        }
+        // @ts-expect-error ts-migrate(2554) FIXME: Expected 1 arguments, but got 2.
+        const filePath = path_2.default.resolveInRoot(outputFolder, fileName);
+        return fs_1.default.existsSync(filePath);
+    }
+    /**
+     * Return an article by its path
+     * @param {string} filePath
+     * @return {Object|undefined}
+     */
+    function getArticleByPath(filePath) {
+        const article = summary.getByPath(filePath);
+        if (!article)
+            return undefined;
+        // @ts-expect-error ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
+        return json_1.default.encodeSummaryArticle(article);
+    }
+    /**
+     * Return a page by its path
+     * @param {string} filePath
+     * @return {Object|undefined}
+     */
+    function getPageByPath(filePath) {
+        const page = output.getPage(filePath);
+        if (!page)
+            return undefined;
+        return json_1.default.encodePage(page, summary);
+    }
+    return templateEngine_1.default.create({
+        loader: loader,
+        context: context,
+        globals: {
+            getArticleByPath: memoize_one_1.default(getArticleByPath),
+            getPageByPath: memoize_one_1.default(getPageByPath),
+            fileExists: fileExists,
+        },
+        filters: defaultFilters_1.default.merge({
+            /**
+             * Translate a sentence
+             */
+            t: function t(s) {
+                return i18n.t(language, s);
+            },
+            /**
+             * Resolve an absolute file path into a
+             * relative path.
+             * it also resolve pages
+             */
+            resolveFile: function (filePath) {
+                filePath = resolveFileToURL_1.default(output, filePath);
+                return location_1.default.relativeForFile(currentFile, filePath);
+            },
+            resolveAsset: function (filePath) {
+                filePath = location_1.default.toAbsolute(filePath, "", "");
+                filePath = path_1.default.join("gitbook", filePath);
+                filePath = location_1.default.relativeForFile(currentFile, filePath);
+                // Use assets from parent if language book
+                if (book.isLanguageBook()) {
+                    filePath = path_1.default.join("../", filePath);
+                }
+                return location_1.default.normalize(filePath);
+            },
+            fileExists: deprecate_1.default.method(book, "fileExists", fileExists, 'Filter "fileExists" is deprecated, use "fileExists(filename)" '),
+            getArticleByPath: deprecate_1.default.method(book, "getArticleByPath", fileExists, 'Filter "getArticleByPath" is deprecated, use "getArticleByPath(filename)" '),
+            contentURL: function (filePath) {
+                return fileToURL_1.default(output, filePath);
+            },
+        }),
+        extensions: {
+            DoExtension: new DoExtension(),
+        },
+    });
+}
+exports.default = createTemplateEngine;

package/lib/output/website/index.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 onPage_1 = require("./onPage");
+const onFinish_1 = require("./onFinish");
+const state_1 = __importDefault(require("./state"));
+const options_1 = __importDefault(require("./options"));
+const onInit_1 = __importDefault(require("./onInit"));
+const onAsset_1 = __importDefault(require("./onAsset"));
+const createTemplateEngine_1 = __importDefault(require("./createTemplateEngine"));
+exports.default = {
+    name: "website",
+    State: state_1.default,
+    Options: options_1.default,
+    onInit: onInit_1.default,
+    onFinish: onFinish_1.onFinish,
+    onPage: onPage_1.onPage,
+    onAsset: onAsset_1.default,
+    createTemplateEngine: createTemplateEngine_1.default,
+};

package/lib/output/website/listSearchPaths.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ List search paths for templates / i18n, etc
+
+ @param {Output} output
+ @return {List<String>}
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+function listSearchPaths(output) {
+    const book = output.getBook();
+    const plugins = output.getPlugins();
+    const searchPaths = plugins
+        .valueSeq()
+        .map((plugin) => {
+        return plugin.getPath();
+    })
+        .toList();
+    return searchPaths.unshift(book.getContentRoot());
+}
+exports.default = listSearchPaths;

package/lib/output/website/onAsset.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 path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("../../utils/fs"));
+/**
+ Copy an asset to the output folder
+
+ @param {Output} output
+ @param {Page} page
+ */
+function onAsset(output, asset) {
+    const book = output.getBook();
+    const options = output.getOptions();
+    const bookFS = book.getContentFS();
+    const outputFolder = options.get("root");
+    const outputPath = path_1.default.resolve(outputFolder, asset);
+    return fs_1.default
+        .ensureFile(outputPath)
+        .then(() => {
+        return bookFS.readAsStream(asset).then((stream) => {
+            return fs_1.default.writeStream(outputPath, stream);
+        });
+    })
+        .thenResolve(output);
+}
+exports.default = onAsset;

package/lib/output/website/onFinish.js

@@ -0,0 +1,35 @@
+"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 promise_1 = __importDefault(require("../../utils/promise"));
+const json_1 = __importDefault(require("../../json"));
+const templating_1 = __importDefault(require("../../templating"));
+const writeFile_1 = __importDefault(require("../helper/writeFile"));
+const createTemplateEngine_1 = __importDefault(require("./createTemplateEngine"));
+/**
+ Finish the generation, write the languages index
+
+ @param {Output} output
+ @return {Output}
+ */
+function onFinish(output) {
+    const book = output.getBook();
+    const options = output.getOptions();
+    const prefix = options.get("prefix");
+    if (!book.isMultilingual()) {
+        return promise_1.default(output);
+    }
+    const filePath = "index.html";
+    const engine = createTemplateEngine_1.default(output, filePath);
+    const context = json_1.default.encodeOutput(output);
+    // Render the theme
+    return (templating_1.default.renderFile(engine, `${prefix}/languages.html`, context)
+        // Write it to the disk
+        .then((tplOut) => {
+        return writeFile_1.default(output, filePath, tplOut.getContent());
+    }));
+}
+exports.onFinish = onFinish;

package/lib/output/website/onInit.js

@@ -0,0 +1,19 @@
+"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 copyPluginAssets_1 = __importDefault(require("./copyPluginAssets"));
+const prepareI18n_1 = __importDefault(require("./prepareI18n"));
+const prepareResources_1 = __importDefault(require("./prepareResources"));
+/**
+ Initialize the generator
+
+ @param {Output}
+ @return {Output}
+ */
+function onInit(output) {
+    return promise_1.default(output).then(prepareI18n_1.default).then(prepareResources_1.default).then(copyPluginAssets_1.default);
+}
+exports.default = onInit;