honkit 6.0.4 → 6.1.5

package/lib/templating/__tests__/conrefsLoader.js

@@ -0,0 +1,90 @@
+"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 templateEngine_1 = __importDefault(require("../../models/templateEngine"));
+const render_1 = __importDefault(require("../render"));
+const conrefsLoader_1 = __importDefault(require("../conrefsLoader"));
+describe("ConrefsLoader", () => {
+    const dirName = `${__dirname}/`;
+    const fileName = path_1.default.join(dirName, "test.md");
+    describe("Git", () => {
+        const engine = new templateEngine_1.default({
+            // @ts-expect-error: Expected 0 arguments, but got 1.
+            loader: new conrefsLoader_1.default(dirName),
+        });
+        test("should include content from git", () => {
+            // @ts-expect-error ts-migrate(2554) FIXME: Expected 4 arguments, but got 3.
+            return (0, render_1.default)(engine, fileName, '{% include "git+https://gist.github.com/69ea4542e4c8967d2fa7.git/test.md" %}').then((out) => {
+                expect(out.getContent()).toBe("Hello from git");
+            });
+        }, 60 * 1000);
+        test("should handle deep inclusion (1)", () => {
+            // @ts-expect-error ts-migrate(2554) FIXME: Expected 4 arguments, but got 3.
+            return (0, render_1.default)(engine, fileName, '{% include "git+https://gist.github.com/69ea4542e4c8967d2fa7.git/test2.md" %}').then((out) => {
+                expect(out.getContent()).toBe("First Hello. Hello from git");
+            });
+        }, 60 * 1000);
+        test("should handle deep inclusion (2)", () => {
+            // @ts-expect-error ts-migrate(2554) FIXME: Expected 4 arguments, but got 3.
+            return (0, render_1.default)(engine, fileName, '{% include "git+https://gist.github.com/69ea4542e4c8967d2fa7.git/test3.md" %}').then((out) => {
+                expect(out.getContent()).toBe("First Hello. Hello from git");
+            });
+        }, 60 * 1000);
+    });
+    describe("Local", () => {
+        const engine = new templateEngine_1.default({
+            // @ts-expect-error: Expected 0 arguments, but got 1.
+            loader: new conrefsLoader_1.default(dirName),
+        });
+        describe("Relative", () => {
+            test("should resolve basic relative filepath", () => {
+                // @ts-expect-error ts-migrate(2554) FIXME: Expected 4 arguments, but got 3.
+                return (0, render_1.default)(engine, fileName, '{% include "include.md" %}').then((out) => {
+                    expect(out.getContent()).toBe("Hello World");
+                });
+            });
+            test("should resolve basic parent filepath", () => {
+                // @ts-expect-error ts-migrate(2554) FIXME: Expected 4 arguments, but got 3.
+                return (0, render_1.default)(engine, path_1.default.join(dirName, "hello/test.md"), '{% include "../include.md" %}').then((out) => {
+                    expect(out.getContent()).toBe("Hello World");
+                });
+            });
+        });
+        describe("Absolute", () => {
+            test("should resolve absolute filepath", () => {
+                // @ts-expect-error ts-migrate(2554) FIXME: Expected 4 arguments, but got 3.
+                return (0, render_1.default)(engine, fileName, '{% include "/include.md" %}').then((out) => {
+                    expect(out.getContent()).toBe("Hello World");
+                });
+            });
+            test("should resolve absolute filepath when in a directory", () => {
+                // @ts-expect-error ts-migrate(2554) FIXME: Expected 4 arguments, but got 3.
+                return (0, render_1.default)(engine, path_1.default.join(dirName, "hello/test.md"), '{% include "/include.md" %}').then((out) => {
+                    expect(out.getContent()).toBe("Hello World");
+                });
+            });
+        });
+    });
+    describe("transform", () => {
+        function transform(filePath, source) {
+            expect(typeof filePath).toBe("string");
+            expect(typeof source).toBe("string");
+            expect(filePath).toBe(path_1.default.resolve(__dirname, "include.md"));
+            expect(source).toBe("Hello World");
+            return `test-${source}-endtest`;
+        }
+        const engine = new templateEngine_1.default({
+            // @ts-expect-error: Expected 0 arguments, but got 1.
+            loader: new conrefsLoader_1.default(dirName, transform),
+        });
+        test("should transform included content", () => {
+            // @ts-expect-error ts-migrate(2554) FIXME: Expected 4 arguments, but got 3.
+            return (0, render_1.default)(engine, fileName, '{% include "include.md" %}').then((out) => {
+                expect(out.getContent()).toBe("test-Hello World-endtest");
+            });
+        });
+    });
+});

