@honkit/asciidoc 4.0.8 → 5.1.0

package/lib/__tests__/glossary.d.ts

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

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

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

package/lib/__tests__/glossary.js

@@ -6,11 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const assert_1 = __importDefault(require("assert"));
-const glossary = require("../").glossary;
+const __1 = __importDefault(require("../"));
 let LEXED;
 beforeAll(() => {
     const CONTENT = fs_1.default.readFileSync(path_1.default.join(__dirname, "fixtures/GLOSSARY.adoc"), "utf8");
-    LEXED = glossary(CONTENT);
+    LEXED = __1.default.glossary(CONTENT);
 });
 it("should only get heading + paragraph pairs", () => {
     assert_1.default.equal(LEXED.length, 4);
@@ -21,6 +21,6 @@ it("should output simple name/description objects", () => {
     }));
 });
 it("should correctly convert it to text", () => {
-    const text = glossary.toText(LEXED);
-    assert_1.default.deepEqual(glossary(text), LEXED);
+    const text = __1.default.glossary.toText(LEXED);
+    assert_1.default.deepEqual(__1.default.glossary(text), LEXED);
 });

package/lib/__tests__/inline.d.ts

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

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

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

package/lib/__tests__/inline.js

@@ -0,0 +1,10 @@
+"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 __1 = __importDefault(require("../"));
+it("should render inline AsciiDoc", function () {
+    assert_1.default.equal(__1.default.inline("Hello **World**").content, "Hello <strong>World</strong>");
+});

package/lib/__tests__/langs.d.ts

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

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

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

package/lib/__tests__/langs.js

@@ -0,0 +1,24 @@
+"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 path_1 = __importDefault(require("path"));
+const assert_1 = __importDefault(require("assert"));
+const __1 = __importDefault(require("../"));
+var LEXED;
+beforeAll(function () {
+    var CONTENT = fs_1.default.readFileSync(path_1.default.join(__dirname, "./fixtures/LANGS.adoc"), "utf8");
+    LEXED = __1.default.langs(CONTENT);
+});
+it("should detect paths and titles", function () {
+    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", function () {
+    var text = __1.default.langs.toText(LEXED);
+    assert_1.default.deepEqual(__1.default.langs(text), LEXED);
+});

package/lib/__tests__/page.d.ts

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

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

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

package/lib/__tests__/page.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 fs_1 = __importDefault(require("fs"));
+const assert_1 = __importDefault(require("assert"));
+const __1 = __importDefault(require("../"));
+it("should gen content", function () {
+    const CONTENT = fs_1.default.readFileSync(path_1.default.join(__dirname, "./fixtures/PAGE.adoc"), "utf8");
+    const LEXED = __1.default.page(CONTENT);
+    (0, assert_1.default)(LEXED.content);
+});
+it("should include file", function () {
+    const result = __1.default.page(`= GitBook User Manual
+
+== Usage
+
+include::src/__tests__/fixtures/usage.adoc[]
+`).content;
+    // assert.match is available in Node > 12.16.0
+    (0, assert_1.default)(result.match(/create a book/g) !== null);
+});
+it("should use font icons by default", function () {
+    const result = __1.default.page(`= HonKit User Manual
+
+== Install
+
+IMPORTANT: Do not forgot to install \`yarn\`
+`).content;
+    // assert.match is available in Node > 12.16.0
+    (0, assert_1.default)(result.match(/fa icon-important/g) !== null);
+});
+it("should allow users to override icons attribute", function () {
+    const result = __1.default.page(`= HonKit User Manual
+// override icons attribute
+:icons:
+
+== Install
+
+IMPORTANT: Do not forgot to install \`yarn\`
+`).content;
+    // assert.doesNotMatch is available in Node > 12.16.0
+    (0, assert_1.default)(result.match(/fa icon-important/g) === null);
+});

package/lib/__tests__/readme.d.ts

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

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

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

package/lib/__tests__/readme.js

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

package/lib/__tests__/summary.d.ts

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

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

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

package/lib/__tests__/summary.js

