honkit 6.0.4 → 6.1.5

package/lib/modifiers/summary/__tests__/editPartTitle.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 summary_1 = __importDefault(require("../../../models/summary"));
+const file_1 = __importDefault(require("../../../models/file"));
+const editPartTitle_1 = __importDefault(require("../editPartTitle"));
+describe("editPartTitle", () => {
+    const summary = summary_1.default.createFromParts(new file_1.default(), [
+        {
+            articles: [
+                {
+                    title: "My First Article",
+                    path: "README.md",
+                },
+                {
+                    title: "My Second Article",
+                    path: "article.md",
+                },
+            ],
+        },
+        {
+            title: "Test",
+        },
+    ]);
+    test("should correctly set title of first part", () => {
+        const newSummary = (0, editPartTitle_1.default)(summary, 0, "Hello World");
+        const part = newSummary.getPart(0);
+        expect(part.getTitle()).toBe("Hello World");
+    });
+    test("should correctly set title of second part", () => {
+        const newSummary = (0, editPartTitle_1.default)(summary, 1, "Hello");
+        const part = newSummary.getPart(1);
+        expect(part.getTitle()).toBe("Hello");
+    });
+    test("should not fail if part doesn't exist", () => {
+        const newSummary = (0, editPartTitle_1.default)(summary, 3, "Hello");
+        expect(newSummary.getParts().size).toBe(2);
+    });
+});

package/lib/modifiers/summary/__tests__/insertArticle.d.ts

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

package/lib/modifiers/summary/__tests__/insertArticle.d.ts.map

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

package/lib/modifiers/summary/__tests__/insertArticle.js

@@ -0,0 +1,72 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const summary_1 = __importDefault(require("../../../models/summary"));
+const summaryArticle_1 = __importDefault(require("../../../models/summaryArticle"));
+const file_1 = __importDefault(require("../../../models/file"));
+const insertArticle_1 = __importDefault(require("../insertArticle"));
+describe("insertArticle", () => {
+    const summary = summary_1.default.createFromParts(new file_1.default(), [
+        {
+            articles: [
+                {
+                    title: "1.1",
+                    path: "1.1",
+                },
+                {
+                    title: "1.2",
+                    path: "1.2",
+                },
+            ],
+        },
+        {
+            title: "Part I",
+            articles: [
+                {
+                    title: "2.1",
+                    path: "2.1",
+                    articles: [
+                        {
+                            title: "2.1.1",
+                            path: "2.1.1",
+                        },
+                        {
+                            title: "2.1.2",
+                            path: "2.1.2",
+                        },
+                    ],
+                },
+                {
+                    title: "2.2",
+                    path: "2.2",
+                },
+            ],
+        },
+    ]);
+    test("should insert an article at a given level", () => {
+        const article = summaryArticle_1.default.create({
+            title: "Inserted",
+        }, "fake.level");
+        const newSummary = (0, insertArticle_1.default)(summary, article, "2.1.1");
+        const inserted = newSummary.getByLevel("2.1.1");
+        const nextOne = newSummary.getByLevel("2.1.2");
+        expect(inserted.getTitle()).toBe("Inserted");
+        expect(inserted.getLevel()).toBe("2.1.1");
+        expect(nextOne.getTitle()).toBe("2.1.1");
+        expect(nextOne.getLevel()).toBe("2.1.2");
+    });
+    test("should insert an article in last position", () => {
+        const article = summaryArticle_1.default.create({
+            title: "Inserted",
+        }, "fake.level");
+        const newSummary = (0, insertArticle_1.default)(summary, article, "2.2");
+        const inserted = newSummary.getByLevel("2.2");
+        const previousOne = newSummary.getByLevel("2.1");
+        expect(inserted.getTitle()).toBe("Inserted");
+        expect(inserted.getLevel()).toBe("2.2");
+        expect(previousOne.getTitle()).toBe("2.1"); // Unchanged
+        expect(previousOne.getLevel()).toBe("2.1");
+    });
+});

package/lib/modifiers/summary/__tests__/insertPart.d.ts

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

package/lib/modifiers/summary/__tests__/insertPart.d.ts.map

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

package/lib/modifiers/summary/__tests__/insertPart.js

