@scalar/code-highlight 0.3.2 → 0.3.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scalar/code-highlight
 
+## 0.3.4
+
+### Patch Changes
+
+- [#8964](https://github.com/scalar/scalar/pull/8964): fix markdown inside HTML text tags like `<p>` so inline formatting is rendered.
+
+## 0.3.3
+
+### Patch Changes
+
+- [#8735](https://github.com/scalar/scalar/pull/8735): fix: replace direct cjs mime and curl dependencies with local implementations
+
 ## 0.3.2
 
 ### Patch Changes

package/dist/languages/curl.d.ts

@@ -0,0 +1,7 @@
+import type { LanguageFn } from 'highlight.js';
+/**
+ * cURL grammar adapted from highlightjs-curl to avoid a CJS dependency.
+ */
+declare const curlLanguage: LanguageFn;
+export default curlLanguage;
+//# sourceMappingURL=curl.d.ts.map

package/dist/languages/curl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"curl.d.ts","sourceRoot":"","sources":["../../src/languages/curl.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAE9C;;GAEG;AACH,QAAA,MAAM,YAAY,EAAE,UAyFnB,CAAA;AAED,eAAe,YAAY,CAAA"}

package/dist/languages/curl.js

@@ -0,0 +1,86 @@
+/**
+ * cURL grammar adapted from highlightjs-curl to avoid a CJS dependency.
+ */
+const curlLanguage = (hljs) => {
+    const quoteString = {
+        className: 'string',
+        begin: /"/,
+        end: /"/,
+        contains: [
+            hljs.BACKSLASH_ESCAPE,
+            {
+                className: 'variable',
+                begin: /\$\(/,
+                end: /\)/,
+                contains: [hljs.BACKSLASH_ESCAPE],
+            },
+        ],
+        relevance: 0,
+    };
+    const optionRequest = {
+        className: 'literal',
+        begin: /(--request|-X)\s/,
+        contains: [
+            {
+                className: 'symbol',
+                begin: /(get|post|delete|options|head|put|patch|trace|connect)/,
+                end: /\s/,
+                returnEnd: true,
+            },
+        ],
+        returnEnd: true,
+        relevance: 10,
+    };
+    const option = {
+        className: 'literal',
+        begin: /--/,
+        end: /[\s"]/,
+        returnEnd: true,
+        relevance: 0,
+    };
+    const optionSingle = {
+        className: 'literal',
+        begin: /-\w/,
+        end: /[\s"]/,
+        returnEnd: true,
+        relevance: 0,
+    };
+    const escapedQuote = {
+        className: 'string',
+        begin: /\\"/,
+        relevance: 0,
+    };
+    const aposString = {
+        className: 'string',
+        begin: /'/,
+        end: /'/,
+        relevance: 0,
+    };
+    const number = {
+        className: 'number',
+        variants: [{ begin: hljs.C_NUMBER_RE }],
+        relevance: 0,
+    };
+    const pathMode = {
+        match: /(\/[a-z._-]+)+/,
+    };
+    return {
+        name: 'curl',
+        aliases: ['curl'],
+        keywords: 'curl',
+        case_insensitive: true,
+        contains: [
+            optionRequest,
+            option,
+            optionSingle,
+            quoteString,
+            escapedQuote,
+            aposString,
+            hljs.APOS_STRING_MODE,
+            hljs.QUOTE_STRING_MODE,
+            number,
+            pathMode,
+        ],
+    };
+};
+export default curlLanguage;

package/dist/languages/standard.d.ts

@@ -24,7 +24,7 @@ export declare const standardLanguages: {
     readonly cpp: LanguageFn;
     readonly csharp: LanguageFn;
     readonly css: LanguageFn;
-    readonly curl: any;
+    readonly curl: LanguageFn;
     readonly dart: LanguageFn;
     readonly diff: LanguageFn;
     readonly docker: LanguageFn;

package/dist/languages/standard.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"standard.d.ts","sourceRoot":"","sources":["../../src/languages/standard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAiD9C;;;;;;;;;;;;;;GAcG;AAEH;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkDiB,CAAA"}
+{"version":3,"file":"standard.d.ts","sourceRoot":"","sources":["../../src/languages/standard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAgD9C;;;;;;;;;;;;;;GAcG;AAEH;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkDiB,CAAA"}

package/dist/languages/standard.js

@@ -43,8 +43,7 @@ import swift from 'highlight.js/lib/languages/swift';
 import typescript from 'highlight.js/lib/languages/typescript';
 import xml from 'highlight.js/lib/languages/xml';
 import yaml from 'highlight.js/lib/languages/yaml';
-// @ts-expect-error No types available
-import curl from 'highlightjs-curl';
+import curl from './curl.js';
 /**
  * We group languages into three categories based on their popularity and usage.
  * This helps in optimizing the bundle size by allowing users to include only

package/dist/markdown/markdown.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../src/markdown/markdown.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,eAAe,EAAqB,MAAM,OAAO,CAAA;AAsB9E,YAAY,EAAE,IAAI,EAAE,MAAM,OAAO,CAAA;AAEjC;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,IAAI,KAAG,IAAI,IAAI,OAE9C,CAAA;AAqBD;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;IACR,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAA;IAChC,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,UAuDF;AASD;;GAEG;AACH,wBAAgB,WAAW,CACzB,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,MAAU,GAChB;IACD,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd,EAAE,CAiBF;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,eAAe,GAAG,MAAM,CAUpE;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,YAgC5C"}
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../src/markdown/markdown.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAsD,IAAI,EAAE,eAAe,EAAE,MAAM,OAAO,CAAA;AAuB/G,YAAY,EAAE,IAAI,EAAE,MAAM,OAAO,CAAA;AAEjC;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,IAAI,KAAG,IAAI,IAAI,OAE9C,CAAA;AAiGD;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;IACR,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAA;IAChC,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,UAyDF;AASD;;GAEG;AACH,wBAAgB,WAAW,CACzB,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,MAAU,GAChB;IACD,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd,EAAE,CAiBF;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,eAAe,GAAG,MAAM,CAUpE;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,YAgC5C"}

package/dist/markdown/markdown.js

@@ -1,5 +1,6 @@
 import rehypeExternalLinks from 'rehype-external-links';
 import rehypeFormat from 'rehype-format';
+import rehypeParse from 'rehype-parse';
 import rehypeRaw from 'rehype-raw';
 import rehypeSanitize, { defaultSchema } from 'rehype-sanitize';
 import rehypeStringify from 'rehype-stringify';
@@ -31,6 +32,69 @@ const transformNodes = (options, ..._ignored) => (tree) => {
     });
     return;
 };
+const TAGS_WITH_INLINE_MARKDOWN = new Set(['dd', 'dt', 'li', 'p', 'summary', 'td', 'th']);
+const MAY_CONTAIN_INLINE_MARKDOWN = /[`*_\[~]/;
+/**
+ * Preserve HTML-like text in inline markdown by turning mdast `html` nodes into text nodes.
+ */
+const preserveHtmlLikeText = () => (tree) => {
+    visit(tree, 'html', (node, index, parent) => {
+        if (typeof index !== 'number' || !parent || !('children' in parent) || !Array.isArray(parent.children)) {
+            return;
+        }
+        parent.children[index] = {
+            type: 'text',
+            value: node.value ?? '',
+        };
+    });
+};
+const inlineMarkdownProcessor = unified().use(remarkParse).use(remarkGfm).use(preserveHtmlLikeText).use(remarkRehype);
+const htmlFragmentParser = unified().use(rehypeParse, { fragment: true });
+const htmlFragmentStringifier = unified().use(rehypeStringify);
+/**
+ * Parse inline markdown and return children from the generated paragraph.
+ */
+const extractInlineChildrenFromMarkdown = (value) => {
+    const tree = inlineMarkdownProcessor.runSync(inlineMarkdownProcessor.parse(value));
+    if (tree.children.length !== 1) {
+        return [];
+    }
+    const paragraph = tree.children.at(0);
+    if (!paragraph || paragraph.type !== 'element' || paragraph.tagName !== 'p') {
+        return [];
+    }
+    return paragraph.children;
+};
+/**
+ * Re-parses text nodes in selected HTML tags so inline markdown works in tags like <p>.
+ */
+const transformInlineMarkdownInHtml = () => (tree) => {
+    visit(tree, 'element', (node) => {
+        if (!TAGS_WITH_INLINE_MARKDOWN.has(node.tagName)) {
+            return;
+        }
+        node.children = node.children.flatMap((child) => {
+            if (child.type !== 'text' || !MAY_CONTAIN_INLINE_MARKDOWN.test(child.value)) {
+                return [child];
+            }
+            const markdownChildren = extractInlineChildrenFromMarkdown(child.value);
+            return markdownChildren.length ? markdownChildren : [child];
+        });
+    });
+};
+/**
+ * Rewrites raw HTML strings so inline markdown parsing is only applied to raw HTML input.
+ */
+const transformInlineMarkdownInRawHtml = () => (tree) => {
+    visit(tree, 'raw', (node) => {
+        if (typeof node.value !== 'string' || !MAY_CONTAIN_INLINE_MARKDOWN.test(node.value)) {
+            return;
+        }
+        const htmlFragmentTree = htmlFragmentParser.parse(node.value);
+        transformInlineMarkdownInHtml()(htmlFragmentTree);
+        node.value = htmlFragmentStringifier.stringify(htmlFragmentTree);
+    });
+};
 /**
  * Take a Markdown string and generate HTML from it
  */
@@ -51,7 +115,9 @@ export function htmlFromMarkdown(markdown, options) {
         .use(remarkRehype, { allowDangerousHtml: true })
         // Adds GitHub alerts
         .use(rehypeAlert)
-        // Creates a HTML AST
+        // Parse inline markdown only inside raw HTML fragments, not normal markdown output
+        .use(transformInlineMarkdownInRawHtml)
+        // Creates an HTML AST
         .use(rehypeRaw)
         // Removes disallowed tags
         .use(rehypeSanitize, {

package/package.json

@@ -16,7 +16,7 @@
     "lowlight",
     "highlightjs"
   ],
-  "version": "0.3.2",
+  "version": "0.3.4",
   "engines": {
     "node": ">=22"
   },
@@ -73,7 +73,6 @@
   "dependencies": {
     "hast-util-to-text": "^4.0.2",
     "highlight.js": "^11.11.1",
-    "highlightjs-curl": "^1.3.0",
     "lowlight": "^3.3.0",
     "rehype-external-links": "^3.0.0",
     "rehype-format": "^5.0.1",
@@ -93,12 +92,12 @@
     "@types/mdast": "^4.0.4",
     "vfile": "^6.0.3",
     "vite": "8.0.0",
-    "@scalar/themes": "0.15.2"
+    "@scalar/themes": "0.15.3"
   },
   "scripts": {
-    "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json && cp -r src/css dist/css",
+    "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json && shx cp -r src/css dist/css",
     "dev": "vite",
-    "test": "vitest",
+    "test": "vitest --run",
     "types:check": "tsc --noEmit"
   }
 }