@honkit/markdown 5.1.4 → 6.0.0

package/README.md

@@ -1,6 +1,6 @@
-# `@honkit/markdow`
+# `@honkit/markdown`
 
-This node module uses `@honkit/markup-i`t to parse markdown for gitbook (SUMMARY.md, README.md).
+This node module uses `@honkit/markup-it` to parse markdown for gitbook (SUMMARY.md, README.md).
 
 ## Note
 

package/lib/page.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.preparePage = void 0;
+exports.preparePage = preparePage;
 const MarkupIt = __importStar(require("@honkit/markup-it"));
 const gitbookSyntax = require("@honkit/markup-it/syntaxes/markdown");
 const RAW_START = "{% raw %}";
@@ -74,4 +74,3 @@ function preparePage(src) {
     });
     return textMarkdown;
 }
-exports.preparePage = preparePage;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@honkit/markdown",
-  "version": "5.1.4",
+  "version": "6.0.0",
   "description": "Parse markdown content for honkit",
   "homepage": "https://github.com/honkit/honkit",
   "bugs": {
@@ -38,16 +38,18 @@
     "prepublish": "npm run --if-present build"
   },
   "dependencies": {
-    "@honkit/html": "^5.1.4",
-    "@honkit/markup-it": "^5.1.4",
-    "markdown-escape": "^1.0.1"
+    "@honkit/html": "6.0.0",
+    "@honkit/markup-it": "6.0.0",
+    "markdown-escape": "^1.1.0"
   },
   "devDependencies": {
-    "jest": "^29.0.3",
-    "ts-jest": "^29.1.1"
+    "@types/jest": "^29.5.13",
+    "@types/node": "^22.7.4",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1c26afb66065cd7437e0e8f9d226327d49259313"
+  "gitHead": "367fe659a4a33c656ae51a1ec75fff0447365f9f"
 }

package/lib/__tests__/glossary.d.ts

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

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

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

package/lib/__tests__/glossary.js

@@ -1,29 +0,0 @@
-"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 path_1 = __importDefault(require("path"));
-const fs_1 = __importDefault(require("fs"));
-const __1 = __importDefault(require("../"));
-const glossary = __1.default.glossary;
-describe("Glossary parsing", () => {
-    let LEXED;
-    beforeAll(() => {
-        const CONTENT = fs_1.default.readFileSync(path_1.default.join(__dirname, "./fixtures/GLOSSARY.md"), "utf8");
-        LEXED = glossary(CONTENT);
-    });
-    it("should only get heading + paragraph pairs", () => {
-        assert_1.default.equal(LEXED.length, 4);
-    });
-    it("should output simple name/description objects", () => {
-        assert_1.default.equal(true, !LEXED.some((e) => {
-            return !(e.name && e.description);
-        }));
-    });
-    it("should correctly convert it to text", () => {
-        const text = glossary.toText(LEXED);
-        assert_1.default.deepEqual(glossary(text), LEXED);
-    });
-});

package/lib/__tests__/inline.d.ts

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

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

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

package/lib/__tests__/inline.js

@@ -1,13 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const __1 = __importDefault(require("../"));
-const assert_1 = __importDefault(require("assert"));
-const inline = __1.default.inline;
-describe("Inline", () => {
-    it("should render inline markdown", () => {
-        assert_1.default.equal(inline("Hello **World**").content, "Hello <strong>World</strong>");
-    });
-});

package/lib/__tests__/langs.d.ts

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

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

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

package/lib/__tests__/langs.js

@@ -1,28 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const __1 = __importDefault(require("../"));
-const assert_1 = __importDefault(require("assert"));
-const path_1 = __importDefault(require("path"));
-const fs_1 = __importDefault(require("fs"));
-const langs = __1.default.langs;
-describe("Languages parsing", () => {
-    let LEXED;
-    beforeAll(() => {
-        const CONTENT = fs_1.default.readFileSync(path_1.default.join(__dirname, "./fixtures/LANGS.md"), "utf8");
-        LEXED = langs(CONTENT);
-    });
-    it("should detect paths and titles", () => {
-        assert_1.default.equal(LEXED.length, 2);
-        assert_1.default.equal(LEXED[0].ref, "en/");
-        assert_1.default.equal(LEXED[0].title, "English");
-        assert_1.default.equal(LEXED[1].ref, "fr/");
-        assert_1.default.equal(LEXED[1].title, "French");
-    });
-    it("should correctly convert it to text", () => {
-        const text = langs.toText(LEXED);
-        assert_1.default.deepEqual(langs(text), LEXED);
-    });
-});