@@ -0,0 +1,56 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const summary_1 = __importDefault(require("../../../models/summary"));
+const summaryPart_1 = __importDefault(require("../../../models/summaryPart"));
+const file_1 = __importDefault(require("../../../models/file"));
+const insertPart_1 = __importDefault(require("../insertPart"));
+describe("insertPart", () => {
+    const summary = summary_1.default.createFromParts(new file_1.default(), [
+        {
+            articles: [
+                {
+                    title: "1.1",
+                    path: "1.1",
+                },
+            ],
+        },
+        {
+            title: "Part I",
+            articles: [
+                {
+                    title: "2.1",
+                    path: "2.1",
+                    articles: [],
+                },
+                {
+                    title: "2.2",
+                    path: "2.2",
+                },
+            ],
+        },
+    ]);
+    test("should insert an part at a given level", () => {
+        const part = summaryPart_1.default.create({
+            title: "Inserted",
+        }, "meaningless.level");
+        const newSummary = (0, insertPart_1.default)(summary, part, 1);
+        const inserted = newSummary.getPart(1);
+        expect(inserted.getTitle()).toBe("Inserted");
+        expect(newSummary.getParts().count()).toBe(3);
+        const otherArticle = newSummary.getByLevel("3.1");
+        expect(otherArticle.getTitle()).toBe("2.1");
+        expect(otherArticle.getLevel()).toBe("3.1");
+    });
+    test("should insert an part in last position", () => {
+        const part = summaryPart_1.default.create({
+            title: "Inserted",
+        }, "meaningless.level");
+        const newSummary = (0, insertPart_1.default)(summary, part, 2);
+        const inserted = newSummary.getPart(2);
+        expect(inserted.getTitle()).toBe("Inserted");
+        expect(newSummary.getParts().count()).toBe(3);
+    });
+});

package/lib/modifiers/summary/__tests__/mergeAtLevel.d.ts

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

package/lib/modifiers/summary/__tests__/mergeAtLevel.d.ts.map

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

package/lib/modifiers/summary/__tests__/mergeAtLevel.js

@@ -0,0 +1,45 @@
+"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 summary_1 = __importDefault(require("../../../models/summary"));
+const file_1 = __importDefault(require("../../../models/file"));
+const mergeAtLevel_1 = __importDefault(require("../mergeAtLevel"));
+describe("mergeAtLevel", () => {
+    const summary = summary_1.default.createFromParts(new file_1.default(), [
+        {
+            articles: [
+                {
+                    title: "1.1",
+                    path: "1.1",
+                },
+                {
+                    title: "1.2",
+                    path: "1.2",
+                },
+            ],
+        },
+        {
+            title: "Part I",
+            articles: [],
+        },
+    ]);
+    test("should edit a part", () => {
+        const beforeChildren = summary.getByLevel("1").getArticles();
+        const newSummary = (0, mergeAtLevel_1.default)(summary, "1", { title: "Part O" });
+        const edited = newSummary.getByLevel("1");
+        expect(edited.getTitle()).toBe("Part O");
+        // Same children
+        expect(immutable_1.default.is(beforeChildren, edited.getArticles())).toBe(true);
+    });
+    test("should edit a part", () => {
+        const beforePath = summary.getByLevel("1.2").getPath();
+        const newSummary = (0, mergeAtLevel_1.default)(summary, "1.2", { title: "Renamed article" });
+        const edited = newSummary.getByLevel("1.2");
+        expect(edited.getTitle()).toBe("Renamed article");
+        // Same children
+        expect(immutable_1.default.is(beforePath, edited.getPath())).toBe(true);
+    });
+});

package/lib/modifiers/summary/__tests__/moveArticle.d.ts

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

package/lib/modifiers/summary/__tests__/moveArticle.d.ts.map

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

package/lib/modifiers/summary/__tests__/moveArticle.js

@@ -0,0 +1,66 @@
+"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 summary_1 = __importDefault(require("../../../models/summary"));
+const file_1 = __importDefault(require("../../../models/file"));
+const moveArticle_1 = __importDefault(require("../moveArticle"));
+describe("moveArticle", () => {
+    const summary = summary_1.default.createFromParts(new file_1.default(), [
+        {
+            articles: [
+                {
+                    title: "1.1",
+                    path: "1.1",
+                },
+                {
+                    title: "1.2",
+                    path: "1.2",
+                },
+            ],
+        },
+        {
+            title: "Part I",
+            articles: [
+                {
+                    title: "2.1",
+                    path: "2.1",
+                    articles: [
+                        {
+                            title: "2.1.1",
+                            path: "2.1.1",
+                        },
+                        {
+                            title: "2.1.2",
+                            path: "2.1.2",
+                        },
+                    ],
+                },
+                {
+                    title: "2.2",
+                    path: "2.2",
+                },
+            ],
+        },
+    ]);
+    test("should move an article to the same place", () => {
+        const newSummary = (0, moveArticle_1.default)(summary, "2.1", "2.1");
+        expect(immutable_1.default.is(summary, newSummary)).toBe(true);
+    });
+    test("should move an article to an previous level", () => {
+        const newSummary = (0, moveArticle_1.default)(summary, "2.2", "2.1");
+        const moved = newSummary.getByLevel("2.1");
+        const other = newSummary.getByLevel("2.2");
+        expect(moved.getTitle()).toBe("2.2");
+        expect(other.getTitle()).toBe("2.1");
+    });
+    test("should move an article to a next level", () => {
+        const newSummary = (0, moveArticle_1.default)(summary, "2.1", "2.2");
+        const moved = newSummary.getByLevel("2.1");
+        const other = newSummary.getByLevel("2.2");
+        expect(moved.getTitle()).toBe("2.2");
+        expect(other.getTitle()).toBe("2.1");
+    });
+});

