honkit 3.6.21

package/lib/constants/defaultFilters.js

@@ -0,0 +1,18 @@
+"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 moment_1 = __importDefault(require("moment"));
+exports.default = immutable_1.default.Map({
+    // Format a date
+    // ex: 'MMMM Do YYYY, h:mm:ss a
+    date: function (time, format) {
+        return moment_1.default(time).format(format);
+    },
+    // Relative Time
+    dateFromNow: function (time) {
+        return moment_1.default(time).fromNow();
+    },
+});

package/lib/constants/defaultPlugins.js

@@ -0,0 +1,20 @@
+"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 pluginDependency_1 = __importDefault(require("../models/pluginDependency"));
+const pkg = require("../../package.json");
+/**
+ * Create a PluginDependency from a dependency of gitbook
+ * @param {string} pluginName
+ * @return {PluginDependency}
+ */
+function createFromDependency(pluginName) {
+    const npmID = pluginDependency_1.default.nameToNpmID(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/constants/extsAsciidoc.js

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

package/lib/constants/extsMarkdown.js

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

package/lib/constants/ignoreFiles.js

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

package/lib/constants/pluginAssetsFolder.js

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

package/lib/constants/pluginHooks.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = ["init", "finish", "finish:before", "config", "page", "page:before"];

package/lib/constants/pluginPrefix.js

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

package/lib/constants/pluginResources.js

@@ -0,0 +1,7 @@
+"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"));
+exports.default = immutable_1.default.List(["js", "css"]);

package/lib/constants/templatesFolder.js

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

package/lib/constants/themePrefix.js

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

package/lib/fs/__tests__/mock.js

@@ -0,0 +1,68 @@
+"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("../mock"));
+describe("MockFS", () => {
+    const fs = mock_1.default({
+        "README.md": "Hello World",
+        "SUMMARY.md": "# Summary",
+        folder: {
+            "test.md": "Cool",
+            folder2: {
+                "hello.md": "Hello",
+                "world.md": "World"
+            }
+        }
+    });
+    describe("exists", () => {
+        test("must return true for a file", () => {
+            return fs.exists("README.md").then((result) => {
+                expect(result).toBeTruthy();
+            });
+        });
+        test("must return false for a non existing file", () => {
+            return fs.exists("README_NOTEXISTS.md").then((result) => {
+                expect(result).toBeFalsy();
+            });
+        });
+        test("must return true for a directory", () => {
+            return fs.exists("folder").then((result) => {
+                expect(result).toBeTruthy();
+            });
+        });
+        test("must return true for a deep file", () => {
+            return fs.exists("folder/test.md").then((result) => {
+                expect(result).toBeTruthy();
+            });
+        });
+        test("must return true for a deep file (2)", () => {
+            return fs.exists("folder/folder2/hello.md").then((result) => {
+                expect(result).toBeTruthy();
+            });
+        });
+    });
+    describe("readAsString", () => {
+        test("must return content for a file", () => {
+            return fs.readAsString("README.md").then((result) => {
+                expect(result).toBe("Hello World");
+            });
+        });
+        test("must return content for a deep file", () => {
+            return fs.readAsString("folder/test.md").then((result) => {
+                expect(result).toBe("Cool");
+            });
+        });
+    });
+    describe("readDir", () => {
+        test("must return content for a directory", () => {
+            return fs.readDir("./").then((files) => {
+                expect(files.size).toBe(3);
+                expect(files.includes("README.md")).toBeTruthy();
+                expect(files.includes("SUMMARY.md")).toBeTruthy();
+                expect(files.includes("folder/")).toBeTruthy();
+            });
+        });
+    });
+});

package/lib/fs/mock.js