@@ -0,0 +1,48 @@
+"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 path_1 = __importDefault(require("path"));
+const assert_1 = __importDefault(require("assert"));
+const __1 = __importDefault(require("../"));
+var LEXED, PART;
+beforeAll(function () {
+    var CONTENT = fs_1.default.readFileSync(path_1.default.join(__dirname, "./fixtures/SUMMARY.adoc"), "utf8");
+    LEXED = __1.default.summary(CONTENT);
+    PART = LEXED.parts[0];
+    // todo: add support for parts in asciidoc
+});
+it("should detect parts", function () {
+    assert_1.default.equal(LEXED.parts.length, 1);
+});
+it("should detect articles", function () {
+    assert_1.default.equal(PART.articles.length, 5);
+});
+it("should support articles", function () {
+    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", function () {
+    (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", function () {
+    assert_1.default.equal(PART.articles[0].ref, "chapter-1/README.adoc");
+    assert_1.default.equal(PART.articles[1].ref, "chapter-2/README.adoc");
+    assert_1.default.equal(PART.articles[2].ref, "chapter-3/README.adoc");
+});
+it("should correctly convert it to text", function () {
+    var text = __1.default.summary.toText(LEXED);
+    assert_1.default.deepEqual(__1.default.summary(text), LEXED);
+});

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("@honkit/html").Parsers;
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

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

package/lib/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const html_1 = __importDefault(require("@honkit/html"));
+const html_1 = require("@honkit/html");
 const toHTML_1 = __importDefault(require("./toHTML"));
 const toAsciidoc_1 = __importDefault(require("./toAsciidoc"));
-module.exports = html_1.default.createParser(toHTML_1.default, toAsciidoc_1.default);
+exports.default = (0, html_1.createParser)(toHTML_1.default, toAsciidoc_1.default);

package/lib/toAsciidoc.d.ts

@@ -0,0 +1,15 @@
+declare const _default: {
+    onTitleStart: (level: any) => string;
+    onTitleEnd: (level: any) => any;
+    onParagraphStart: () => any;
+    onParagraphEnd: () => any;
+    onLinkStart: (href: any) => string;
+    onLinkEnd: () => string;
+    onListStart: (level: any) => string;
+    onListEnd: () => string;
+    onListItemStart: (level: any) => string;
+    onListItemEnd: () => string;
+    onHR: () => string;
+};
+export default _default;
+//# sourceMappingURL=toAsciidoc.d.ts.map

package/lib/toAsciidoc.d.ts.map

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

package/lib/toHTML.d.ts

@@ -0,0 +1,7 @@
+import { ToHTMLFunction } from "@honkit/html";
+declare const _default: {
+    block: ToHTMLFunction;
+    inline: ToHTMLFunction;
+};
+export default _default;
+//# sourceMappingURL=toHTML.d.ts.map

package/lib/toHTML.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toHTML.d.ts","sourceRoot":"","sources":["../src/toHTML.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;;;;;AAkB9C,wBAGE"}

package/lib/toHTML.js

@@ -6,14 +6,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asciidoctor_1 = __importDefault(require("asciidoctor"));
 const asciidoctor = (0, asciidoctor_1.default)();
 // Render Asciidoc to HTML (block)
-function asciidocToHTML(content) {
-    return asciidoctor.convert(content, { safe: "server", attributes: { showtitle: "", icons: "font@" } });
-}
+const asciidocToHTML = (content, options) => {
+    return asciidoctor.convert(content, {
+        safe: "server",
+        attributes: { showtitle: "", icons: "font@" },
+        base_dir: options === null || options === void 0 ? void 0 : options.baseDirectory
+    });
+};
 // Render Asciidoc to HTML (inline)
-function asciidocToHTMLInline(content) {
-    return asciidoctor.convert(content, { doctype: "inline" });
-}
+const asciidocToHTMLInline = (content, options) => {
+    return asciidoctor.convert(content, { doctype: "inline", base_dir: options === null || options === void 0 ? void 0 : options.baseDirectory });
+};
 exports.default = {
     block: asciidocToHTML,
-    inline: asciidocToHTMLInline,
+    inline: asciidocToHTMLInline
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@honkit/asciidoc",
-  "version": "4.0.8",
+  "version": "5.1.0",
   "description": "Parse AsciiDoc content for gitbook",
   "homepage": "https://github.com/honkit/honkit",
   "bugs": {
@@ -32,20 +32,21 @@
   ],
   "scripts": {
     "build": "tsc -p .",
-    "test": "yarn build && jest src",
+    "test": "jest src",
     "prepublish": "npm run --if-present build"
   },
   "dependencies": {
-    "@honkit/html": "^4.0.8",
+    "@honkit/html": "^5.1.0",
     "asciidoctor": "^2.2.0",
     "lodash": "^4.13.1"
   },
   "devDependencies": {
-    "mocha": "^10.0.0"
+    "jest": "^29.0.3",
+    "ts-jest": "^29.1.1"
   },
   "publishConfig": {
     "access": "public"
   },
   "authors": "azu <azuciao@gmail.com>",
-  "gitHead": "6a2337bdac8357887496ce7e84a8184e40907235"
+  "gitHead": "6acb1146ae4c21d64283f88f06f26427a35f349b"
 }