@honkit/markdown 3.6.17 → 3.7.2

package/lib/__tests__/glossary.js

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

package/lib/__tests__/inline.js

@@ -0,0 +1,9 @@
+const fs = require("fs");
+const path = require("path");
+const assert = require("assert");
+const inline = require("../").inline;
+describe("Inline", () => {
+    it("should render inline markdown", () => {
+        assert.equal(inline("Hello **World**").content, "Hello <strong>World</strong>");
+    });
+});

package/lib/__tests__/langs.js

@@ -0,0 +1,22 @@
+const fs = require("fs");
+const path = require("path");
+const assert = require("assert");
+const langs = require("../").langs;
+describe("Languages parsing", () => {
+    let LEXED;
+    beforeAll(() => {
+        const CONTENT = fs.readFileSync(path.join(__dirname, "./fixtures/LANGS.md"), "utf8");
+        LEXED = langs(CONTENT);
+    });
+    it("should detect paths and titles", () => {
+        assert.equal(LEXED.length, 2);
+        assert.equal(LEXED[0].ref, "en/");
+        assert.equal(LEXED[0].title, "English");
+        assert.equal(LEXED[1].ref, "fr/");
+        assert.equal(LEXED[1].title, "French");
+    });
+    it("should correctly convert it to text", () => {
+        const text = langs.toText(LEXED);
+        assert.deepEqual(langs(text), LEXED);
+    });
+});

package/lib/__tests__/page.js

@@ -0,0 +1,128 @@
+const fs = require("fs");
+const path = require("path");
+const assert = require("assert");
+const page = require("../").page;
+describe("Page parsing", () => {
+    let LEXED;
+    beforeAll(() => {
+        const CONTENT = fs.readFileSync(path.join(__dirname, "./fixtures/PAGE.md"), "utf8");
+        LEXED = page(CONTENT);
+    });
+    it("should gen content", () => {
+        assert(LEXED.content);
+    });
+    it("should not add id to headings", () => {
+        assert.equal(page("# Hello").content, "<h1>Hello</h1>");
+        assert.equal(page("# Hello {#test}").content, '<h1 id="test">Hello</h1>');
+    });
+    it("should escape codeblocks in preparation (1)", () => {
+        assert.equal(page.prepare("Hello `world`"), "Hello {% raw %}`world`{% endraw %}\n\n");
+        assert.equal(page.prepare("Hello `world test`"), "Hello {% raw %}`world test`{% endraw %}\n\n");
+        assert.equal(page.prepare("Hello ```world test```"), "Hello {% raw %}`world test`{% endraw %}\n\n");
+        assert.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.equal(page.prepare('Hello {{ "Bonjour" }} ```test```'), 'Hello {{ "Bonjour" }} {% raw %}`test`{% endraw %}\n\n');
+    });
+    it("should escape codeblocks with nunjucks tags in {% raw %} tags", () => {
+        assert.equal(page.prepare('{% raw %}Hello {{ "Bonjour" }} ```test```{% endraw %}'), '{% raw %}Hello {{ "Bonjour" }} `test`{% endraw %}\n\n');
+        assert.equal(page.prepare('{% raw %}Hello {{ "Bonjour" }} {% raw %}{% endraw %}```test```'), '{% raw %}Hello {{ "Bonjour" }} {% raw %}{% endraw %}{% raw %}`test`{% endraw %}\n\n');
+        assert.equal(page.prepare('```{% raw %}Hello {{ "Bonjour" }} {% raw %}```'), '{% raw %}`{% raw %}Hello {{ "Bonjour" }} {% raw %}`{% endraw %}\n\n');
+        assert.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.equal(page.prepare("Hello $world$"), "Hello $world$\n\n");
+        assert.equal(page.prepare("Hello $$world$$"), "Hello $$world$$\n\n");
+    });
+});

package/lib/__tests__/readme.js

@@ -0,0 +1,23 @@
+const fs = require("fs");
+const path = require("path");
+const assert = require("assert");
+const readme = require("../").readme;
+describe("Readme parsing", () => {
+    let LEXED;
+    beforeAll(() => {
+        const CONTENT = fs.readFileSync(path.join(__dirname, "./fixtures/README.md"), "utf8");
+        LEXED = readme(CONTENT);
+    });
+    it("should contain a title", () => {
+        assert(LEXED.title);
+    });
+    it("should contain a description", () => {
+        assert(LEXED.description);
+    });
+    it("should extract the right title", () => {
+        assert.equal(LEXED.title, "This is the title");
+    });
+    it("should extract the right description", () => {
+        assert.equal(LEXED.description, "This is the book description.");
+    });
+});

package/lib/__tests__/summary.js

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

package/lib/toMarkdown.js