package/lib/modifiers/summary/__tests__/moveArticleAfter.d.ts

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

package/lib/modifiers/summary/__tests__/moveArticleAfter.d.ts.map

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

package/lib/modifiers/summary/__tests__/moveArticleAfter.js

@@ -0,0 +1,75 @@
+"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 summary_1 = __importDefault(require("../../../models/summary"));
+const file_1 = __importDefault(require("../../../models/file"));
+const moveArticleAfter_1 = __importDefault(require("../moveArticleAfter"));
+describe("moveArticleAfter", () => {
+    const summary = summary_1.default.createFromParts(new file_1.default(), [
+        {
+            articles: [
+                {
+                    title: "1.1",
+                    path: "1.1",
+                },
+                {
+                    title: "1.2",
+                    path: "1.2",
+                },
+            ],
+        },
+        {
+            title: "Part I",
+            articles: [
+                {
+                    title: "2.1",
+                    path: "2.1",
+                    articles: [
+                        {
+                            title: "2.1.1",
+                            path: "2.1.1",
+                        },
+                        {
+                            title: "2.1.2",
+                            path: "2.1.2",
+                        },
+                    ],
+                },
+                {
+                    title: "2.2",
+                    path: "2.2",
+                },
+            ],
+        },
+    ]);
+    test("moving right after itself should be invariant", () => {
+        const newSummary = (0, moveArticleAfter_1.default)(summary, "2.1", "2.1");
+        expect(immutable_1.default.is(summary, newSummary)).toBe(true);
+    });
+    test("moving after previous one should be invariant too", () => {
+        const newSummary = (0, moveArticleAfter_1.default)(summary, "2.1", "2.0");
+        expect(immutable_1.default.is(summary, newSummary)).toBe(true);
+    });
+    test("should move an article after a previous level", () => {
+        const newSummary = (0, moveArticleAfter_1.default)(summary, "2.2", "2.0");
+        const moved = newSummary.getByLevel("2.1");
+        expect(moved.getTitle()).toBe("2.2");
+        expect(newSummary.getByLevel("2.2").getTitle()).toBe("2.1");
+    });
+    test("should move an article after a previous and less deep level", () => {
+        const newSummary = (0, moveArticleAfter_1.default)(summary, "2.1.1", "2.0");
+        const moved = newSummary.getByLevel("2.1");
+        expect(moved.getTitle()).toBe("2.1.1");
+        expect(newSummary.getByLevel("2.2.1").getTitle()).toBe("2.1.2");
+        expect(newSummary.getByLevel("2.2").getTitle()).toBe("2.1");
+    });
+    test("should move an article after a next level", () => {
+        const newSummary = (0, moveArticleAfter_1.default)(summary, "2.1", "2.2");
+        const moved = newSummary.getByLevel("2.2");
+        expect(moved.getTitle()).toBe("2.1");
+        expect(newSummary.getByLevel("2.1").getTitle()).toBe("2.2");
+    });
+});

package/lib/modifiers/summary/__tests__/removeArticle.d.ts

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

package/lib/modifiers/summary/__tests__/removeArticle.d.ts.map

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

package/lib/modifiers/summary/__tests__/removeArticle.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const summary_1 = __importDefault(require("../../../models/summary"));
+const file_1 = __importDefault(require("../../../models/file"));
+const removeArticle_1 = __importDefault(require("../removeArticle"));
+describe("removeArticle", () => {
+    const summary = summary_1.default.createFromParts(new file_1.default(), [
+        {
+            articles: [
+                {
+                    title: "1.1",
+                    path: "1.1",
+                },
+                {
+                    title: "1.2",
+                    path: "1.2",
+                },
+            ],
+        },
+        {
+            title: "Part I",
+            articles: [
+                {
+                    title: "2.1",
+                    path: "2.1",
+                    articles: [
+                        {
+                            title: "2.1.1",
+                            path: "2.1.1",
+                        },
+                        {
+                            title: "2.1.2",
+                            path: "2.1.2",
+                        },
+                    ],
+                },
+                {
+                    title: "2.2",
+                    path: "2.2",
+                },
+            ],
+        },
+    ]);
+    test("should remove an article at a given level", () => {
+        const newSummary = (0, removeArticle_1.default)(summary, "2.1.1");
+        const removed = newSummary.getByLevel("2.1.1");
+        const nextOne = newSummary.getByLevel("2.1.2");
+        expect(removed.getTitle()).toBe("2.1.2");
+        expect(nextOne).toBe(null);
+    });
+});

