@cobapen/markdown 0.3.0 → 0.4.0

package/dist/code/fence-custom.d.ts

@@ -2,7 +2,7 @@ import { Options } from "markdown-it/index.mjs";
 import Renderer from "markdown-it/lib/renderer.mjs";
 import Token from "markdown-it/lib/token.mjs";
 interface Env {
-  showCodeTitleByDefault?: boolean;
+    showCodeTitleByDefault?: boolean;
 }
 /**
  * Custom fence renderer for markdown-it.

package/dist/code/fence-custom.js

@@ -6,46 +6,45 @@ import { InfoString } from "./info-string.js";
  * see: markdown-it/lib/renderer.mjs
  */
 export function fence_custom(tokens, idx, options, env, slf) {
-  const token = tokens[idx];
-  const info_str = token.info ? unescapeAll(token.info).trim() : "";
-  const info = new InfoString(info_str);
-  const langName = info.lang;
-  const langAttrs = info.attrs.join(" ");
-  let highlighted;
-  if (options.highlight) {
-    highlighted = options.highlight(token.content, langName, langAttrs) || escapeHtml(token.content);
-  }
-  else {
-    highlighted = escapeHtml(token.content);
-  }
-  if (highlighted.indexOf("<pre") === 0) {
-    return highlighted + "\n";
-  }
-  // If language exists, inject class gently, without modifying original token.
-  // May be, one day we will add .deepClone() for token and simplify this part, but
-  // now we prefer to keep things local.
-  if (info.hasLang) {
-    const i = token.attrIndex("class");
-    const tmpAttrs = token.attrs ? token.attrs.slice() : [];
-    if (i < 0) {
-      tmpAttrs.push(["class", options.langPrefix + langName]);
+    const token = tokens[idx];
+    const info_str = token.info ? unescapeAll(token.info).trim() : "";
+    const info = new InfoString(info_str);
+    const langName = info.lang;
+    const langAttrs = info.attrs.join(" ");
+    let highlighted;
+    if (options.highlight) {
+        highlighted = options.highlight(token.content, langName, langAttrs) || escapeHtml(token.content);
     }
     else {
-      tmpAttrs[i] = tmpAttrs[i].slice();
-      tmpAttrs[i][1] += " " + options.langPrefix + langName;
+        highlighted = escapeHtml(token.content);
     }
-    // Fake token just to render attributes
-    const tmpToken = {
-      attrs: tmpAttrs
-    };
-    if (info.title.length > 0) {
-      const style = (env.showCodeTitleByDefault === true)
-        ? ""
-        : " style=\"visibility:hidden;\"";
-      return `<pre><code${slf.renderAttrs(tmpToken)}>${highlighted}</code><span class="title"${style}>${info.title}</span></pre>\n`;
+    if (highlighted.indexOf("<pre") === 0) {
+        return highlighted + "\n";
     }
-    return `<pre><code${slf.renderAttrs(tmpToken)}>${highlighted}</code></pre>\n`;
-  }
-  return `<pre><code${slf.renderAttrs(token)}>${highlighted}</code></pre>\n`;
+    // If language exists, inject class gently, without modifying original token.
+    // May be, one day we will add .deepClone() for token and simplify this part, but
+    // now we prefer to keep things local.
+    if (info.hasLang) {
+        const i = token.attrIndex("class");
+        const tmpAttrs = token.attrs ? token.attrs.slice() : [];
+        if (i < 0) {
+            tmpAttrs.push(["class", options.langPrefix + langName]);
+        }
+        else {
+            tmpAttrs[i] = tmpAttrs[i].slice();
+            tmpAttrs[i][1] += " " + options.langPrefix + langName;
+        }
+        // Fake token just to render attributes
+        const tmpToken = {
+            attrs: tmpAttrs
+        };
+        if (info.title.length > 0) {
+            const style = (env.showCodeTitleByDefault === true)
+                ? ""
+                : " style=\"visibility:hidden;\"";
+            return `<pre><code${slf.renderAttrs(tmpToken)}>${highlighted}</code><span class="title"${style}>${info.title}</span></pre>\n`;
+        }
+        return `<pre><code${slf.renderAttrs(tmpToken)}>${highlighted}</code></pre>\n`;
+    }
+    return `<pre><code${slf.renderAttrs(token)}>${highlighted}</code></pre>\n`;
 }
-//# sourceMappingURL=fence-custom.js.map

package/dist/code/highlight.js

@@ -6,16 +6,16 @@
 import hljs from "highlight.js";
 import { InfoString } from "./info-string.js";
 function _debuglog(..._args) {
-  // if (_debuglog.caller.name !== "") return;
-  // console.log(...args);
+    // if (_debuglog.caller.name !== "") return;
+    // console.log(...args);
 }
 /** Get digits of the number. e.g. 1000 => 4 */
 function numDigits(n) {
-  return Math.floor(n).toString().length;
+    return Math.floor(n).toString().length;
 }
 /** Print a decimal nicely */
 function niceDec(n) {
-  return n.toFixed(3);
+    return n.toFixed(3);
 }
 /**
  * Highlight function with line number support
@@ -26,12 +26,12 @@ function niceDec(n) {
  * @returns
  */
 export function highlightWithLineNumber(code, lang, linestart) {
-  try {
-    /** convert if lang is specified + supported by highlight.js */
-    if (lang && hljs.getLanguage(lang)) {
-      /** do conversion */
-      let htmlLines = hljs.highlight(code, { language: lang }).value;
-      /**
+    try {
+        /** convert if lang is specified + supported by highlight.js */
+        if (lang && hljs.getLanguage(lang)) {
+            /** do conversion */
+            let htmlLines = hljs.highlight(code, { language: lang }).value;
+            /**
              * Attach the line number if specified.
              *
              * The given code is rendered in <pre><code>, so each line is terminated by '\n'.
@@ -46,33 +46,33 @@ export function highlightWithLineNumber(code, lang, linestart) {
              * - user-select: none
              * - width: ${numDigits}em
              */
-      if (linestart !== undefined) {
-        const lines = htmlLines.split("\n");
-        const elWidth = numDigits(linestart + lines.length) * 0.8;
-        const elStyle = "display:inline-block;" +
+            if (linestart !== undefined) {
+                const lines = htmlLines.split("\n");
+                const elWidth = numDigits(linestart + lines.length) * 0.8;
+                const elStyle = "display:inline-block;" +
                     "user-select:none;" +
                     `width: ${niceDec(elWidth)}em;`;
-        lines.forEach((line, i, lines) => {
-          lines[i] =
+                lines.forEach((line, i, lines) => {
+                    lines[i] =
                         "<div class=\"line\">" +
                             `<span class="line-no" style="${elStyle}">${linestart + i}</span>${line}` +
                             "</div>";
-        });
-        _debuglog(lines);
-        htmlLines = lines.join("");
-      }
-      return htmlLines;
+                });
+                _debuglog(lines);
+                htmlLines = lines.join("");
+            }
+            return htmlLines;
+        }
+        else {
+            // no language , no highlighting.
+            // If you want line numbers without highlighting, set language to
+            // "nohighlight" or "text"
+            return "";
+        }
     }
-    else {
-      // no language , no highlighting.
-      // If you want line numbers without highlighting, set language to
-      // "nohighlight" or "text"
-      return "";
+    catch (_) {
+        return "";
     }
-  }
-  catch (_) {
-    return "";
-  }
 }
 /**
  * Exported function for markdown-it
@@ -83,9 +83,8 @@ export function highlightWithLineNumber(code, lang, linestart) {
  * @returns
  */
 export function highlighterForMarkdownIt(str, lang, attrs) {
-  _debuglog(lang ? lang : "(lang is empty or undefined)");
-  const info = new InfoString(lang + " " + attrs);
-  _debuglog(info);
-  return highlightWithLineNumber(str, info.lang, info.linestart);
+    _debuglog(lang ? lang : "(lang is empty or undefined)");
+    const info = new InfoString(lang + " " + attrs);
+    _debuglog(info);
+    return highlightWithLineNumber(str, info.lang, info.linestart);
 }
-//# sourceMappingURL=highlight.js.map

package/dist/code/info-string.d.ts

@@ -2,25 +2,25 @@
  * InfoString parses info_string from fenced code block.
  */
 export declare class InfoString {
-  private readonly _lang;
-  private readonly _attrs;
-  private readonly _title;
-  private readonly _linestart;
-  constructor(info: string);
-  get lang(): string;
-  get attrs(): string[];
-  get title(): string;
-  get linestart(): number | undefined;
-  get hasLang(): boolean;
-  /** Parse info_string into an array of strings. All quotes are removed*/
-  static parseInfoString(info: string): string[];
-  /** Parse metadata notation "{filename:line, ...}"" */
-  static parseMetaNotation(text: string): {
-    filename: string;
-    line: number;
-  } | undefined;
-  /** From attributes list, return title metadata */
-  static getTitle(attr: string[]): string;
-  /** From attributes list, return line number if defined */
-  static getLineStart(attr: string[]): number | undefined;
+    private readonly _lang;
+    private readonly _attrs;
+    private readonly _title;
+    private readonly _linestart;
+    constructor(info: string);
+    get lang(): string;
+    get attrs(): string[];
+    get title(): string;
+    get linestart(): number | undefined;
+    get hasLang(): boolean;
+    /** Parse info_string into an array of strings. All quotes are removed*/
+    static parseInfoString(info: string): string[];
+    /** Parse metadata notation "{filename:line, ...}"" */
+    static parseMetaNotation(text: string): {
+        filename: string;
+        line: number;
+    } | undefined;
+    /** From attributes list, return title metadata */
+    static getTitle(attr: string[]): string;
+    /** From attributes list, return line number if defined */
+    static getLineStart(attr: string[]): number | undefined;
 }

package/dist/code/info-string.js

@@ -2,128 +2,127 @@
  * InfoString parses info_string from fenced code block.
  */
 export class InfoString {
-  _lang;
-  _attrs;
-  _title;
-  _linestart;
-  constructor(info) {
-    if (info.length > 0) {
-      const arr = InfoString.parseInfoString(info);
-      this._lang = arr[0];
-      this._attrs = arr.slice(1);
-      this._title = InfoString.getTitle(this._attrs);
-      this._linestart = InfoString.getLineStart(this._attrs);
+    _lang;
+    _attrs;
+    _title;
+    _linestart;
+    constructor(info) {
+        if (info.length > 0) {
+            const arr = InfoString.parseInfoString(info);
+            this._lang = arr[0];
+            this._attrs = arr.slice(1);
+            this._title = InfoString.getTitle(this._attrs);
+            this._linestart = InfoString.getLineStart(this._attrs);
+        }
+        else {
+            this._lang = "";
+            this._attrs = [];
+            this._title = "";
+            this._linestart = undefined;
+        }
+    }
+    get lang() {
+        return this._lang;
     }
-    else {
-      this._lang = "";
-      this._attrs = [];
-      this._title = "";
-      this._linestart = undefined;
+    get attrs() {
+        return this._attrs;
     }
-  }
-  get lang() {
-    return this._lang;
-  }
-  get attrs() {
-    return this._attrs;
-  }
-  get title() {
-    return this._title;
-  }
-  get linestart() {
-    return this._linestart;
-  }
-  get hasLang() {
-    return this._lang.length > 0;
-  }
-  /** Parse info_string into an array of strings. All quotes are removed*/
-  static parseInfoString(info) {
-    // There are 4 possible tokens, but it can be reduced to 2 patterns.
-    // arg, "arg quoted", key=value, key="value quoted"
-    // 
-    // This function returns a quote-removed string. 
-    // 
-    // const regex = /([^\s]+=)?(?:"([^"]*)"|'([^']*)'|([^\s]+))/g;
-    //                 ~~~~~~~~     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
-    //                 key=         "value" 'value' value
-    //
-    // The regex above does not support escape letters. The next regex
-    // is escape char aware. 
-    // 
-    // NOTE: This class is designed to handle escape letters. However, tools 
-    // might decide to unescape info_string before used (e.g. markdown-it). 
-    // In such case, you might need to use double-escaped quotes.
-    // 
-    const dq = "[^\"\\\\]*(?:\\\\.|[^\"\\\\]*)*"; // [^"]*
-    const sq = "[^\'\\\\]*(?:\\\\.|[^\'\\\\]*)*"; // [^']*
-    //          ~~~~~~~~~~   ~~~~~ ~~~~~~~~~~
-    //          char seq   ( escape  char seq )*
-    // 
-    const ptn = `([^\\s]+=)?(?:"(${dq})"|'(${sq})'|([^\\s]+))`;
-    //           ~~~~~~~~~~    ~~~~~~~~~ ~~~~~~~~~ ~~~~~~~~~
-    //           key=          "value"   'value'   value
-    const regex = new RegExp(ptn, "g");
-    const result = [];
-    let match;
-    while ((match = regex.exec(info)) !== null) {
-      let text = (match[1] || "") + (match[2] || match[3] || match[4] || "");
-      text = unescape(text).trim();
-      result.push(text);
+    get title() {
+        return this._title;
     }
-    return result;
-  }
-  /** Parse metadata notation "{filename:line, ...}"" */
-  static parseMetaNotation(text) {
-    const match = text.match(/^\{\s*([^:]+):(\d+)\s*\}$/);
-    if (match) {
-      return {
-        filename: match[1],
-        line: parseInt(match[2], 10),
-      };
+    get linestart() {
+        return this._linestart;
     }
-    return undefined;
-  }
-  /** From attributes list, return title metadata */
-  static getTitle(attr) {
-    const titleAttr = attr.find(x => x.startsWith("title=")) ?? "";
-    if (titleAttr.length > 0) {
-      const match = titleAttr.match(/^title=(.*)$/);
-      if (match) {
-        let value = match[1].trim();
-        if (value.startsWith("\"") && value.endsWith("\"")) {
-          value = value.slice(1, -1);
-          value = unescape(value).trim();
+    get hasLang() {
+        return this._lang.length > 0;
+    }
+    /** Parse info_string into an array of strings. All quotes are removed*/
+    static parseInfoString(info) {
+        // There are 4 possible tokens, but it can be reduced to 2 patterns.
+        // arg, "arg quoted", key=value, key="value quoted"
+        // 
+        // This function returns a quote-removed string. 
+        // 
+        // const regex = /([^\s]+=)?(?:"([^"]*)"|'([^']*)'|([^\s]+))/g;
+        //                 ~~~~~~~~     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
+        //                 key=         "value" 'value' value
+        //
+        // The regex above does not support escape letters. The next regex
+        // is escape char aware. 
+        // 
+        // NOTE: This class is designed to handle escape letters. However, tools 
+        // might decide to unescape info_string before used (e.g. markdown-it). 
+        // In such case, you might need to use double-escaped quotes.
+        // 
+        const dq = "[^\"\\\\]*(?:\\\\.|[^\"\\\\]*)*"; // [^"]*
+        const sq = "[^\'\\\\]*(?:\\\\.|[^\'\\\\]*)*"; // [^']*
+        //          ~~~~~~~~~~   ~~~~~ ~~~~~~~~~~
+        //          char seq   ( escape  char seq )*
+        // 
+        const ptn = `([^\\s]+=)?(?:"(${dq})"|'(${sq})'|([^\\s]+))`;
+        //           ~~~~~~~~~~    ~~~~~~~~~ ~~~~~~~~~ ~~~~~~~~~
+        //           key=          "value"   'value'   value
+        const regex = new RegExp(ptn, "g");
+        const result = [];
+        let match;
+        while ((match = regex.exec(info)) !== null) {
+            let text = (match[1] || "") + (match[2] || match[3] || match[4] || "");
+            text = unescape(text).trim();
+            result.push(text);
         }
-        return value;
-      }
-      else {
-        throw new Error("Must not fail. Check impl.");
-      }
+        return result;
     }
-    if (attr.length > 0) {
-      const meta = InfoString.parseMetaNotation(attr[0]);
-      if (meta && meta.filename.length > 0) {
-        return meta.filename;
-      }
+    /** Parse metadata notation "{filename:line, ...}"" */
+    static parseMetaNotation(text) {
+        const match = text.match(/^\{\s*([^:]+):(\d+)\s*\}$/);
+        if (match) {
+            return {
+                filename: match[1],
+                line: parseInt(match[2], 10),
+            };
+        }
+        return undefined;
     }
-    return "";
-  }
-  /** From attributes list, return line number if defined */
-  static getLineStart(attr) {
-    const lineAttr = attr.find(x => x.startsWith("linestart=")) ?? "";
-    if (lineAttr.length > 0) {
-      return parseInt(lineAttr.split("=")[1].trim());
+    /** From attributes list, return title metadata */
+    static getTitle(attr) {
+        const titleAttr = attr.find(x => x.startsWith("title=")) ?? "";
+        if (titleAttr.length > 0) {
+            const match = titleAttr.match(/^title=(.*)$/);
+            if (match) {
+                let value = match[1].trim();
+                if (value.startsWith("\"") && value.endsWith("\"")) {
+                    value = value.slice(1, -1);
+                    value = unescape(value).trim();
+                }
+                return value;
+            }
+            else {
+                throw new Error("Must not fail. Check impl.");
+            }
+        }
+        if (attr.length > 0) {
+            const meta = InfoString.parseMetaNotation(attr[0]);
+            if (meta && meta.filename.length > 0) {
+                return meta.filename;
+            }
+        }
+        return "";
     }
-    if (attr.length > 0) {
-      const meta = InfoString.parseMetaNotation(attr[0]);
-      if (meta && meta.line > 0) {
-        return meta.line;
-      }
+    /** From attributes list, return line number if defined */
+    static getLineStart(attr) {
+        const lineAttr = attr.find(x => x.startsWith("linestart=")) ?? "";
+        if (lineAttr.length > 0) {
+            return parseInt(lineAttr.split("=")[1].trim());
+        }
+        if (attr.length > 0) {
+            const meta = InfoString.parseMetaNotation(attr[0]);
+            if (meta && meta.line > 0) {
+                return meta.line;
+            }
+        }
+        return undefined;
     }
-    return undefined;
-  }
 }
 function unescape(text) {
-  return text.replaceAll(/\\\"/g, "\"").replaceAll(/\\\'/g, "'");
+    return text.replaceAll(/\\\"/g, "\"").replaceAll(/\\\'/g, "'");
 }
-//# sourceMappingURL=info-string.js.map

package/dist/index.d.ts

@@ -1,42 +1,42 @@
 import markdownIt, { Options as MarkdownOptions } from "markdown-it";
 import { Options as MathOptions } from "./math/mathjax.js";
 export interface Config {
-  /**
+    /**
      * Set "true" to display the title (if specified) of the fenced code block.
      * The title is hidden by default, and user must explicitly override the style.
      */
-  showCodeTitleByDefault: boolean;
-  /**
+    showCodeTitleByDefault: boolean;
+    /**
      * MarkdownIt options
      */
-  markdown: Partial<MarkdownOptions>;
-  /**
+    markdown: Partial<MarkdownOptions>;
+    /**
      * MathJax options
      */
-  math: Partial<MathOptions>;
+    math: Partial<MathOptions>;
 }
 export type Options = Partial<Config>;
 export declare class CMarkdown {
-  private readonly _config;
-  private readonly _mj;
-  private readonly _md;
-  constructor(option?: Options);
-  /**
+    private readonly _config;
+    private readonly _mj;
+    private readonly _md;
+    constructor(option?: Options);
+    /**
      * Install plugins and renderers to the markdown-it instance.
      *
      * @param md The instance
      */
-  setup(md: markdownIt): void;
-  /**
+    setup(md: markdownIt): void;
+    /**
      * Render html from markdown.
      *
      * @param text markdown text
      * @returns html text
      */
-  render(text: string): string;
-  /**
+    render(text: string): string;
+    /**
      * Returns the MathJax CSS.
      * @returns
      */
-  mathcss(): string;
+    mathcss(): string;
 }