@honkit/html 4.0.7 → 5.0.0

package/lib/dom.d.ts

@@ -0,0 +1,31 @@
+/// <reference types="cheerio" />
+/**
+    Parse an HTML string and return its content
+
+    @param html
+    @return {cheerio.Root}
+*/
+export declare function parse(html: string): cheerio.Root | cheerio.Cheerio;
+/**
+    Return main element for a DOM
+
+    @param {cheerio.DOM}
+    @return {cheerio.Node}
+*/
+export declare function root($: any): any;
+/**
+    Return text node of an element
+
+    @param {cheerio.Node}
+    @return {string}
+*/
+export declare function textNode($el: any): any;
+/**
+    Cleanup a DOM by removing all useless divs
+
+    @param {cheerio.Node}
+    @param {cheerio.DOM}
+    @return {cheerio.Node}
+*/
+export declare function cleanup($el: any, $: any): any;
+//# sourceMappingURL=dom.d.ts.map

package/lib/dom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dom.d.ts","sourceRoot":"","sources":["../src/dom.ts"],"names":[],"mappings":";AAGA;;;;;EAKE;AACF,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,kCAKjC;AAED;;;;;EAKE;AACF,wBAAgB,IAAI,CAAC,CAAC,KAAA,OAGrB;AAED;;;;;EAKE;AACF,wBAAgB,QAAQ,CAAC,GAAG,KAAA,OAS3B;AAED;;;;;;EAME;AACF,wBAAgB,OAAO,CAAC,GAAG,KAAA,EAAE,CAAC,KAAA,OAS7B"}

package/lib/glossary.d.ts

@@ -0,0 +1,12 @@
+/**
+    Parse an HTML content into a list of glossary entry
+
+    @param {string} html
+    @return {Array}
+*/
+declare function parseGlossary(html: string): {
+    name: string;
+    description: any;
+}[];
+export default parseGlossary;
+//# sourceMappingURL=glossary.d.ts.map

package/lib/glossary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"glossary.d.ts","sourceRoot":"","sources":["../src/glossary.ts"],"names":[],"mappings":"AAGA;;;;;EAKE;AACF,iBAAS,aAAa,CAAC,IAAI,EAAE,MAAM;UAGF,MAAM;iBAAe,GAAG;IAgBxD;AACD,eAAe,aAAa,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,42 @@
+import { SummaryPart } from "./summary";
+export type ToHTMLOptions = {
+    baseDirectory: string;
+};
+export type ToHTMLFunction = (content: string, options?: ToHTMLOptions) => string;
+export type ToTextFunction = (content: any) => string;
+export type { SummaryPart };
+export type ParserSummary = ((content: string, options?: ToHTMLOptions) => {
+    parts: SummaryPart[];
+}) & {
+    toText: ToTextFunction;
+};
+export type ParserGlossary = ((content: string, options?: ToHTMLOptions) => string[]) & {
+    toText: ToTextFunction;
+};
+export type ParserLangs = ((content: string, options?: ToHTMLOptions) => string[]) & {
+    toText: ToTextFunction;
+};
+export type ParserREADME = (content: string, options?: ToHTMLOptions) => {
+    title: string;
+    description: string;
+};
+export type ParserPage = ((content: string, options?: ToHTMLOptions) => {
+    content: string;
+}) & {
+    prepare?: (content: string, options?: ToHTMLOptions) => string;
+};
+export type ParserInline = (content: string, options?: ToHTMLOptions) => {
+    content: string;
+};
+export type Parsers = {
+    summary: ParserSummary;
+    glossary: ParserGlossary;
+    langs: ParserLangs;
+    readme: ParserREADME;
+    page: ParserPage;
+    inline: ParserInline;
+};
+declare function createParser(toHTML: any, toText?: any): Parsers;
+declare const defaultParser: Parsers;
+export { defaultParser as default, createParser };
+//# 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":"AAGA,OAAgB,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAcjD,MAAM,MAAM,aAAa,GAAG;IACxB,aAAa,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,MAAM,CAAC;AAElF,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,GAAG,KAAK,MAAM,CAAC;AACtD,YAAY,EAAE,WAAW,EAAE,CAAC;AAC5B,MAAM,MAAM,aAAa,GAAG,CAAC,CACzB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa,KACtB;IACD,KAAK,EAAE,WAAW,EAAE,CAAC;CACxB,CAAC,GAAG;IACD,MAAM,EAAE,cAAc,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,MAAM,EAAE,CAAC,GAAG;IACpF,MAAM,EAAE,cAAc,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,MAAM,EAAE,CAAC,GAAG;IACjF,MAAM,EAAE,cAAc,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,YAAY,GAAG,CACvB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa,KACtB;IACD,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,UAAU,GAAG,CAAC,CACtB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa,KACtB;IACD,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC,GAAG;IAGD,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,MAAM,CAAC;CAClE,CAAC;AACF,MAAM,MAAM,YAAY,GAAG,CACvB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa,KACtB;IACD,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC;AACF,MAAM,MAAM,OAAO,GAAG;IAClB,OAAO,EAAE,aAAa,CAAC;IACvB,QAAQ,EAAE,cAAc,CAAC;IACzB,KAAK,EAAE,WAAW,CAAC;IACnB,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;CACxB,CAAC;AAYF,iBAAS,YAAY,CAAC,MAAM,KAAA,EAAE,MAAM,MAAY,GAAG,OAAO,CAwBzD;AAED,QAAA,MAAM,aAAa,SAA2B,CAAC;AAC/C,OAAO,EAAE,aAAa,IAAI,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/lib/index.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.createParser = exports.default = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const totext_1 = __importDefault(require("./totext"));
 // import