package/lib/__tests__/page.d.ts

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

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

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

package/lib/__tests__/page.js

@@ -1,134 +0,0 @@
-"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 fs_1 = __importDefault(require("fs"));
-const assert_1 = __importDefault(require("assert"));
-const __1 = __importDefault(require("../"));
-const page = __1.default.page;
-describe("Page parsing", () => {
-    let LEXED;
-    beforeAll(() => {
-        const CONTENT = fs_1.default.readFileSync(path_1.default.join(__dirname, "./fixtures/PAGE.md"), "utf8");
-        LEXED = page(CONTENT);
-    });
-    it("should gen content", () => {
-        (0, assert_1.default)(LEXED.content);
-    });
-    it("should not add id to headings", () => {
-        assert_1.default.equal(page("# Hello").content, "<h1>Hello</h1>");
-        assert_1.default.equal(page("# Hello {#test}").content, '<h1 id="test">Hello</h1>');
-    });
-    it("should escape codeblocks in preparation (1)", () => {
-        assert_1.default.equal(page.prepare("Hello `world`"), "Hello {% raw %}`world`{% endraw %}\n\n");
-        assert_1.default.equal(page.prepare("Hello `world test`"), "Hello {% raw %}`world test`{% endraw %}\n\n");
-        assert_1.default.equal(page.prepare("Hello ```world test```"), "Hello {% raw %}`world test`{% endraw %}\n\n");
-        assert_1.default.equal(page.prepare("Hello\n```js\nworld test\n```\n"), "Hello\n\n{% raw %}```js\nworld test\n```\n\n{% endraw %}");
-        expect(page.prepare("Hello\n```\ntest\n\tworld\n\ttest\n```")).toMatchInlineSnapshot(`
-            "Hello
-
-            {% raw %}\`\`\`
-            test
-                world
-                test
-            \`\`\`
-
-            {% endraw %}"
-        `);
-        // preserve \t in CodeBlock
-        expect(page.prepare("Hello\n```js\n\tvar a = 1;\n\tconsole.log(a);\n```")).toMatchInlineSnapshot(`
-            "Hello
-
-            {% raw %}\`\`\`js
-                var a = 1;
-                console.log(a);
-            \`\`\`
-
-            {% endraw %}"
-        `);
-    });
-    it("should escape codeblocks in preparation (2)", () => {
-        expect(page.prepare(`Hello
-
-
-\tworld
-\thello
-
-
-test`)).toMatchInlineSnapshot(`
-            "Hello
-
-            {% raw %}        world
-                    hello
-
-            {% endraw %}test
-
-            "
-        `);
-        expect(page.prepare(`Hello
-
-
-\tworld
-\thello
-
-
-`)).toMatchInlineSnapshot(`
-            "Hello
-
-            {% raw %}        world
-                    hello
-
-            {% endraw %}"
-        `);
-    });
-    it("should escape codeblocks with nunjucks tags", () => {
-        assert_1.default.equal(page.prepare('Hello {{ "Bonjour" }} ```test```'), 'Hello {{ "Bonjour" }} {% raw %}`test`{% endraw %}\n\n');
-    });
-    it("should escape codeblocks with nunjucks tags in {% raw %} tags", () => {
-        assert_1.default.equal(page.prepare('{% raw %}Hello {{ "Bonjour" }} ```test```{% endraw %}'), '{% raw %}Hello {{ "Bonjour" }} `test`{% endraw %}\n\n');
-        assert_1.default.equal(page.prepare('{% raw %}Hello {{ "Bonjour" }} {% raw %}{% endraw %}```test```'), '{% raw %}Hello {{ "Bonjour" }} {% raw %}{% endraw %}{% raw %}`test`{% endraw %}\n\n');
-        assert_1.default.equal(page.prepare('```{% raw %}Hello {{ "Bonjour" }} {% raw %}```'), '{% raw %}`{% raw %}Hello {{ "Bonjour" }} {% raw %}`{% endraw %}\n\n');
-        assert_1.default.equal(page.prepare("```\ntest\n```\n\n\n### Test"), "{% raw %}```\ntest\n```\n\n{% endraw %}### Test\n\n");
-    });
-    it("escape {% uml %} block tags + Indented code block", () => {
-        const code = `{% uml %}
-@startuml
-
-\tClass Stage
-\tClass Timeout {
-\t\t+constructor:function(cfg)
-\t\t+timeout:function(ctx)
-\t\t+overdue:function(ctx)
-\t\t+stage: Stage
-\t}
- \tStage <|-- Timeout
-
-@enduml
-{% enduml %}
-`;
-        expect(page.prepare(code)).toMatchInlineSnapshot(`
-            "{% uml %}
-            @startuml
-
-            {% raw %}        Class Stage
-                    Class Timeout {
-                        +constructor:function(cfg)
-                        +timeout:function(ctx)
-                        +overdue:function(ctx)
-                        +stage: Stage
-                    }
-                     Stage <|-- Timeout
-
-            {% endraw %}@enduml
-            {% enduml %}
-
-            "
-        `);
-    });
-    it("should not process math", () => {
-        assert_1.default.equal(page.prepare("Hello $world$"), "Hello $world$\n\n");
-        assert_1.default.equal(page.prepare("Hello $$world$$"), "Hello $$world$$\n\n");
-    });
-});

