@difizen/libro-markdown 0.3.52 → 0.3.54

package/es/markdown-render.d.ts

@@ -3,6 +3,7 @@ import MarkdownIt from 'markdown-it';
 import type { MarkdownRenderOption } from './markdown-protocol.js';
 import { MarkdownParser } from './markdown-protocol.js';
 import 'katex/dist/katex.min.css';
+import 'highlight.js/styles/github.css';
 export declare class MarkdownRender implements MarkdownParser {
     protected mkt: MarkdownIt;
     slugify: (s: string) => string;

package/es/markdown-render.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"markdown-render.d.ts","sourceRoot":"","sources":["../src/markdown-render.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EAIrB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,UAAU,MAAM,aAAa,CAAC;AAKrC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,0BAA0B,CAAC;AAElC,qBACa,cAAe,YAAW,cAAc;IACnD,SAAS,CAAC,GAAG,EAAE,UAAU,CAAC;IAC1B,OAAO,wBAAW;IAClB,eAAe,UAAS;IACM,SAAS,CAAC,oBAAoB,EAAE,oBAAoB,CAAC;IAGnF,IAAI;IA4DJ,OAAO,CAAC,YAAY;IA8DpB,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,MAAM;CAKrE"}
+{"version":3,"file":"markdown-render.d.ts","sourceRoot":"","sources":["../src/markdown-render.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EAIrB,MAAM,mBAAmB,CAAC;AAG3B,OAAO,UAAU,MAAM,aAAa,CAAC;AAKrC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,0BAA0B,CAAC;AAClC,OAAO,gCAAgC,CAAC;AAExC,qBACa,cAAe,YAAW,cAAc;IACnD,SAAS,CAAC,GAAG,EAAE,UAAU,CAAC;IAC1B,OAAO,wBAAW;IAClB,eAAe,UAAS;IACM,SAAS,CAAC,oBAAoB,EAAE,oBAAoB,CAAC;IAGnF,IAAI;IAsEJ,OAAO,CAAC,YAAY;IA+DpB,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,MAAM;CAKrE"}

package/es/markdown-render.js

@@ -19,12 +19,14 @@ function _applyDecoratedDescriptor(target, property, decorators, descriptor, con
 function _initializerWarningHelper(descriptor, context) { throw new Error('Decorating class property failed. Please ensure that ' + 'transform-class-properties is enabled and runs after the decorators transform.'); }
 import { ConfigurationService, inject, postConstruct, singleton } from '@difizen/mana-app';
 import latexPlugin from '@traptitech/markdown-it-katex';
+import hljs from 'highlight.js';
 import MarkdownIt from 'markdown-it';
 import sanitizeHtml from 'sanitize-html';
 import { libroAnchor, linkInsideHeader, slugify } from "./anchor.js";
 import { LibroMarkdownConfiguration } from "./config.js";
 import { MarkdownParser } from "./markdown-protocol.js";
 import 'katex/dist/katex.min.css';
+import 'highlight.js/styles/github.css';
 export var MarkdownRender = (_dec = singleton({
   token: MarkdownParser
 }), _dec2 = inject(ConfigurationService), _dec3 = postConstruct(), _dec(_class = (_class2 = /*#__PURE__*/function () {
@@ -40,7 +42,19 @@ export var MarkdownRender = (_dec = singleton({
       var _this = this;
       this.mkt = new MarkdownIt({
         html: true,
-        linkify: true
+        linkify: true,
+        highlight: function highlight(str, lang) {
+          if (lang && hljs.getLanguage(lang)) {
+            try {
+              return hljs.highlight(str, {
+                language: lang
+              }).value;
+            } catch (__) {
+              //
+            }
+          }
+          return ''; // use external default escaping
+        }
       });
       this.mkt.linkify.set({
         fuzzyLink: false
@@ -90,16 +104,16 @@ export var MarkdownRender = (_dec = singleton({
   }, {
     key: "sanitizeHTML",
     value: function sanitizeHTML(html) {
-      var allowedTags = sanitizeHtml.defaults.allowedTags.concat(['a', 'abbr', 'acronym', 'b', 'blockquote', 'br', 'code', 'col', 'colgroup', 'dd', 'del', 'div', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 's', 'small', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'th', 'tr', 'tt', 'u', 'ul', 'kbd', 'var']);
+      var allowedTags = sanitizeHtml.defaults.allowedTags.concat(['a', 'abbr', 'acronym', 'b', 'blockquote', 'br', 'code', 'col', 'colgroup', 'dd', 'del', 'div', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 's', 'small', 'span', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'th', 'tr', 'tt', 'u', 'ul', 'kbd', 'var']);
       // 构建新的 allowedAttributes，为所有允许的标签添加 'id'
       var allowedAttributes = Object.fromEntries(allowedTags.map(function (tag) {
-        return [tag, [].concat(_toConsumableArray(sanitizeHtml.defaults.allowedAttributes[tag] || []), ['id'])];
+        return [tag, [].concat(_toConsumableArray(sanitizeHtml.defaults.allowedAttributes[tag] || []), ['id', 'class'])];
       }));
       return sanitizeHtml(html, {
         allowedTags: allowedTags,
         // 允许的标签
         allowedAttributes: _objectSpread(_objectSpread({}, allowedAttributes), {}, {
-          a: ['href', 'title', 'id'],
+          a: ['href', 'title', 'id', 'target'],
           img: ['src', 'alt', 'id']
         })
       });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@difizen/libro-markdown",
-  "version": "0.3.52",
+  "version": "0.3.54",
   "description": "",
   "keywords": [
     "libro",
@@ -37,12 +37,14 @@
     "@difizen/mana-l10n": "latest",
     "@traptitech/markdown-it-katex": "^3.6.0",
     "@types/markdown-it": "^12.2.3",
+    "highlight.js": "^11.11.1",
     "katex": "^0.16.10",
     "markdown-it": "^13.0.1",
     "markdown-it-anchor": "^8.6.5",
     "sanitize-html": "^2.14.0"
   },
   "devDependencies": {
+    "@types/highlight.js": "^10.1.0",
     "@types/sanitize-html": "^2.13.0"
   },
   "scripts": {

package/src/markdown-render.spec.ts

@@ -0,0 +1,102 @@
+import 'reflect-metadata';
+import assert from 'assert';
+
+import { MarkdownRender } from './markdown-render.js';
+
+// Declare jest globals to avoid compilation errors if types are missing
+declare const describe: any;
+declare const it: any;
+declare const beforeEach: any;
+declare const jest: any;
+
+// Mock ConfigurationService
+const mockConfigService = {
+  get: jest.fn(),
+};
+
+describe('MarkdownRender', () => {
+  let markdownRender: MarkdownRender;
+
+  beforeEach(() => {
+    // Reset mock and set default behavior
+    mockConfigService.get.mockReset();
+    mockConfigService.get.mockResolvedValue(false);
+
+    markdownRender = new MarkdownRender();
+    // Inject mock manually
+    (markdownRender as any).configurationService = mockConfigService;
+    // Manually call init to trigger postConstruct logic
+    markdownRender.init();
+  });
+
+  it('should render basic markdown', () => {
+    const md = '# Hello';
+    const html = markdownRender.render(md);
+    // h1 id="hello" comes from anchor plugin
+    assert.ok(html.includes('<h1 id="hello">Hello</h1>'));
+  });
+
+  it('should highlight code blocks', () => {
+    const md = '```javascript\nconst a = 1;\n```';
+    const html = markdownRender.render(md);
+
+    // Check for language class added by markdown-it/highlight.js
+    assert.ok(html.includes('language-javascript'));
+
+    // Check for highlight.js specific classes (indicating highlighting actually happened)
+    // "const" is a keyword
+    assert.ok(html.includes('hljs-keyword'));
+  });
+
+  it('should sanitize html', () => {
+    const md = '<script>alert(1)</script>';
+    const html = markdownRender.render(md);
+    assert.ok(!html.includes('<script>'));
+    assert.ok(!html.includes('alert(1)'));
+  });
+
+  it('should allow span tags with class attributes (needed for highlighting)', () => {
+    // Manually construct a highlighted-like span to ensure sanitizer doesn't strip it
+    // Note: markdown-it render output is sanitized.
+    // If we input raw HTML, it might be stripped depending on settings.
+    // But highlight.js output is generated internally.
+    // Let's test with a code block that generates spans.
+
+    const md = '```javascript\nconst a = 1;\n```';
+    const html = markdownRender.render(md);
+
+    // Check that span tags are preserved
+    assert.ok(html.includes('<span class="hljs-keyword">const</span>'));
+  });
+
+  it('should support target="_blank" configuration', async () => {
+    mockConfigService.get.mockResolvedValue(true);
+
+    const renderer = new MarkdownRender();
+    (renderer as any).configurationService = mockConfigService;
+    renderer.init();
+
+    // Wait for promise resolution in init (microtask)
+    // Increase wait time to ensure the promise chain in init() completes
+    await new Promise((resolve) => setTimeout(resolve, 100));
+
+    const md = '[link](http://example.com)';
+    const html = renderer.render(md);
+    assert.ok(html.includes('target="_blank"'));
+  });
+
+  it('should NOT add target="_blank" when disabled', async () => {
+    mockConfigService.get.mockResolvedValue(false);
+
+    const renderer = new MarkdownRender();
+    (renderer as any).configurationService = mockConfigService;
+    renderer.init();
+
+    // Wait for promise resolution in init
+    await new Promise((resolve) => setTimeout(resolve, 100));
+
+    const md = '[link](http://example.com)';
+    const html = renderer.render(md);
+    assert.ok(!html.includes('target="_blank"'));
+  });
+});

package/src/markdown-render.ts

@@ -5,6 +5,7 @@ import {
   singleton,
 } from '@difizen/mana-app';
 import latexPlugin from '@traptitech/markdown-it-katex';
+import hljs from 'highlight.js';
 import MarkdownIt from 'markdown-it';
 import sanitizeHtml from 'sanitize-html';
 
@@ -13,6 +14,7 @@ import { LibroMarkdownConfiguration } from './config.js';
 import type { MarkdownRenderOption } from './markdown-protocol.js';
 import { MarkdownParser } from './markdown-protocol.js';
 import 'katex/dist/katex.min.css';
+import 'highlight.js/styles/github.css';
 
 @singleton({ token: MarkdownParser })
 export class MarkdownRender implements MarkdownParser {
@@ -26,6 +28,16 @@ export class MarkdownRender implements MarkdownParser {
     this.mkt = new MarkdownIt({
       html: true,
       linkify: true,
+      highlight: function (str, lang) {
+        if (lang && hljs.getLanguage(lang)) {
+          try {
+            return hljs.highlight(str, { language: lang }).value;
+          } catch (__) {
+            //
+          }
+        }
+        return ''; // use external default escaping
+      },
     });
     this.mkt.linkify.set({ fuzzyLink: false });
     this.mkt.use(libroAnchor, {
@@ -113,6 +125,7 @@ export class MarkdownRender implements MarkdownParser {
       'q',
       's',
       'small',
+      'span',
       'strong',
       'sub',
       'sup',
@@ -131,14 +144,14 @@ export class MarkdownRender implements MarkdownParser {
     const allowedAttributes = Object.fromEntries(
       allowedTags.map((tag) => [
         tag,
-        [...(sanitizeHtml.defaults.allowedAttributes[tag] || []), 'id'],
+        [...(sanitizeHtml.defaults.allowedAttributes[tag] || []), 'id', 'class'],
       ]),
     );
     return sanitizeHtml(html, {
       allowedTags, // 允许的标签
       allowedAttributes: {
         ...allowedAttributes,
-        a: ['href', 'title', 'id'],
+        a: ['href', 'title', 'id', 'target'],
         img: ['src', 'alt', 'id'],
       },
     });