honkit 3.6.21

package/lib/modifiers/config/togglePlugin.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 pluginDependency_1 = __importDefault(require("../../models/pluginDependency"));
+const hasPlugin_1 = __importDefault(require("./hasPlugin"));
+const isDefaultPlugin_1 = __importDefault(require("./isDefaultPlugin"));
+/**
+ * Enable/disable a plugin dependency
+ * @param {Config} config
+ * @param {string} pluginName
+ * @param {boolean} state (optional)
+ * @return {Config}
+ */
+function togglePlugin(config, pluginName, state) {
+    let deps = config.getPluginDependencies();
+    // For default plugin, we should ensure it's listed first
+    // @ts-expect-error ts-migrate(2554) FIXME: Expected 2 arguments, but got 1.
+    if (isDefaultPlugin_1.default(pluginName) && !hasPlugin_1.default(deps, pluginName)) {
+        // @ts-expect-error ts-migrate(2339) FIXME: Property 'create' does not exist on type 'Class'.
+        deps = deps.push(pluginDependency_1.default.create(pluginName));
+    }
+    deps = deps.map((dep) => {
+        if (dep.getName() === pluginName) {
+            return dep.toggle(state);
+        }
+        return dep;
+    });
+    return config.setPluginDependencies(deps);
+}
+exports.default = togglePlugin;

package/lib/modifiers/index.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 summary_1 = __importDefault(require("./summary"));
+const config_1 = __importDefault(require("./config"));
+exports.default = {
+    Summary: summary_1.default,
+    Config: config_1.default,
+};

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 = 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 = 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 = editPartTitle_1.default(summary, 3, "Hello");
+        expect(newSummary.getParts().size).toBe(2);
+    });
+});

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 = 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 = 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.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 = 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 = 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.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 = 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 = 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.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 = 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 = 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 = 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.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 = 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 = 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 = 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 = 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 = 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.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 = 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);
+    });
+});