honkit 6.0.4 → 6.1.4

package/lib/__tests__/__fixtures__/honkit/book.d.ts

@@ -0,0 +1,7 @@
+export let root: string;
+export let title: string;
+export let gitbook: string;
+export namespace variables {
+    let version: string;
+}
+//# sourceMappingURL=book.d.ts.map

package/lib/__tests__/__fixtures__/honkit/book.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"book.d.ts","sourceRoot":"","sources":["../../../../src/__tests__/__fixtures__/honkit/book.js"],"names":[],"mappings":""}

package/lib/__tests__/__fixtures__/honkit/book.js

@@ -0,0 +1,9 @@
+module.exports = {
+    root: "./docs",
+    title: "HonKit Documentation",
+    // Enforce use of HonKit v3
+    gitbook: "3.1.1",
+    variables: {
+        version: "3.1.1",
+    },
+};

package/lib/__tests__/e2e.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=e2e.test.d.ts.map

package/lib/__tests__/e2e.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"e2e.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/e2e.test.ts"],"names":[],"mappings":""}

package/lib/__tests__/e2e.test.js

@@ -0,0 +1,81 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const bin_1 = require("../bin");
+const path_1 = __importDefault(require("path"));
+const jest_mock_process_1 = require("jest-mock-process");
+const jest_serializer_strip_ansi_1 = require("@relmify/jest-serializer-strip-ansi");
+const CWD = process.cwd();
+const cwdPlugin = {
+    test: (value) => typeof value === "string" && value.includes(CWD),
+    print: (value, serialize) => {
+        if (typeof value === "string") {
+            return serialize(value.split(CWD).join("<CWD>").replace(/\\/g, "/"));
+        }
+        return value;
+    },
+};
+expect.addSnapshotSerializer(jest_serializer_strip_ansi_1.stripAnsi);
+expect.addSnapshotSerializer(cwdPlugin);
+describe("e2e", function () {
+    let stdoutMock;
+    beforeEach(() => {
+        stdoutMock = (0, jest_mock_process_1.mockProcessStdout)();
+    });
+    afterEach(() => {
+        stdoutMock.mockRestore();
+    });
+    it("`honkit parse` for multilang", async () => {
+        await (0, bin_1.run)([process.argv[0], "honkit", "parse", path_1.default.join(__dirname, "__fixtures__/multilang")]);
+        expect(stdoutMock.mock.calls).toMatchInlineSnapshot(`
+            [
+              [
+                "info: parsing multilingual book, with 2 languages 
+            ",
+              ],
+              [
+                "warn: no summary file in this book 
+            ",
+              ],
+              [
+                "warn: no summary file in this book 
+            ",
+              ],
+              [
+                "info: Book located in: <CWD>/src/__tests__/__fixtures__/multilang 
+            ",
+              ],
+              [
+                "info: 2 languages 
+            ",
+              ],
+              [
+                "info: Language: English 
+            ",
+              ],
+              [
+                "info: Introduction file is README.md 
+            ",
+              ],
+              [
+                "info:  
+            ",
+              ],
+              [
+                "info: Language: Japanese 
+            ",
+              ],
+              [
+                "info: Introduction file is README.md 
+            ",
+              ],
+              [
+                "info:  
+            ",
+              ],
+            ]
+        `);
+    });
+});

package/lib/__tests__/init.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=init.d.ts.map

package/lib/__tests__/init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/__tests__/init.ts"],"names":[],"mappings":""}

package/lib/__tests__/init.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 tmp_1 = __importDefault(require("tmp"));
+const init_1 = __importDefault(require("../init"));
+describe("initBook", () => {
+    let dir;
+    beforeEach(() => {
+        dir = tmp_1.default.dirSync();
+    });
+    test("should create a README and SUMMARY for empty book", () => {
+        return (0, init_1.default)(dir.name).then(() => {
+            expect(dir.name).toHaveFile("README.md");
+            expect(dir.name).toHaveFile("SUMMARY.md");
+        });
+    });
+});

package/lib/__tests__/satisfies.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=satisfies.d.ts.map

package/lib/__tests__/satisfies.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"satisfies.d.ts","sourceRoot":"","sources":["../../src/__tests__/satisfies.ts"],"names":[],"mappings":""}

package/lib/__tests__/satisfies.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 honkit_1 = __importDefault(require("../honkit"));
+describe("satisfies", () => {
+    test("should return true for *", () => {
+        expect(honkit_1.default.satisfies("*")).toBe(true);
+    });
+});

package/lib/__tests__/snapshot-asciidoc.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=snapshot-asciidoc.d.ts.map

package/lib/__tests__/snapshot-asciidoc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot-asciidoc.d.ts","sourceRoot":"","sources":["../../src/__tests__/snapshot-asciidoc.ts"],"names":[],"mappings":""}

package/lib/__tests__/snapshot-asciidoc.js