package/lib/output/__tests__/ebook.d.ts

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

package/lib/output/__tests__/ebook.d.ts.map

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

package/lib/output/__tests__/ebook.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 generateMock_1 = __importDefault(require("../testing/generateMock"));
+const ebook_1 = __importDefault(require("../ebook"));
+describe("EbookGenerator", () => {
+    test("should generate a SUMMARY.html", () => {
+        return (0, generateMock_1.default)(ebook_1.default, {
+            "README.md": "Hello World"
+        }).then((folder) => {
+            expect(folder).toHaveFile("SUMMARY.html");
+            expect(folder).toHaveFile("index.html");
+        });
+    });
+});

package/lib/output/__tests__/json.d.ts

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

package/lib/output/__tests__/json.d.ts.map

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

package/lib/output/__tests__/json.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 generateMock_1 = __importDefault(require("../testing/generateMock"));
+const json_1 = __importDefault(require("../json"));
+describe("JSONGenerator", () => {
+    test("should generate a README.json", () => {
+        return (0, generateMock_1.default)(json_1.default, {
+            "README.md": "Hello World"
+        }).then((folder) => {
+            expect(folder).toHaveFile("README.json");
+        });
+    });
+    test("should generate a json file for each articles", () => {
+        return (0, generateMock_1.default)(json_1.default, {
+            "README.md": "Hello World",
+            "SUMMARY.md": "# Summary\n\n* [Page](test/page.md)",
+            test: {
+                "page.md": "Hello 2"
+            }
+        }).then((folder) => {
+            expect(folder).toHaveFile("README.json");
+            expect(folder).toHaveFile("test/page.json");
+        });
+    });
+    test("should generate a multilingual book", () => {
+        return (0, generateMock_1.default)(json_1.default, {
+            "LANGS.md": "# Languages\n\n* [en](en)\n* [fr](fr)",
+            en: {
+                "README.md": "Hello"
+            },
+            fr: {
+                "README.md": "Bonjour"
+            }
+        }).then((folder) => {
+            expect(folder).toHaveFile("en/README.json");
+            expect(folder).toHaveFile("fr/README.json");
+            expect(folder).toHaveFile("README.json");
+        });
+    });
+});

package/lib/output/__tests__/plugin-hooks.d.ts

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

package/lib/output/__tests__/plugin-hooks.d.ts.map

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

package/lib/output/__tests__/plugin-hooks.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert_1 = __importDefault(require("assert"));
+const generateMock_1 = require("../testing/generateMock");
+const immutable_1 = __importDefault(require("immutable"));
+const generatePages_1 = __importDefault(require("../generatePages"));
+const plugin_1 = __importDefault(require("../../models/plugin"));
+const json_1 = __importDefault(require("../json"));
+const createOutputWithPlugin = async ({ Generator, plugin, files }) => {
+    const { output } = await (0, generateMock_1.generateMockBook)(Generator, files);
+    // add plugin
+    return output.merge({
+        plugins: [plugin],
+    });
+};
+describe("plugin-hooks", function () {
+    it(`should be called "page" and "page:before" when generate each pages`, async () => {
+        let onPageBeforeCount = 0;
+        let onPageCount = 0;
+        const plugin = new plugin_1.default({
+            name: "testplugin",
+            version: "*",
+            path: "test.js",
+            package: immutable_1.default.fromJS({
+                name: "testplugin",
+            }),
+            content: immutable_1.default.fromJS({
+                hooks: {
+                    "page:before": function (page) {
+                        onPageBeforeCount++;
+                        return page;
+                    },
+                    page: function (page) {
+                        onPageCount++;
+                        return page;
+                    },
+                },
+            }),
+        });
+        const output = await createOutputWithPlugin({
+            Generator: json_1.default,
+            plugin,
+            files: {
+                "README.md": "Hello World",
+            },
+        });
+        // call twice
+        await (0, generatePages_1.default)(json_1.default, output);
+        await (0, generatePages_1.default)(json_1.default, output);
+        // assert
+        assert_1.default.strictEqual(onPageBeforeCount, 2);
+        assert_1.default.strictEqual(onPageCount, 2);
+    });
+});

package/lib/output/__tests__/website.d.ts

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

package/lib/output/__tests__/website.d.ts.map

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