package/lib/templating/__tests__/postRender.d.ts

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

package/lib/templating/__tests__/postRender.d.ts.map

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

package/lib/templating/__tests__/postRender.js

@@ -0,0 +1,52 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const templateEngine_1 = __importDefault(require("../../models/templateEngine"));
+const templateBlock_1 = __importDefault(require("../../models/templateBlock"));
+const render_1 = __importDefault(require("../render"));
+const postRender_1 = __importDefault(require("../postRender"));
+describe("postRender", () => {
+    let testPost;
+    const engine = templateEngine_1.default.create({
+        blocks: [
+            templateBlock_1.default.create("lower", (blk) => {
+                return blk.body.toLowerCase();
+            }),
+            templateBlock_1.default.create("prefix", (blk) => {
+                return {
+                    body: `_${blk.body}_`,
+                    post: function () {
+                        testPost = true;
+                    },
+                };
+            }),
+        ],
+    });
+    test("should correctly replace block", () => {
+        // @ts-expect-error ts-migrate(2554) FIXME: Expected 4 arguments, but got 3.
+        return (0, render_1.default)(engine, "README.md", "Hello {% lower %}Samy{% endlower %}")
+            .then((output) => {
+            expect(output.getContent()).toMatch(/Hello \{\{\-([\S]+)\-\}\}/);
+            expect(output.getBlocks().size).toBe(1);
+            return (0, postRender_1.default)(engine, output);
+        })
+            .then((result) => {
+            expect(result).toBe("Hello samy");
+        });
+    });
+    test("should correctly replace blocks", () => {
+        // @ts-expect-error ts-migrate(2554) FIXME: Expected 4 arguments, but got 3.
+        return (0, render_1.default)(engine, "README.md", "Hello {% lower %}Samy{% endlower %}{% prefix %}Pesse{% endprefix %}")
+            .then((output) => {
+            expect(output.getContent()).toMatch(/Hello \{\{\-([\S]+)\-\}\}\{\{\-([\S]+)\-\}\}/);
+            expect(output.getBlocks().size).toBe(2);
+            return (0, postRender_1.default)(engine, output);
+        })
+            .then((result) => {
+            expect(result).toBe("Hello samy_Pesse_");
+            expect(testPost).toBe(true);
+        });
+    });
+});

package/lib/templating/__tests__/replaceShortcuts.d.ts

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

package/lib/templating/__tests__/replaceShortcuts.d.ts.map

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

package/lib/templating/__tests__/replaceShortcuts.js

@@ -0,0 +1,27 @@
+"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 templateBlock_1 = __importDefault(require("../../models/templateBlock"));
+const replaceShortcuts_1 = __importDefault(require("../replaceShortcuts"));
+describe("replaceShortcuts", () => {
+    const blocks = immutable_1.default.List([
+        templateBlock_1.default.create("math", {
+            shortcuts: {
+                start: "$$",
+                end: "$$",
+                parsers: ["markdown"],
+            },
+        }),
+    ]);
+    test("should correctly replace inline matches by block", () => {
+        const content = (0, replaceShortcuts_1.default)(blocks, "test.md", "Hello $$a = b$$");
+        expect(content).toBe("Hello {% math %}a = b{% endmath %}");
+    });
+    test("should correctly replace block matches", () => {
+        const content = (0, replaceShortcuts_1.default)(blocks, "test.md", "Hello\n$$\na = b\n$$\n");
+        expect(content).toBe("Hello\n{% math %}\na = b\n{% endmath %}\n");
+    });
+});

package/lib/utils/__tests__/git.d.ts

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

package/lib/utils/__tests__/git.d.ts.map

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

package/lib/utils/__tests__/git.js