@@ -0,0 +1,48 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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 internal_test_utils_1 = require("@honkit/internal-test-utils");
+const bin = __importStar(require("../bin"));
+it("asciidoc snapshot", async () => {
+    const bookDir = path_1.default.join(__dirname, "__fixtures__/asciidoc");
+    const outputDir = path_1.default.join(__dirname, "__fixtures__/asciidoc/_book");
+    await bin.run([process.argv[0], ".", "build", bookDir, "--reload"]);
+    const maskContent = (content) => {
+        return content
+            .replace(/gitbook\.page\.hasChanged\(.*\);/g, ``)
+            .replace(/<meta name="generator" content="HonKit .*">/g, "");
+    };
+    for await (const item of (0, internal_test_utils_1.iterateDirectoryContents)({
+        baseDir: outputDir,
+        allowExtensions: [".html"],
+        maskContent
+    })) {
+        expect(item).toMatchSnapshot(item.filePath);
+    }
+}, 60 * 1000);

package/lib/__tests__/snapshot-honkit.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=snapshot-honkit.d.ts.map

package/lib/__tests__/snapshot-honkit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot-honkit.d.ts","sourceRoot":"","sources":["../../src/__tests__/snapshot-honkit.ts"],"names":[],"mappings":""}

package/lib/__tests__/snapshot-honkit.js

@@ -0,0 +1,48 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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 internal_test_utils_1 = require("@honkit/internal-test-utils");
+const bin = __importStar(require("../bin"));
+it("HonKit snapshots", async () => {
+    const bookDir = path_1.default.join(__dirname, "__fixtures__/honkit");
+    const outputDir = path_1.default.join(__dirname, "__fixtures__/honkit/_book");
+    await bin.run([process.argv[0], ".", "build", bookDir, "--reload"]);
+    const maskContent = (content) => {
+        return content
+            .replace(/gitbook\.page\.hasChanged\(.*\);/g, ``)
+            .replace(/<meta name="generator" content="HonKit .*">/g, "");
+    };
+    for await (const item of (0, internal_test_utils_1.iterateDirectoryContents)({
+        baseDir: outputDir,
+        allowExtensions: [".html"],
+        maskContent
+    })) {
+        expect(item).toMatchSnapshot(item.filePath);
+    }
+}, 60 * 1000);

package/lib/constants/__tests__/configSchema.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=configSchema.d.ts.map

package/lib/constants/__tests__/configSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configSchema.d.ts","sourceRoot":"","sources":["../../../src/constants/__tests__/configSchema.ts"],"names":[],"mappings":""}

package/lib/constants/__tests__/configSchema.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 jsonschema_1 = __importDefault(require("jsonschema"));
+const configSchema_1 = __importDefault(require("../configSchema"));
+describe("configSchema", () => {
+    function validate(cfg) {
+        const v = new jsonschema_1.default.Validator();
+        return v.validate(cfg, configSchema_1.default, {
+            propertyName: "config",
+        });
+    }
+    describe("structure", () => {
+        test("should accept dot in filename", () => {
+            const result = validate({
+                structure: {
+                    readme: "book-intro.adoc",
+                },
+            });
+            expect(result.errors.length).toBe(0);
+        });
+        test("should accept uppercase in filename", () => {
+            const result = validate({
+                structure: {
+                    readme: "BOOK.adoc",
+                },
+            });
+            expect(result.errors.length).toBe(0);
+        });
+        test("should not accept filepath", () => {
+            const result = validate({
+                structure: {
+                    readme: "folder/myFile.md",
+                },
+            });
+            expect(result.errors.length).toBe(1);
+        });
+    });
+});

package/lib/fs/__tests__/mock.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=mock.d.ts.map