@@ -14,7 +14,7 @@ function ns(s, n) {
  */
 exports.default = {
     onText: function (text) {
-        return markdown_escape_1.default(text);
+        return (0, markdown_escape_1.default)(text);
     },
     onTitleStart: function (level) {
         return `${ns("#", level)} `;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@honkit/markdown",
-  "version": "3.6.17",
+  "version": "3.7.2",
   "description": "Parse markdown content for honkit",
   "homepage": "https://github.com/honkit/honkit",
   "bugs": {
@@ -39,7 +39,7 @@
   },
   "dependencies": {
     "@honkit/html": "^3.6.17",
-    "@honkit/markup-it": "^3.6.17",
+    "@honkit/markup-it": "^3.7.2",
     "markdown-escape": "^1.0.1"
   },
   "devDependencies": {
@@ -49,5 +49,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3c9062a1ecd6c27fde465a1004a5a0b498689b9d"
+  "gitHead": "89e4ff9d86596d7c650c5e83e2d768435d6eef20"
 }

package/CHANGELOG.md

@@ -1,159 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [3.6.17](https://github.com/honkit/honkit/compare/v3.6.16...v3.6.17) (2021-02-15)
-
-**Note:** Version bump only for package @honkit/markdown
-
-
-
-
-
-## 3.6.16 (2020-12-15)
-
-**Note:** Version bump only for package @honkit/markdown
-
-
-
-
-
-## 3.6.15 (2020-12-05)
-
-**Note:** Version bump only for package @honkit/markdown
-
-
-
-
-
-## 3.6.14 (2020-11-29)
-
-**Note:** Version bump only for package @honkit/markdown
-
-
-
-
-
-## 3.6.13 (2020-11-17)
-
-
-### Bug Fixes
-
-* **honkit:** browser print layout in default theme ([#159](https://github.com/honkit/honkit/issues/159)) ([672cb9c](https://github.com/honkit/honkit/commit/672cb9c92f90dd154793b7a36d4dbf2654e7aec4))
-
-
-
-
-
-## 3.6.12 (2020-11-13)
-
-**Note:** Version bump only for package @honkit/markdown
-
-
-
-
-
-## [3.5.5](https://github.com/honkit/honkit/compare/v3.5.4...v3.5.5) (2020-08-02)
-
-**Note:** Version bump only for package @honkit/markdown
-
-
-
-
-
-## [3.5.4](https://github.com/honkit/honkit/compare/v3.5.3...v3.5.4) (2020-08-01)
-
-
-### Bug Fixes
-
-* add prepublish script ([810fcc7](https://github.com/honkit/honkit/commit/810fcc7f45f3b1ab8d9527e8738f9861fdbe2c31))
-
-
-
-
-
-## [3.5.1](https://github.com/honkit/honkit/compare/v3.5.0...v3.5.1) (2020-07-04)
-
-
-### Bug Fixes
-
-* **honkit:** use @honkit/markdown-legacy instead of @honkit/markdown ([e8549d5](https://github.com/honkit/honkit/commit/e8549d573603becc9f145a7c9cef5fd4ff013262))
-
-
-
-
-
-## [3.4.1](https://github.com/honkit/honkit/compare/v3.4.0...v3.4.1) (2020-06-29)
-
-**Note:** Version bump only for package @honkit/markdown
-
-
-
-
-
-## [3.3.11](https://github.com/honkit/honkit/compare/v3.3.10...v3.3.11) (2020-06-27)
-
-
-### Bug Fixes
-
-* **markdown:** Do not force convert Indented CodeBlock to Fenced code blocks ([#60](https://github.com/honkit/honkit/issues/60)) ([ef55687](https://github.com/honkit/honkit/commit/ef556874f42d27a4d7b323acbc92fcadd579d034))
-
-
-
-
-
-## [3.3.8](https://github.com/honkit/honkit/compare/v3.3.7...v3.3.8) (2020-06-18)
-
-**Note:** Version bump only for package @honkit/markdown
-
-
-
-
-
-## [3.3.7](https://github.com/honkit/honkit/compare/v3.3.6...v3.3.7) (2020-06-18)
-
-**Note:** Version bump only for package @honkit/markdown
-
-
-
-
-
-## [3.3.6](https://github.com/honkit/honkit/compare/v3.3.5...v3.3.6) (2020-06-18)
-
-**Note:** Version bump only for package @honkit/markdown
-
-
-
-
-
-## [3.3.5](https://github.com/honkit/honkit/compare/v3.3.4...v3.3.5) (2020-06-18)
-
-**Note:** Version bump only for package @honkit/markdown
-
-
-
-
-
-## [3.3.4](https://github.com/honkit/honkit/compare/v3.3.3...v3.3.4) (2020-06-17)
-
-**Note:** Version bump only for package @honkit/markdown
-
-
-
-
-
-## [3.3.1](https://github.com/honkit/honkit/compare/v3.3.0...v3.3.1) (2020-06-15)
-
-
-### Bug Fixes
-
-* **markdown:** fix markdown parser ([2a1d670](https://github.com/honkit/honkit/commit/2a1d6705521da848233b3518b5adab871a8dc5fb))
-
-
-
-
-
-# 3.3.0 (2020-06-14)
-
-**Note:** Version bump only for package @honkit/markdown