feat: #724 增加流式会话场景的适配

Tencent · Mar 2, 2024 · ac98580 · ac98580
1 parent 340bf41
commit ac98580
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 2 deletions.
diff --git a/src/Cherry.config.js b/src/Cherry.config.js
@@ -112,6 +112,14 @@ const defaultConfig = {
        *    - 一般编辑权限可控的场景（如api文档系统）可以允许iframe、script等标签
        */
       htmlWhiteList: '',
+      /**
+       * 适配流式会话的场景，开启后将具备以下特性：
+       * 1. 代码块自动闭合，相当于强制 `engine.syntax.codeBlock.selfClosing=true`
+       * 2. 文章末尾的段横线标题语法（`\n-`）失效
+       *
+       * 后续如果有新的需求，可提issue反馈
+       */
+      flowSessionContext: true,
     },
     // 内置语法配置
     syntax: {

diff --git a/src/Engine.js b/src/Engine.js
@@ -50,7 +50,8 @@ export default class Engine {
     this.md5StrMap = {};
     this.markdownParams = markdownParams;
     this.currentStrMd5 = [];
-    this.htmlWhiteListAppend = markdownParams.engine.global.htmlWhiteList;
+    this.globalConfig = markdownParams.engine.global;
+    this.htmlWhiteListAppend = this.globalConfig.htmlWhiteList;
   }
 
   initMath(opts) {

diff --git a/src/core/hooks/CodeBlock.js b/src/core/hooks/CodeBlock.js
@@ -298,7 +298,7 @@ export default class CodeBlock extends ParagraphBase {
   beforeMakeHtml(str, sentenceMakeFunc, markdownParams) {
     let $str = str;
 
-    if (this.selfClosing) {
+    if (this.selfClosing || this.$engine.globalConfig.flowSessionContext) {
       $str = this.$dealUnclosingCode($str);
     }
 

diff --git a/src/core/hooks/Header.js b/src/core/hooks/Header.js
@@ -132,6 +132,10 @@ export default class Header extends ParagraphBase {
 
   beforeMakeHtml(str) {
     let $str = str;
+    if (this.$engine.globalConfig.flowSessionContext) {
+      // 适配流式会话的场景，文章末尾的段横线标题语法（`\n-`）失效
+      $str = $str.replace(/(\n\s*-{1,})\s*$/, '$1 ');
+    }
     // atx 优先
     if (this.test($str, ATX_HEADER)) {
       $str = $str.replace(this.RULE[ATX_HEADER].reg, (match, lines, level, text) => {

diff --git a/types/cherry.d.ts b/types/cherry.d.ts
@@ -107,6 +107,14 @@ export interface CherryEngineOptions {
      *    - 一般编辑权限可控的场景（如api文档系统）可以允许iframe、script等标签
      */
     htmlWhiteList?: string;
+    /**
+       * 适配流式会话的场景，开启后将具备以下特性：
+       * 1. 代码块自动闭合，相当于强制 `engine.syntax.codeBlock.selfClosing=true`
+       * 2. 文章末尾的段横线标题语法（`\n-`）失效
+       *
+       * 后续如果有新的需求，可提issue反馈
+       */
+    flowSessionContext?: boolean;
   };
   /** 内置语法配置 */
   syntax?: Record<string, Record<string, any> | false>;