@@ -0,0 +1,46 @@
+"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 git_1 = __importDefault(require("../git"));
+describe("Git", () => {
+    describe("URL parsing", () => {
+        test("should correctly validate git urls", () => {
+            // HTTPS
+            expect(git_1.default.isUrl("git+https://github.com/Hello/world.git")).toBeTruthy();
+            // SSH
+            expect(git_1.default.isUrl("git+git@github.com:GitbookIO/gitbook.git/directory/README.md#e1594cde2c32e4ff48f6c4eff3d3d461743d74e1")).toBeTruthy();
+            // Non valid
+            expect(git_1.default.isUrl("https://github.com/Hello/world.git")).toBeFalsy();
+            expect(git_1.default.isUrl("README.md")).toBeFalsy();
+        }, 60 * 1000);
+        test("should parse HTTPS urls", () => {
+            const parts = git_1.default.parseUrl("git+https://gist.github.com/69ea4542e4c8967d2fa7.git/test.md");
+            expect(parts.host).toBe("https://gist.github.com/69ea4542e4c8967d2fa7.git");
+            expect(parts.ref).toBe(null);
+            expect(parts.filepath).toBe("test.md");
+        }, 60 * 1000);
+        test("should parse HTTPS urls with a reference", () => {
+            const parts = git_1.default.parseUrl("git+https://gist.github.com/69ea4542e4c8967d2fa7.git/test.md#1.0.0");
+            expect(parts.host).toBe("https://gist.github.com/69ea4542e4c8967d2fa7.git");
+            expect(parts.ref).toBe("1.0.0");
+            expect(parts.filepath).toBe("test.md");
+        }, 60 * 1000);
+        test("should parse SSH urls", () => {
+            const parts = git_1.default.parseUrl("git+git@github.com:GitbookIO/gitbook.git/directory/README.md#e1594cde2c32e4ff48f6c4eff3d3d461743d74e1");
+            expect(parts.host).toBe("git@github.com:GitbookIO/gitbook.git");
+            expect(parts.ref).toBe("e1594cde2c32e4ff48f6c4eff3d3d461743d74e1");
+            expect(parts.filepath).toBe("directory/README.md");
+        }, 60 * 1000);
+    });
+    describe("Cloning and resolving", () => {
+        test("should clone an HTTPS url", () => {
+            const git = new git_1.default();
+            return git.resolve("git+https://gist.github.com/69ea4542e4c8967d2fa7.git/test.md").then((filename) => {
+                expect(path_1.default.extname(filename)).toBe(".md");
+            });
+        }, 60 * 1000);
+    });
+});

package/lib/utils/__tests__/location.d.ts

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

package/lib/utils/__tests__/location.d.ts.map

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

package/lib/utils/__tests__/location.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 location_1 = __importDefault(require("../location"));
+describe("LocationUtils", () => {
+    test("should correctly test external location", () => {
+        expect(location_1.default.isExternal("http://google.fr")).toBe(true);
+        expect(location_1.default.isExternal("https://google.fr")).toBe(true);
+        expect(location_1.default.isExternal("test.md")).toBe(false);
+        expect(location_1.default.isExternal("folder/test.md")).toBe(false);
+        expect(location_1.default.isExternal("/folder/test.md")).toBe(false);
+        expect(location_1.default.isExternal("data:image/png")).toBe(false);
+    });
+    test("should correctly test data:uri location", () => {
+        expect(location_1.default.isDataURI("data:image/png")).toBe(true);
+        expect(location_1.default.isDataURI("http://google.fr")).toBe(false);
+        expect(location_1.default.isDataURI("https://google.fr")).toBe(false);
+        expect(location_1.default.isDataURI("test.md")).toBe(false);
+        expect(location_1.default.isDataURI("data.md")).toBe(false);
+    });
+    test("should correctly detect anchor location", () => {
+        expect(location_1.default.isAnchor("#test")).toBe(true);
+        expect(location_1.default.isAnchor(" #test")).toBe(true);
+        expect(location_1.default.isAnchor("https://google.fr#test")).toBe(false);
+        expect(location_1.default.isAnchor("test.md#test")).toBe(false);
+    });
+    describe(".relative", () => {
+        test("should resolve to a relative path (same folder)", () => {
+            expect(location_1.default.relative("links/", "links/test.md")).toBe("test.md");
+        });
+        test("should resolve to a relative path (parent folder)", () => {
+            expect(location_1.default.relative("links/", "test.md")).toBe("../test.md");
+        });
+        test("should resolve to a relative path (child folder)", () => {
+            expect(location_1.default.relative("links/", "links/hello/test.md")).toBe("hello/test.md");
+        });
+    });
+    describe(".flatten", () => {
+        test("should remove leading slash", () => {
+            expect(location_1.default.flatten("/test.md")).toBe("test.md");
+            expect(location_1.default.flatten("/hello/cool.md")).toBe("hello/cool.md");
+        });
+        test("should remove leading slashes", () => {
+            expect(location_1.default.flatten("///test.md")).toBe("test.md");
+        });
+        test("should not break paths", () => {
+            expect(location_1.default.flatten("hello/cool.md")).toBe("hello/cool.md");
+        });
+    });
+    describe(".toAbsolute", () => {
+        test("should correctly transform as absolute", () => {
+            // @ts-expect-error
+            expect(location_1.default.toAbsolute("http://google.fr")).toBe("http://google.fr");
+            expect(location_1.default.toAbsolute("test.md", "./", "./")).toBe("test.md");
+            expect(location_1.default.toAbsolute("folder/test.md", "./", "./")).toBe("folder/test.md");
+        });
+        test("should correctly handle windows path", () => {
+            expect(location_1.default.toAbsolute("folder\\test.md", "./", "./")).toBe("folder/test.md");
+        });
+        test("should correctly handle absolute path", () => {
+            expect(location_1.default.toAbsolute("/test.md", "./", "./")).toBe("test.md");
+            expect(location_1.default.toAbsolute("/test.md", "test", "test")).toBe("../test.md");
+            expect(location_1.default.toAbsolute("/sub/test.md", "test", "test")).toBe("../sub/test.md");
+            expect(location_1.default.toAbsolute("/test.png", "folder", "")).toBe("test.png");
+        });
+        test("should correctly handle absolute path (windows)", () => {
+            expect(location_1.default.toAbsolute("\\test.png", "folder", "")).toBe("test.png");
+        });
+        test("should resolve path starting by \"/\" in root directory", () => {
+            expect(location_1.default.toAbsolute("/test/hello.md", "./", "./")).toBe("test/hello.md");
+        });
+        test("should resolve path starting by \"/\" in child directory", () => {
+            expect(location_1.default.toAbsolute("/test/hello.md", "./hello", "./")).toBe("test/hello.md");
+        });
+        test("should resolve path starting by \"/\" in child directory, with same output directory", () => {
+            expect(location_1.default.toAbsolute("/test/hello.md", "./hello", "./hello")).toBe("../test/hello.md");
+        });
+    });
+});

