honkit 6.2.4 → 6.2.6

package/lib/output/__tests__/website.js

@@ -135,4 +135,25 @@ describe("WebsiteGenerator", () => {
             expect(folder).toHaveFile("index.html");
         });
     });
+    longTest("should write a separate search index for each language", async () => {
+        const folder = await (0, generateMock_1.default)(website_1.default, {
+            "LANGS.md": "# Languages\n\n* [en](en)\n* [fr](fr)",
+            en: {
+                "README.md": "# Hello\n\nenglishonly"
+            },
+            fr: {
+                "README.md": "# Bonjour\n\nfrenchonly"
+            }
+        });
+        const readIndex = (language) => JSON.parse(fs_1.default.readFileSync(`${folder}/${language}/search_index.json`, "utf8"));
+        const en = readIndex("en");
+        const fr = readIndex("fr");
+        expect(Object.values(en.store).map((doc) => doc.body.trim())).toEqual(["Hello\nenglishonly"]);
+        expect(Object.values(fr.store).map((doc) => doc.body.trim())).toEqual(["Bonjour\nfrenchonly"]);
+        // The index itself, not only the store, must not contain words of the other language
+        expect(JSON.stringify(en.index)).toContain("englishon");
+        expect(JSON.stringify(en.index)).not.toContain("frenchon");
+        expect(JSON.stringify(fr.index)).toContain("frenchon");
+        expect(JSON.stringify(fr.index)).not.toContain("englishon");
+    });
 });