@@ -0,0 +1,88 @@
+"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 is_1 = __importDefault(require("is"));
+const buffer_1 = require("buffer");
+const immutable_1 = __importDefault(require("immutable"));
+const fs_1 = __importDefault(require("../models/fs"));
+const error_1 = __importDefault(require("../utils/error"));
+/**
+ Create a fake filesystem for unit testing HonKit.
+
+ @param {Map<String:String|Map>}
+ */
+function createMockFS(files) {
+    files = immutable_1.default.fromJS(files);
+    const mtime = new Date();
+    function getFile(filePath) {
+        const parts = path_1.default.normalize(filePath).split(path_1.default.sep);
+        return parts.reduce((list, part, i) => {
+            if (!list)
+                return null;
+            let file;
+            if (!part || part === ".")
+                file = list;
+            else
+                file = list.get(part);
+            if (!file)
+                return null;
+            if (is_1.default.string(file)) {
+                if (i === parts.length - 1)
+                    return file;
+                else
+                    return null;
+            }
+            return file;
+        }, files);
+    }
+    function fsExists(filePath) {
+        return Boolean(getFile(filePath) !== null);
+    }
+    function fsReadFile(filePath) {
+        const file = getFile(filePath);
+        if (!is_1.default.string(file)) {
+            throw error_1.default.FileNotFoundError({
+                filename: filePath,
+            });
+        }
+        return buffer_1.Buffer.from(file, "utf8");
+    }
+    function fsStatFile(filePath) {
+        const file = getFile(filePath);
+        if (!file) {
+            throw error_1.default.FileNotFoundError({
+                filename: filePath,
+            });
+        }
+        return {
+            mtime: mtime,
+        };
+    }
+    function fsReadDir(filePath) {
+        const dir = getFile(filePath);
+        if (!dir || is_1.default.string(dir)) {
+            throw error_1.default.FileNotFoundError({
+                filename: filePath,
+            });
+        }
+        return dir
+            .map((content, name) => {
+            if (!is_1.default.string(content)) {
+                name = `${name}/`;
+            }
+            return name;
+        })
+            .valueSeq();
+    }
+    return fs_1.default.create({
+        root: "",
+        fsExists: fsExists,
+        fsReadFile: fsReadFile,
+        fsStatFile: fsStatFile,
+        fsReadDir: fsReadDir,
+    });
+}
+exports.default = createMockFS;

package/lib/fs/node.js

@@ -0,0 +1,44 @@
+"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 fs_1 = __importDefault(require("../utils/fs"));
+const fs_2 = __importDefault(require("../models/fs"));
+function fsReadDir(folder) {
+    return fs_1.default.readdir(folder).then((files) => {
+        files = immutable_1.default.List(files);
+        return files
+            .map((file) => {
+            if (file === "." || file === "..")
+                return;
+            const stat = fs_1.default.statSync(path_1.default.join(folder, file));
+            if (stat.isSymbolicLink()) {
+                return;
+            }
+            if (stat.isDirectory())
+                file = file + path_1.default.sep;
+            return file;
+        })
+            .filter((file) => {
+            return Boolean(file);
+        });
+    });
+}
+function fsLoadObject(filename) {
+    return require(filename);
+}
+function createNodeFS(root) {
+    return fs_2.default.create({
+        root: root,
+        fsExists: fs_1.default.exists,
+        fsReadFile: fs_1.default.readFile,
+        fsStatFile: fs_1.default.stat,
+        fsReadDir: fsReadDir,
+        fsLoadObject: fsLoadObject,
+        fsReadAsStream: fs_1.default.readStream,
+    });
+}
+exports.default = createNodeFS;

package/lib/honkit.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const semver_1 = __importDefault(require("semver"));
+const pkg = require("../package.json");
+const VERSION = pkg.version;
+const VERSION_STABLE = VERSION.replace(/-(\S+)/g, "");
+const START_TIME = new Date();
+/**
+ Verify that this gitbook version satisfies a requirement
+ We can't directly use samver.satisfies since it will break all plugins when gitbook version is a prerelease (beta, alpha)
+
+ @param {string} condition
+ @return {boolean}
+ */
+function satisfies(condition) {
+    // Test with real version
+    if (semver_1.default.satisfies(VERSION, condition))
+        return true;
+    // If plugin require -alpha -beta engine, skip it
+    // https://github.com/honkit/honkit/issues/42
+    if (/-(\S+)$/.test(condition)) {
+        return true;
+    }
+    // Test with future stable release
+    return semver_1.default.satisfies(VERSION_STABLE, condition);
+}
+exports.default = {
+    version: pkg.version,
+    satisfies: satisfies,
+    START_TIME: START_TIME,
+};

package/lib/index.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 extend_1 = __importDefault(require("extend"));
+const browser_1 = __importDefault(require("./browser"));
+const init_1 = __importDefault(require("./init"));
+const node_1 = __importDefault(require("./fs/node"));
+const output_1 = __importDefault(require("./output"));
+const cli_1 = __importDefault(require("./cli"));
+exports.default = extend_1.default({
+    initBook: init_1.default,
+    createNodeFS: node_1.default,
+    Output: output_1.default,
+    commands: cli_1.default,
+}, browser_1.default);

