pantsdown 1.3.1 → 1.4.1

package/{styles.css.d.ts → src/css/styles.css.d.ts}

@@ -1,4 +1,4 @@
 // TODO: I'm not so sure about this, come back to this
 // once Bun has official css loader
-const path: string;
-export default path;
+const styles: string;
+export default styles;

package/src/pantsdown.ts

@@ -1,3 +1,4 @@
+import GithubSlugger from "github-slugger";
 import { Lexer } from "./lexer.ts";
 import { Parser } from "./parser.ts";
 import { type PantsdownConfig } from "./types.ts";
@@ -12,6 +13,10 @@ export class Pantsdown {
     }
 
     parse(src: string): string {
+        // re-init slugger to avoid slug count from incorrectly incrementing
+        // from previosly slugged headings
+        this.parser.renderer.slugger = new GithubSlugger();
+
         const tokens = this.lexer.lex(src);
         const html = this.parser.parse(tokens);
         return html;

package/src/parser.ts

@@ -5,7 +5,7 @@ import { type PantsdownConfig, type Token, type Tokens } from "./types.ts";
  * Parsing & Compiling
  */
 export class Parser {
-    private renderer: Renderer;
+    renderer: Renderer;
 
     constructor(config: PantsdownConfig | undefined) {
         this.renderer = new Renderer(config);
@@ -83,6 +83,7 @@ export class Parser {
                     const ordered = token.ordered;
                     const start = token.start;
                     const loose = token.loose;
+                    let containsTaskList = false;
 
                     let body = "";
                     for (let j = 0, itemsLen = token.items.length; j < itemsLen; j++) {
@@ -92,7 +93,10 @@ export class Parser {
 
                         let itemBody = "";
                         if (item.task) {
-                            const checkbox = this.renderer.checkbox(Boolean(checked));
+                            containsTaskList = true;
+                            const checkbox = this.renderer.checkbox(Boolean(checked), [
+                                "task-list-item-checkbox",
+                            ]);
                             if (loose) {
                                 if (
                                     item.tokens.length > 0 &&
@@ -121,7 +125,9 @@ export class Parser {
                         body += this.renderer.listitem(itemBody, task, Boolean(checked));
                     }
 
-                    out += this.renderer.list(body, ordered, start, token.sourceMap);
+                    const listClasses: string[] = [];
+                    if (containsTaskList) listClasses.push("contains-task-list");
+                    out += this.renderer.list(body, ordered, start, token.sourceMap, listClasses);
                     continue;
                 }
                 case "html": {

package/src/renderer.ts

@@ -1,3 +1,4 @@
+import GithubSlugger from "github-slugger";
 import hljs from "highlight.js";
 import { type PantsdownConfig, type SourceMap } from "./types.ts";
 import {
@@ -5,12 +6,14 @@ import {
     escape,
     fixHtmlLocalImageHref,
     fixLocalImageHref,
+    getHtmlElementText,
     injectHtmlAttributes,
+    renderHtmlClasses,
     renderSourceMap,
 } from "./utils.ts";
 
 const defaultConfig: NonNullable<PantsdownConfig["renderer"]> = {
-    localImageUrlPrefix: "",
+    relativeImageUrlPrefix: "",
 };
 
 /**
@@ -18,6 +21,7 @@ const defaultConfig: NonNullable<PantsdownConfig["renderer"]> = {
  */
 export class Renderer {
     private rendererConfig: NonNullable<PantsdownConfig["renderer"]>;
+    slugger = new GithubSlugger();
 
     constructor(config: PantsdownConfig | undefined) {
         const rendererConfig = Object.assign(defaultConfig, config?.renderer ?? {});
@@ -46,7 +50,7 @@ export class Renderer {
     }
 
     html(html: string, _block: boolean, sourceMap?: SourceMap | undefined): string {
-        let result = fixHtmlLocalImageHref(html, this.rendererConfig.localImageUrlPrefix);
+        let result = fixHtmlLocalImageHref(html, this.rendererConfig.relativeImageUrlPrefix);
         if (sourceMap) {
             result = injectHtmlAttributes(result, [
                 ["line-start", sourceMap[0]],
@@ -57,28 +61,53 @@ export class Renderer {
     }
 
     heading(text: string, level: number, sourceMap: SourceMap): string {
-        // ignore IDs
-        return `<h${level}${renderSourceMap(sourceMap)}>${text}</h${level}>\n`;
+        const elementText = getHtmlElementText(text);
+        const slug = this.slugger.slug(elementText);
+        let result = `<h${level}${renderSourceMap(sourceMap)} style="position: relative;">`;
+        // span with negative top to add some offset when scrolling to #slug
+        result += `<span style="position: absolute; top: -50px;" id="${slug}"></span>`;
+        result += `${text}<a class="anchor octicon-link" href="#${slug}"></a>`;
+        result += `</h${level}>\n`;
+        return result;
     }
 
     hr(sourceMap: SourceMap): string {
         return `<hr${renderSourceMap(sourceMap)}>\n`;
     }
 
-    list(body: string, ordered: boolean, start: number | "", sourceMap: SourceMap): string {
+    list(
+        body: string,
+        ordered: boolean,
+        start: number | "",
+        sourceMap: SourceMap,
+        classes: string[] = [],
+    ): string {
         const type = ordered ? "ol" : "ul";
         const startatt = ordered && start !== 1 ? ' start="' + start + '"' : "";
         return (
-            "<" + type + startatt + `${renderSourceMap(sourceMap)}>\n` + body + "</" + type + ">\n"
+            "<" +
+            type +
+            startatt +
+            `${renderSourceMap(sourceMap)}${renderHtmlClasses(classes)}>\n` +
+            body +
+            "</" +
+            type +
+            ">\n"
         );
     }
 
-    listitem(text: string, _task: boolean, _checked: boolean): string {
-        return `<li>${text}</li>\n`;
+    listitem(text: string, task: boolean, _checked: boolean): string {
+        const classes: string[] = [];
+        if (task) classes.push("task-list-item");
+        return `<li${renderHtmlClasses(classes)}>${text}</li>\n`;
     }
 
-    checkbox(checked: boolean): string {
-        return "<input " + (checked ? 'checked="" ' : "") + 'disabled="" type="checkbox">';
+    checkbox(checked: boolean, classes: string[] = []): string {
+        return (
+            "<input " +
+            (checked ? 'checked="" ' : "") +
+            `disabled="" type="checkbox"${renderHtmlClasses(classes)}>`
+        );
     }
 
     paragraph(text: string, sourceMap: SourceMap): string {
@@ -150,7 +179,7 @@ export class Renderer {
         if (cleanHref === null) {
             return text;
         }
-        href = fixLocalImageHref(cleanHref, this.rendererConfig.localImageUrlPrefix);
+        href = fixLocalImageHref(cleanHref, this.rendererConfig.relativeImageUrlPrefix);
 
         let out = `<img src="${href}" alt="${text}"`;
 

package/src/types.ts

@@ -190,9 +190,20 @@ export type Links = Record<string, { href: string; title: string }>;
 export type PantsdownConfig = {
     renderer?: {
         /**
-         * url prefix. Must start and end with "/"
-         * example: "/__localimage__/"
+         * Prefix to be added to relative image sources.
+         * Must start and end with "/"
+         *
+         * @example
+         * relativeImageUrlPrefix: "/__localimage__/"
+         *
+         * ![image](./wallpants-512.png)
+         * relative src is updated and result in:
+         * <img src="/__localimage__/wallpants-512.png" />
+         *
+         * ![image](https://avatars.githubusercontent.com/wallpants)
+         * absolute path remains unchanged:
+         * <img src="https://avatars.githubusercontent.com/wallpants" />
          */
-        localImageUrlPrefix: string;
+        relativeImageUrlPrefix: string;
     };
 };

package/src/utils.ts

@@ -33,18 +33,40 @@ export function escape(html: string, encode?: boolean) {
     return html;
 }
 
+export function renderHtmlClasses(classes: string[]) {
+    if (!classes.length) return "";
+    let result = ' class="';
+    result += classes.join(" ");
+    result += '"';
+    return result;
+}
+
+function parseHtmlElement(html: string) {
+    const parser = new DOMParser();
+    const doc = parser.parseFromString(html, "text/html");
+    // eslint-disable-next-line
+    if (!doc.body) throw Error("Invalid HTML");
+    const element = doc.body.firstChild as HTMLElement;
+    // eslint-disable-next-line
+    if (!element) throw Error("No valid element found");
+    return element;
+}
+
+export function getHtmlElementText(html: string) {
+    try {
+        const element = parseHtmlElement(html);
+        return element.textContent ?? html;
+    } catch (_) {
+        return html;
+    }
+}
+
 export function injectHtmlAttributes(
     html: string,
     attrs: [name: string, value: string | number][],
 ) {
-    const parser = new DOMParser();
     try {
-        const doc = parser.parseFromString(html, "text/html");
-        // eslint-disable-next-line
-        if (!doc.body) throw Error("Invalid HTML");
-        const element = doc.body.firstChild as HTMLElement;
-        // eslint-disable-next-line
-        if (!element) throw Error("No valid element found");
+        const element = parseHtmlElement(html);
         attrs.forEach(([name, value]) => {
             element.setAttribute(name, JSON.stringify(value));
         });
@@ -54,21 +76,21 @@ export function injectHtmlAttributes(
     }
 }
 
-export function fixHtmlLocalImageHref(html: string, localImageUrlPrefix: string): string {
+export function fixHtmlLocalImageHref(html: string, relativeImageUrlPrefix: string): string {
     return html.replace(
         /<img\s+([^>]*?)src\s*=\s*(["'])([^\2>]+?)\2([^>]*)>/gm,
         (_m, g1, _g2, g3: string, g4) => {
-            const href = fixLocalImageHref(g3, localImageUrlPrefix);
+            const href = fixLocalImageHref(g3, relativeImageUrlPrefix);
             return `<img ${g1}src="${href}"${g4}>`;
         },
     );
 }
 
-export function fixLocalImageHref(href: string, localImageUrlPrefix: string): string {
+export function fixLocalImageHref(href: string, relativeImageUrlPrefix: string): string {
     const reIsAbsolute = /^[\w+]+:\/\//;
     const dummyUrl = "http://__dummy__";
-    const dummyBaseUrl = new URL(localImageUrlPrefix, dummyUrl);
-    const dummyUrlLength = dummyUrl.length + (localImageUrlPrefix.startsWith("/") ? 0 : 1);
+    const dummyBaseUrl = new URL(relativeImageUrlPrefix, dummyUrl);
+    const dummyUrlLength = dummyUrl.length + (relativeImageUrlPrefix.startsWith("/") ? 0 : 1);
 
     if (reIsAbsolute.test(href)) {
         // the URL is absolute, do not touch it

package/LICENSE.md

@@ -1,67 +0,0 @@
-# License information
-
-## Contribution License Agreement
-
-If you contribute code to this project, you are implicitly allowing your code
-to be distributed under the MIT license. You are also implicitly verifying that
-all code is your original work.
-
-## Pantsdown
-
-Copyright (c) 2023+, Wallpants (https://github.com/wallpants/)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
-## Marked
-
-Copyright (c) 2018+, MarkedJS (https://github.com/markedjs/)
-
-Copyright (c) 2011-2018, Christopher Jeffrey (https://github.com/chjj/)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
-## Markdown
-
-Copyright © 2004, John Gruber
-http://daringfireball.net/
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
--   Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
--   Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
--   Neither the name “Markdown” nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
-This software is provided by the copyright holders and contributors “as is” and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright owner or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.