package/lib/__tests__/readme.d.ts

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

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

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

package/lib/__tests__/readme.js

@@ -1,28 +0,0 @@
-"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 assert_1 = __importDefault(require("assert"));
-const __1 = __importDefault(require("../"));
-const fs_1 = __importDefault(require("fs"));
-describe("Readme parsing", () => {
-    let LEXED;
-    beforeAll(() => {
-        const CONTENT = fs_1.default.readFileSync(path_1.default.join(__dirname, "./fixtures/README.md"), "utf8");
-        LEXED = __1.default.readme(CONTENT);
-    });
-    it("should contain a title", () => {
-        (0, assert_1.default)(LEXED.title);
-    });
-    it("should contain a description", () => {
-        (0, assert_1.default)(LEXED.description);
-    });
-    it("should extract the right title", () => {
-        assert_1.default.equal(LEXED.title, "This is the title");
-    });
-    it("should extract the right description", () => {
-        assert_1.default.equal(LEXED.description, "This is the book description.");
-    });
-});

package/lib/__tests__/summary.d.ts

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

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

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

package/lib/__tests__/summary.js

@@ -1,60 +0,0 @@
-"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 assert_1 = __importDefault(require("assert"));
-const fs_1 = __importDefault(require("fs"));
-const __1 = __importDefault(require("../"));
-function lex(fixtureFile) {
-    return __1.default.summary(fs_1.default.readFileSync(path_1.default.join(__dirname, "fixtures", fixtureFile), "utf8"));
-}
-describe("Summary parsing", () => {
-    let LEXED, PART;
-    beforeAll(() => {
-        LEXED = lex("SUMMARY.md");
-        PART = LEXED.parts[0];
-    });
-    it("should detect chapters", () => {
-        assert_1.default.equal(PART.articles.length, 5);
-    });
-    it("should support articles", () => {
-        assert_1.default.equal(PART.articles[0].articles.length, 2);
-        assert_1.default.equal(PART.articles[1].articles.length, 0);
-        assert_1.default.equal(PART.articles[2].articles.length, 0);
-    });
-    it("should detect paths and titles", () => {
-        (0, assert_1.default)(PART.articles[0].ref);
-        (0, assert_1.default)(PART.articles[1].ref);
-        (0, assert_1.default)(PART.articles[2].ref);
-        (0, assert_1.default)(PART.articles[3].ref);
-        assert_1.default.equal(PART.articles[4].ref, null);
-        (0, assert_1.default)(PART.articles[0].title);
-        (0, assert_1.default)(PART.articles[1].title);
-        (0, assert_1.default)(PART.articles[2].title);
-        (0, assert_1.default)(PART.articles[3].title);
-        (0, assert_1.default)(PART.articles[4].title);
-    });
-    it("should normalize paths from .md", () => {
-        assert_1.default.equal(PART.articles[0].ref, "chapter-1/README.md");
-        assert_1.default.equal(PART.articles[1].ref, "chapter-2/README.md");
-        assert_1.default.equal(PART.articles[2].ref, "chapter-3/README.md");
-    });
-    it("should part parts", () => {
-        const l = lex("SUMMARY_PARTS.md");
-        assert_1.default.equal(l.parts.length, 3);
-    });
-    it("should allow lists separated by whitespace", () => {
-        const l = lex("SUMMARY_WHITESPACE.md");
-        assert_1.default.equal(l.parts[0].articles.length, 5);
-    });
-    it("should allow ignore empty entries", () => {
-        const l = lex("SUMMARY_EMPTY.md");
-        assert_1.default.equal(l.parts[0].articles.length, 1);
-    });
-    it("should correctly convert it to text", () => {
-        const text = __1.default.summary.toText(LEXED);
-        assert_1.default.deepEqual(__1.default.summary(text), LEXED);
-    });
-});