package/lib/plugins/PluginResolver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PluginResolver.d.ts","sourceRoot":"","sources":["../../src/plugins/PluginResolver.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;GAYG;AAEH,qBAAa,cAAc;IACvB,aAAa,EAAE,MAAM,CAAC;gBAEV,MAAM,GAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAO;IAOnD;;;;OAIG;IACH,wBAAwB,CAAC,WAAW,KAAA;CAyBvC"}
+{"version":3,"file":"PluginResolver.d.ts","sourceRoot":"","sources":["../../src/plugins/PluginResolver.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;GAYG;AAEH,qBAAa,cAAc;IACvB,aAAa,EAAE,MAAM,CAAC;gBAEV,MAAM,GAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAO;IAOnD;;;;OAIG;IACH,wBAAwB,CAAC,WAAW,KAAA;CA2BvC"}

package/lib/plugins/PluginResolver.js

@@ -34,6 +34,7 @@ const path_2 = __importDefault(require("../utils/path"));
 const SPECIAL_PACKAGE_NAME = [
     "fontsettings", // → @honkit/honkit-plugin-fontsettings
     "highlight", // → @honkit/honkit-plugin-highlight
+    "lunr", // → @honkit/honkit-plugin-lunr
     "theme-default" // → @honkit/honkit-plugin-theme-default
 ];
 /**
@@ -71,11 +72,13 @@ class PluginResolver {
         // e.g.) load theme-default as @honkit/honkit-plugins-theme-default
         const honkitScopePackageName = `@honkit/${honkitFullPackageName}`;
         // In sometimes, HonKit package has not main field - so search package.json
+        // The scoped package is tried before the bare name: a bare name such as "lunr" is
+        // also a regular library (a dependency of the plugin) and is not a HonKit plugin.
         const pkgPath = path_2.default.tryResolve(path_1.default.join(baseDir, honkitFullPackageName, "/package.json")) ||
             path_2.default.tryResolve(path_1.default.join(baseDir, gitbookFullPackageName, "/package.json")) ||
-            path_2.default.tryResolve(path_1.default.join(baseDir, packageName, "/package.json")) ||
             (SPECIAL_PACKAGE_NAME.includes(packageName) &&
-                path_2.default.tryResolve(path_1.default.join(baseDir, honkitScopePackageName, "/package.json")));
+                path_2.default.tryResolve(path_1.default.join(baseDir, honkitScopePackageName, "/package.json"))) ||
+            path_2.default.tryResolve(path_1.default.join(baseDir, packageName, "/package.json"));
         if (!pkgPath) {
             throw new ReferenceError(`Failed to load HonKit's plugin module: "${packageName}" is not found.
 

package/lib/plugins/__tests__/PluginResolver.d.ts

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

package/lib/plugins/__tests__/PluginResolver.d.ts.map

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

package/lib/plugins/__tests__/PluginResolver.js

@@ -0,0 +1,63 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const PluginResolver_1 = require("../PluginResolver");
+describe("PluginResolver", () => {
+    let baseDirectory;
+    // Create a fake package in baseDirectory, as if it was installed in node_modules
+    const installPackage = (name) => {
+        const packageDir = path_1.default.join(baseDirectory, name);
+        fs_1.default.mkdirSync(packageDir, { recursive: true });
+        fs_1.default.writeFileSync(path_1.default.join(packageDir, "package.json"), JSON.stringify({ name }));
+        return packageDir;
+    };
+    beforeEach(() => {
+        // require.resolve returns the real path: the temporary directory is a symlink on macOS
+        // and a short (8.3) path on Windows, which only the native realpath expands
+        baseDirectory = fs_1.default.realpathSync.native(fs_1.default.mkdtempSync(path_1.default.join(os_1.default.tmpdir(), "honkit-plugin-resolver-")));
+    });
+    afterEach(() => {
+        fs_1.default.rmSync(baseDirectory, { recursive: true, force: true });
+    });
+    const resolve = (name) => new PluginResolver_1.PluginResolver({ baseDirectory }).resolvePluginPackageName(name);
+    it("should resolve honkit-plugin-* before gitbook-plugin-*", () => {
+        const honkitPlugin = installPackage("honkit-plugin-example");
+        installPackage("gitbook-plugin-example");
+        expect(resolve("example")).toBe(honkitPlugin);
+    });
+    it("should resolve gitbook-plugin-*", () => {
+        const gitbookPlugin = installPackage("gitbook-plugin-example");
+        expect(resolve("example")).toBe(gitbookPlugin);
+    });
+    it("should resolve a package by its full name", () => {
+        const plugin = installPackage("honkit-plugin-example");
+        expect(resolve("honkit-plugin-example")).toBe(plugin);
+    });
+    it("should resolve a default plugin to the @honkit/ package before a library of the same name", () => {
+        // npm hoists the "lunr" library, a dependency of @honkit/honkit-plugin-lunr, next to the plugin
+        installPackage("lunr");
+        const scopedPlugin = installPackage("@honkit/honkit-plugin-lunr");
+        expect(resolve("lunr")).toBe(scopedPlugin);
+    });
+    it("should prefer a user-installed gitbook-plugin-* over the @honkit/ package", () => {
+        installPackage("@honkit/honkit-plugin-lunr");
+        const gitbookPlugin = installPackage("gitbook-plugin-lunr");
+        expect(resolve("lunr")).toBe(gitbookPlugin);
+    });
+    it("should not resolve a non-default plugin to the @honkit/ package", () => {
+        installPackage("@honkit/honkit-plugin-example");
+        expect(() => resolve("example")).toThrow(ReferenceError);
+    });
+    it("should fall back to the bare package name", () => {
+        const plugin = installPackage("example");
+        expect(resolve("example")).toBe(plugin);
+    });
+    it("should throw when the plugin is not found", () => {
+        expect(() => resolve("not-found")).toThrow(/"not-found" is not found/);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "honkit",
-  "version": "6.2.4",
+  "version": "6.2.6",
   "description": "HonKit is building beautiful books using Markdown.",
   "keywords": [
     "git",
@@ -48,7 +48,6 @@
     "flat-cache": "^4.0.1",
     "front-matter": "^2.3.0",
     "gitbook-plugin-livereload": "^0.0.1",
-    "gitbook-plugin-lunr": "^1.2.0",
     "gitbook-plugin-search": "^2.2.1",
     "github-slugid": "^1.0.1",
     "i18n-t": "^1.0.1",
@@ -70,12 +69,13 @@
     "semver": "^7.6.3",
     "send": "^0.19.2",
     "tiny-lr": "^1.1.1",
-    "@honkit/asciidoc": "6.2.4",
-    "@honkit/honkit-plugin-fontsettings": "6.2.4",
-    "@honkit/honkit-plugin-theme-default": "6.2.4",
-    "@honkit/html": "6.2.4",
-    "@honkit/honkit-plugin-highlight": "6.2.4",
-    "@honkit/markdown-legacy": "6.2.4"
+    "@honkit/honkit-plugin-highlight": "6.2.6",
+    "@honkit/asciidoc": "6.2.6",
+    "@honkit/honkit-plugin-fontsettings": "6.2.6",
+    "@honkit/honkit-plugin-lunr": "6.2.6",
+    "@honkit/html": "6.2.6",
+    "@honkit/markdown-legacy": "6.2.6",
+    "@honkit/honkit-plugin-theme-default": "6.2.6"
   },
   "devDependencies": {
     "@relmify/jest-serializer-strip-ansi": "^1.0.2",
@@ -87,7 +87,7 @@
     "object-path": "^0.11.8",
     "rimraf": "^6.0.1",
     "typescript": "^5.6.2",
-    "@honkit/internal-test-utils": "6.2.4"
+    "@honkit/internal-test-utils": "6.2.6"
   },
   "scripts": {
     "build": "tsc -p .",