package/lib/fs/__tests__/mock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock.d.ts","sourceRoot":"","sources":["../../../src/fs/__tests__/mock.ts"],"names":[],"mappings":""}

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 = (0, 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/models/__tests__/config.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=config.d.ts.map

package/lib/models/__tests__/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/models/__tests__/config.ts"],"names":[],"mappings":""}

package/lib/models/__tests__/config.js

@@ -0,0 +1,164 @@
+"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 config_1 = __importDefault(require("../config"));
+describe("Config", () => {
+    const config = config_1.default.createWithValues({
+        hello: {
+            world: 1,
+            test: "Hello",
+            isFalse: false,
+        },
+    });
+    describe("getValue", () => {
+        test("must return value as immutable", () => {
+            const value = config.getValue("hello");
+            expect(immutable_1.default.Map.isMap(value)).toBeTruthy();
+        });
+        test("must return deep value", () => {
+            const value = config.getValue("hello.world");
+            expect(value).toBe(1);
+        });
+        test("must return default value if non existant", () => {
+            const value = config.getValue("hello.nonExistant", "defaultValue");
+            expect(value).toBe("defaultValue");
+        });
+        test("must not return default value for falsy values", () => {
+            const value = config.getValue("hello.isFalse", "defaultValue");
+            expect(value).toBe(false);
+        });
+    });
+    describe("setValue", () => {
+        test("must set value as immutable", () => {
+            const testConfig = config.setValue("hello", {
+                cool: 1,
+            });
+            const value = testConfig.getValue("hello");
+            expect(immutable_1.default.Map.isMap(value)).toBeTruthy();
+            expect(value.size).toBe(1);
+            expect(value.has("cool")).toBeTruthy();
+        });
+        test("must set deep value", () => {
+            const testConfig = config.setValue("hello.world", 2);
+            const hello = testConfig.getValue("hello");
+            const world = testConfig.getValue("hello.world");
+            expect(immutable_1.default.Map.isMap(hello)).toBeTruthy();
+            expect(hello.size).toBe(3);
+            expect(world).toBe(2);
+        });
+    });
+    describe("toReducedVersion", () => {
+        test("must only return diffs for simple values", () => {
+            const _config = config_1.default.createWithValues({
+                gitbook: "3.0.0",
+            });
+            const reducedVersion = _config.toReducedVersion();
+            expect(reducedVersion.toJS()).toEqual({
+                gitbook: "3.0.0",
+            });
+        });
+        test("must only return diffs for deep values", () => {
+            const _config = config_1.default.createWithValues({
+                structure: {
+                    readme: "intro.md",
+                },
+            });
+            const reducedVersion = _config.toReducedVersion();
+            expect(reducedVersion.toJS()).toEqual({
+                structure: {
+                    readme: "intro.md",
+                },
+            });
+        });
+    });
+    describe("getPluginDependencies", () => {
+        const config = config_1.default.createWithValues({
+            plugins: [
+                "example",
+                "honkit-plugin-example",
+                "@example/example",
+                "@example/honkit-plugin-example",
+                "@honkit/honkit-plugin-example",
+                "-no-use",
+                "-honkit-plugin-no-use",
+                "-@honkit/honkit-plugin-no-use",
+                // GitBook logic - deprecated
+                "example-v@1.0.0",
+                "gitbook-plugin-example-v@1.0.0",
+                "example@git+ssh://samy@github.com/GitbookIO/plugin-ga.git",
+            ],
+        });
+        const dependencies = config.getPluginDependencies();
+        expect(dependencies.toJS()).toEqual([
+            {
+                enabled: true,
+                name: "example",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: true,
+                name: "honkit-plugin-example",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: true,
+                name: "@example/example",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: true,
+                name: "@example/honkit-plugin-example",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: true,
+                name: "@honkit/honkit-plugin-example",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: false,
+                name: "no-use",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: false,
+                name: "honkit-plugin-no-use",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: false,
+                name: "@honkit/honkit-plugin-no-use",
+                path: "",
+                version: "*",
+            },
+            {
+                enabled: true,
+                name: "example-v",
+                path: "",
+                version: "1.0.0",
+            },
+            {
+                enabled: true,
+                name: "gitbook-plugin-example-v",
+                path: "",
+                version: "1.0.0",
+            },
+            {
+                enabled: true,
+                name: "example",
+                path: "",
+                version: "git+ssh://samy@github.com/GitbookIO/plugin-ga.git",
+            },
+        ]);
+    });
+});

package/lib/models/__tests__/glossary.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=glossary.d.ts.map

package/lib/models/__tests__/glossary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"glossary.d.ts","sourceRoot":"","sources":["../../../src/models/__tests__/glossary.ts"],"names":[],"mappings":""}

package/lib/models/__tests__/glossary.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const file_1 = __importDefault(require("../file"));
+const glossary_1 = __importDefault(require("../glossary"));
+const glossaryEntry_1 = __importDefault(require("../glossaryEntry"));
+describe("Glossary", () => {
+    const glossary = glossary_1.default.createFromEntries(new file_1.default(), [
+        {
+            name: "Hello World",
+            description: "Awesome!",
+        },
+        {
+            name: "JavaScript",
+            description: "This is a cool language",
+        },
+    ]);
+    describe("createFromEntries", () => {
+        test("must add all entries", () => {
+            const entries = glossary.getEntries();
+            expect(entries.size).toBe(2);
+        });
+        test("must add entries as GlossaryEntries", () => {
+            const entries = glossary.getEntries();
+            const entry = entries.get("hello-world");
+            expect(entry instanceof glossaryEntry_1.default).toBeTruthy();
+        });
+    });
+    describe("toText", () => {
+        test("return as markdown", () => {
+            return glossary.toText(".md").then((text) => {
+                expect(text).toContain("# Glossary");
+            });
+        });
+    });
+});

package/lib/models/__tests__/glossaryEntry.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=glossaryEntry.d.ts.map

package/lib/models/__tests__/glossaryEntry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"glossaryEntry.d.ts","sourceRoot":"","sources":["../../../src/models/__tests__/glossaryEntry.ts"],"names":[],"mappings":""}

package/lib/models/__tests__/glossaryEntry.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const glossaryEntry_1 = __importDefault(require("../glossaryEntry"));
+describe("GlossaryEntry", () => {
+    describe("getID", () => {
+        test("must return a normalized ID", () => {
+            const entry = new glossaryEntry_1.default({
+                name: "Hello World",
+            });
+            expect(entry.getID()).toBe("hello-world");
+        });
+    });
+});

package/lib/models/__tests__/page.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=page.d.ts.map

package/lib/models/__tests__/page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page.d.ts","sourceRoot":"","sources":["../../../src/models/__tests__/page.ts"],"names":[],"mappings":""}