package/lib/init.js

@@ -0,0 +1,79 @@
+"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 node_1 = __importDefault(require("./fs/node"));
+const fs_1 = __importDefault(require("./utils/fs"));
+const promise_1 = __importDefault(require("./utils/promise"));
+const file_1 = __importDefault(require("./models/file"));
+const readme_1 = __importDefault(require("./models/readme"));
+const book_1 = __importDefault(require("./models/book"));
+const parse_1 = __importDefault(require("./parse"));
+/**
+ Initialize folder structure for a book
+ Read SUMMARY to created the right chapter
+
+ @param {Book}
+ @param {string}
+ @return {Promise}
+ */
+function initBook(rootFolder) {
+    const extension = ".md";
+    return (fs_1.default
+        .mkdirp(rootFolder)
+        // Parse the summary and readme
+        .then(() => {
+        const fs = node_1.default(rootFolder);
+        const book = book_1.default.createForFS(fs);
+        return (parse_1.default.parseReadme(book)
+            // Setup default readme if doesn't found one
+            .fail(() => {
+            const readmeFile = file_1.default.createWithFilepath(`README${extension}`);
+            // @ts-expect-error ts-migrate(2339) FIXME: Property 'create' does not exist on type 'Class'.
+            const readme = readme_1.default.create(readmeFile);
+            return book.setReadme(readme);
+        }));
+    })
+        .then(parse_1.default.parseSummary)
+        .then((book) => {
+        const logger = book.getLogger();
+        const summary = book.getSummary();
+        const summaryFile = summary.getFile();
+        const summaryFilename = summaryFile.getPath() || `SUMMARY${extension}`;
+        const articles = summary.getArticlesAsList();
+        // Write pages
+        return (promise_1.default.forEach(articles, (article) => {
+            const articlePath = article.getPath();
+            const filePath = articlePath ? path_1.default.join(rootFolder, articlePath) : null;
+            if (!filePath) {
+                return;
+            }
+            return fs_1.default.assertFile(filePath, () => {
+                return fs_1.default.ensureFile(filePath).then(() => {
+                    logger.info.ln("create", article.getPath());
+                    return fs_1.default.writeFile(filePath, `# ${article.getTitle()}\n\n`);
+                });
+            });
+        })
+            // Write summary
+            .then(() => {
+            const filePath = path_1.default.join(rootFolder, summaryFilename);
+            return fs_1.default
+                .ensureFile(filePath)
+                .then(() => {
+                logger.info.ln(`create ${path_1.default.basename(filePath)}`);
+                return summary.toText(extension);
+            })
+                .then((content) => {
+                return fs_1.default.writeFile(filePath, content);
+            });
+        })
+            // Log end
+            .then(() => {
+            logger.info.ln("initialization is finished");
+        }));
+    }));
+}
+exports.default = initBook;

package/lib/json/encodeBook.js

@@ -0,0 +1,41 @@
+"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 honkit_1 = __importDefault(require("../honkit"));
+const encodeSummary_1 = __importDefault(require("./encodeSummary"));
+const encodeGlossary_1 = __importDefault(require("./encodeGlossary"));
+const encodeReadme_1 = __importDefault(require("./encodeReadme"));
+const encodeLanguages_1 = __importDefault(require("./encodeLanguages"));
+/**
+ Encode a book to JSON
+
+ @param {Book}
+ @return {Object}
+ */
+function encodeBookToJson(book) {
+    const config = book.getConfig();
+    const language = book.getLanguage();
+    const variables = config.getValue("variables", {});
+    return {
+        summary: encodeSummary_1.default(book.getSummary()),
+        glossary: encodeGlossary_1.default(book.getGlossary()),
+        readme: encodeReadme_1.default(book.getReadme()),
+        config: book.getConfig().getValues().toJS(),
+        languages: book.isMultilingual() ? encodeLanguages_1.default(book.getLanguages()) : undefined,
+        gitbook: {
+            version: honkit_1.default.version,
+            time: honkit_1.default.START_TIME,
+        },
+        honkit: {
+            version: honkit_1.default.version,
+            time: honkit_1.default.START_TIME,
+        },
+        book: extend_1.default({
+            language: language ? language : undefined,
+        }, variables.toJS()),
+    };
+}
+exports.default = encodeBookToJson;