package/lib/utils/__tests__/path.d.ts

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

package/lib/utils/__tests__/path.d.ts.map

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

package/lib/utils/__tests__/path.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 path_1 = __importDefault(require("path"));
+const path_2 = __importDefault(require("../path"));
+describe("Paths", () => {
+    describe("setExtension", () => {
+        test("should correctly change extension of filename", () => {
+            expect(path_2.default.setExtension("test.md", ".html")).toBe("test.html");
+            expect(path_2.default.setExtension("test.md", ".json")).toBe("test.json");
+        });
+        test("should correctly change extension of path", () => {
+            expect(path_2.default.setExtension("hello/test.md", ".html")).toBe(path_1.default.normalize("hello/test.html"));
+            expect(path_2.default.setExtension("hello/test.md", ".json")).toBe(path_1.default.normalize("hello/test.json"));
+        });
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "honkit",
-  "version": "6.0.4",
+  "version": "6.1.5",
   "description": "HonKit is building beautiful books using Markdown.",
   "keywords": [
     "git",
@@ -29,20 +29,7 @@
     "lib",
     "!__tests__"
   ],
-  "scripts": {
-    "prepublish": "npm run clean && npm run build",
-    "build": "tsc -p .",
-    "clean": "rimraf lib/",
-    "test": "jest src",
-    "updateSnapshot": "jest src -u"
-  },
   "dependencies": {
-    "@honkit/asciidoc": "6.0.4",
-    "@honkit/honkit-plugin-fontsettings": "6.0.4",
-    "@honkit/honkit-plugin-highlight": "6.0.4",
-    "@honkit/honkit-plugin-theme-default": "6.0.4",
-    "@honkit/html": "6.0.4",
-    "@honkit/markdown-legacy": "6.0.4",
     "bash-color": "^0.0.4",
     "cheerio": "^1.0.0",
     "chokidar": "^3.6.0",
@@ -86,10 +73,15 @@
     "send": "^0.17.2",
     "tiny-lr": "^1.1.1",
     "tmp": "0.2.4",
-    "urijs": "^1.19.11"
+    "urijs": "^1.19.11",
+    "@honkit/asciidoc": "6.1.5",
+    "@honkit/honkit-plugin-fontsettings": "6.1.5",
+    "@honkit/honkit-plugin-highlight": "6.1.5",
+    "@honkit/honkit-plugin-theme-default": "6.1.5",
+    "@honkit/markdown-legacy": "6.1.5",
+    "@honkit/html": "6.1.5"
   },
   "devDependencies": {
-    "@honkit/internal-test-utils": "6.0.4",
     "@relmify/jest-serializer-strip-ansi": "^1.0.2",
     "@types/jest": "^29.5.13",
     "@types/node": "^22.7.4",
@@ -97,7 +89,13 @@
     "jest": "^29.7.0",
     "jest-mock-process": "^2.0.0",
     "rimraf": "^6.0.1",
-    "typescript": "^5.6.2"
+    "typescript": "^5.6.2",
+    "@honkit/internal-test-utils": "6.1.5"
   },
-  "gitHead": "2a3f084fd5908ac4a7efcecd4a1114888af6f871"
-}
+  "scripts": {
+    "build": "tsc -p .",
+    "clean": "rimraf lib/",
+    "test": "jest src",
+    "updateSnapshot": "jest src -u"
+  }
+}