@@ -16,22 +17,22 @@ const htmlParser = {
     glossary: glossary_1.default,
     langs: langs_1.default,
     readme: readme_1.default,
-    page: page_1.default,
+    page: page_1.default
 };
 // Compose a function with a transform function for the first argument only
 function compose(toHTML, fn) {
-    return function () {
-        const args = lodash_1.default.toArray(arguments);
-        args[0] = toHTML(args[0]);
-        return fn.apply(null, args);
+    return function (content, options) {
+        // e.g. convert asciidoc to html
+        const html = toHTML(content, options);
+        return fn.call(this, html);
     };
 }
 // Create a HonKit parser from an HTML converter
 function createParser(toHTML, toText = undefined) {
-    if (lodash_1.default.isFunction(toHTML)) {
+    if (typeof toHTML === "function") {
         toHTML = {
             inline: toHTML,
-            block: toHTML,
+            block: toHTML
         };
     }
     const parser = {
@@ -40,7 +41,7 @@ function createParser(toHTML, toText = undefined) {
         langs: compose(toHTML.block, htmlParser.langs),
         readme: compose(toHTML.block, htmlParser.readme),
         page: compose(toHTML.block, htmlParser.page),
-        inline: compose(toHTML.inline, htmlParser.page),
+        inline: compose(toHTML.inline, htmlParser.page)
     };
     // @ts-expect-error
     const _toText = new totext_1.default(toText);
@@ -49,5 +50,6 @@ function createParser(toHTML, toText = undefined) {
     parser.glossary.toText = _toText.glossary;
     return parser;
 }
-module.exports = createParser(lodash_1.default.identity);
-module.exports.createParser = createParser;
+exports.createParser = createParser;
+const defaultParser = createParser(lodash_1.default.identity);
+exports.default = defaultParser;

package/lib/langs.d.ts

@@ -0,0 +1,9 @@
+/**
+    Parse an HTML content into a list of language
+
+    @param {string} html
+    @return {Array}
+*/
+declare function parseLangs(content: string): any[];
+export default parseLangs;
+//# sourceMappingURL=langs.d.ts.map

package/lib/langs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"langs.d.ts","sourceRoot":"","sources":["../src/langs.ts"],"names":[],"mappings":"AAEA;;;;;EAKE;AACF,iBAAS,UAAU,CAAC,OAAO,EAAE,MAAM,SAOlC;AAED,eAAe,UAAU,CAAC"}

package/lib/page.d.ts

@@ -0,0 +1,11 @@
+/**
+    Parse content of a page
+
+    @param {string} html
+    @return {Object}
+*/
+declare function parsePage(html: any): {
+    content: any;
+};
+export default parsePage;
+//# sourceMappingURL=page.d.ts.map

package/lib/page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page.d.ts","sourceRoot":"","sources":["../src/page.ts"],"names":[],"mappings":"AAAA;;;;;EAKE;AACF,iBAAS,SAAS,CAAC,IAAI,KAAA;;EAItB;AACD,eAAe,SAAS,CAAC"}

package/lib/readme.d.ts

@@ -0,0 +1,12 @@
+/**
+    Parse an HTML content into metadata about a readme
+
+    @param {string} html
+    @return {Object}
+*/
+declare function parseReadme(html: any): {
+    title: any;
+    description: any;
+};
+export default parseReadme;
+//# sourceMappingURL=readme.d.ts.map

package/lib/readme.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readme.d.ts","sourceRoot":"","sources":["../src/readme.ts"],"names":[],"mappings":"AAEA;;;;;EAKE;AACF,iBAAS,WAAW,CAAC,IAAI,KAAA;;;EAOxB;AAED,eAAe,WAAW,CAAC"}

package/lib/summary.d.ts

@@ -0,0 +1,15 @@
+export type SummaryPart = {
+    title: string;
+    articles: any[];
+};
+/**
+ Parse an HTML content into a tree of articles/parts
+
+ @param {string} html
+ @return {Object}
+ */
+declare function parseSummary(html: string): {
+    parts: SummaryPart[];
+};
+export default parseSummary;
+//# sourceMappingURL=summary.d.ts.map

package/lib/summary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../src/summary.ts"],"names":[],"mappings":"AA6HA,MAAM,MAAM,WAAW,GAAG;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,GAAG,EAAE,CAAC;CACnB,CAAC;AAEF;;;;;GAKG;AACH,iBAAS,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG;IAAE,KAAK,EAAE,WAAW,EAAE,CAAA;CAAE,CAoB5D;AAED,eAAe,YAAY,CAAC"}

package/lib/summary.js

@@ -28,11 +28,11 @@ const SELECTOR_LIST = "ol, ul";
 const SELECTOR_LINK = "> a, p > a";
 const SELECTOR_PART = "h2, h3, h4";
 /**
-    Find a list
+ Find a list
 
-    @param {cheerio.Node}
-    @return {cheerio.Node}
-*/
+ @param {cheerio.Node}
+ @return {cheerio.Node}
+ */
 function findList($parent) {
     const $container = $parent.children(".olist");
     if ($container.length > 0)
@@ -40,12 +40,12 @@ function findList($parent) {
     return $parent.children(SELECTOR_LIST);
 }
 /**
-    Parse a ul list and return list of chapters recursvely
+ Parse a ul list and return list of chapters recursvely
 
-    @param {cheerio.Node}
-    @param {cheerio.DOM}
-    @return {Array}
-*/
+ @param {cheerio.Node}
+ @param {cheerio.DOM}
+ @return {Array}
+ */
 function parseList($ul, $) {
     const articles = [];
     $ul.children("li").each(function () {
@@ -70,11 +70,11 @@ function parseList($ul, $) {
     return articles;
 }
 /**
-     Find all parts and their corresponding lists
+ Find all parts and their corresponding lists
 
-     @param {cheerio.Node}
-     @param {cheerio.DOM}
-     @return {Array<{title: String, list: cheerio.Node}>}
+ @param {cheerio.Node}
+ @param {cheerio.DOM}
+ @return {Array<{title: String, list: cheerio.Node}>}
  */
 function findParts($parent, $) {
     // Find parts and lists
@@ -91,7 +91,7 @@ function findParts($parent, $) {
             }
             previousPart = {
                 title: getPartTitle(el, $),
-                list: null,
+                list: null
             };
         }
         else {
@@ -102,7 +102,7 @@ function findParts($parent, $) {
             else {
                 previousPart = {
                     title: "",
-                    list: el,
+                    list: el
                 };
             }
             parts.push(previousPart);
@@ -116,30 +116,30 @@ function findParts($parent, $) {
     return parts;
 }
 /**
-    True if the element is a part
+ True if the element is a part
 
-    @param el
-    @return {boolean}
+ @param el
+ @return {boolean}
  */
 function isPartNode(el) {
     return SELECTOR_PART.indexOf(el.name) !== -1;
 }
 /**
-    Parse the title of a part element
+ Parse the title of a part element
 
-    @param el
-    @param {cheerio.DOM} $
-    @return {string}
+ @param el
+ @param {cheerio.DOM} $
+ @return {string}
  */
 function getPartTitle(el, $) {
     return $(el).text().trim();
 }
 /**
-    Parse an HTML content into a tree of articles/parts
+ Parse an HTML content into a tree of articles/parts
 
-    @param {string} html
-    @return {Object}
-*/
+ @param {string} html
+ @return {Object}
+ */
 function parseSummary(html) {
     const $ = dom.parse(html);
     const $root = dom.cleanup(dom.root($), $);
@@ -151,11 +151,11 @@ function parseSummary(html) {
         part = parts[i];
         parsedParts.push({
             title: part.title,
-            articles: parseList($(part.list), $),
+            articles: parseList($(part.list), $)
         });
     }
     return {
-        parts: parsedParts,
+        parts: parsedParts
     };
 }
 exports.default = parseSummary;

package/lib/totext.d.ts

@@ -0,0 +1,3 @@
+declare function ToText(markup: any): any;
+export default ToText;
+//# sourceMappingURL=totext.d.ts.map

package/lib/totext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"totext.d.ts","sourceRoot":"","sources":["../src/totext.ts"],"names":[],"mappings":"AAOA,iBAAS,MAAM,CAAC,MAAM,KAAA,OAQrB;AAkKD,eAAe,MAAM,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@honkit/html",
-  "version": "4.0.7",
+  "version": "5.0.0",
   "description": "Parse HTML content for gitbook",
   "homepage": "https://github.com/honkit/honkit",
   "bugs": {
@@ -34,7 +34,7 @@
   "scripts": {
     "build": "tsc -p .",
     "clean": "rimraf lib/",
-    "test": "mocha test/",
+    "test": "mocha",
     "prepublish": "npm run --if-present build"
   },
   "dependencies": {
@@ -43,11 +43,13 @@
     "q": "^1.1.2"
   },
   "devDependencies": {
-    "mocha": "^10.0.0",
-    "rimraf": "^3.0.2"
+    "mocha": "^10.2.0",
+    "rimraf": "^3.0.2",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.3"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b12f6eb9937552d1ff1d9a8cad75e74f1664c666"
+  "gitHead": "9feb7e251f1d305c2cd521f78f0a275b847a6e1b"
 }