@cherry-markdown/cherry-markdown-dev 0.8.58-dev

package/src/Engine.js

@@ -0,0 +1,381 @@
+/**
+ * Copyright (C) 2021 THL A29 Limited, a Tencent company.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import HookCenter from './core/HookCenter';
+import hooksConfig from './core/HooksConfig';
+import NestedError, { $expectTarget, $expectInherit, $expectInstance } from './utils/error';
+import CryptoJS from 'crypto-js';
+import SyntaxBase from './core/SyntaxBase';
+import ParagraphBase from './core/ParagraphBase';
+import { PUNCTUATION, longTextReg, imgBase64Reg, imgDrawioXmlReg } from './utils/regexp';
+import { escapeHTMLSpecialChar } from './utils/sanitize';
+import Logger from './Logger';
+import { configureMathJax } from './utils/mathjax';
+import UrlCache from './UrlCache';
+import htmlParser from './utils/htmlparser';
+import { isBrowser } from './utils/env';
+
+export default class Engine {
+  /**
+   *
+   * @param {Partial<import('./Cherry').CherryOptions>} markdownParams 初始化Cherry时传入的选项
+   * @param {import('./Cherry').default} cherry Cherry实例
+   */
+  constructor(markdownParams, cherry) {
+    this.$cherry = cherry;
+    // Deprecated
+    Object.defineProperty(this, '_cherry', {
+      get() {
+        Logger.warn('`_engine._cherry` is deprecated. Use `$engine.$cherry` instead.');
+        return this.$cherry;
+      },
+    });
+    this.initMath(markdownParams);
+    this.$configInit(markdownParams);
+    this.hookCenter = new HookCenter(hooksConfig, markdownParams, cherry);
+    this.hooks = this.hookCenter.getHookList();
+    this.hashCache = {};
+    this.hashStrMap = {};
+    this.cachedBigData = {};
+    this.markdownParams = markdownParams;
+    this.currentStrMd5 = [];
+    this.globalConfig = markdownParams.engine.global;
+    this.htmlWhiteListAppend = this.globalConfig.htmlWhiteList;
+    this.urlProcessorMap = {};
+  }
+
+  /**
+   * 重新生成html
+   * 这是为urlProcessor支持异步回调函数而实现的重新生成html的方法
+   * 该方法会清空所有缓存，所以降低了该方法的执行频率，1s内最多执行一次
+   */
+  reMakeHtml() {
+    if (this.timer) {
+      clearTimeout(this.timer);
+      this.timer = null;
+    }
+    this.timer = setTimeout(() => {
+      this.$cherry.lastMarkdownText = '';
+      this.hashCache = {};
+      const markdownText = this.$cherry.editor.editor.getValue();
+      const html = this.makeHtml(markdownText);
+      this.$cherry.previewer.refresh(html);
+      this.$cherry.$event.emit('afterChange', {
+        markdownText,
+        html,
+      });
+    }, 1000);
+  }
+
+  urlProcessor(url, srcType) {
+    const key = `${srcType}_${url}`;
+    if (this.urlProcessorMap[key]) {
+      return this.urlProcessorMap[key];
+    }
+    const ret = this.$cherry.options.callback.urlProcessor(url, srcType, (/** @type {string} */ newUrl) => {
+      if (newUrl) {
+        if (!this.urlProcessorMap[key]) {
+          this.urlProcessorMap[key] = newUrl;
+          this.reMakeHtml();
+        }
+      } else {
+        delete this.urlProcessorMap[key];
+      }
+      return;
+    });
+    if (ret) {
+      return ret;
+    }
+    return url;
+  }
+
+  initMath(opts) {
+    // 无论MathJax还是Katex，都可以先进行MathJax配置
+    const { externals, engine } = opts;
+    const { syntax } = engine;
+    const { plugins } = syntax.mathBlock;
+    // 未开启公式
+    if (
+      !isBrowser() ||
+      (!syntax.mathBlock.src && !syntax.inlineMath.src && !syntax.mathBlock.engine && !syntax.inlineMath.engine)
+    ) {
+      return;
+    }
+    // 已经加载过MathJax
+    if (externals.MathJax || window.MathJax) {
+      return;
+    }
+    configureMathJax(plugins);
+    // 等待MathJax各种插件加载
+    const script = document.createElement('script');
+    script.src = syntax.mathBlock.src ? syntax.mathBlock.src : syntax.inlineMath.src;
+    script.async = true;
+    if (script.src) document.head.appendChild(script);
+  }
+
+  $configInit(params) {
+    if (params.hooksConfig && $expectTarget(params.hooksConfig.hooksList, Array)) {
+      for (let key = 0; key < params.hooksConfig.hooksList.length; key++) {
+        const hook = params.hooksConfig.hooksList[key];
+        try {
+          if (hook.getType() === 'sentence') {
+            $expectInherit(hook, SyntaxBase);
+          }
+
+          if (hook.getType() === 'paragraph') {
+            $expectInherit(hook, ParagraphBase);
+          }
+          $expectInstance(hook);
+          hooksConfig.push(hook);
+        } catch (e) {
+          throw new Error('the hook does not correctly inherit');
+        }
+      }
+    }
+  }
+
+  $beforeMakeHtml(str) {
+    let $str = str.replace(/~/g, '~T');
+    $str = $str.replace(/\$/g, '~D');
+    $str = $str.replace(/\r\n/g, '\n'); // DOS to Unix
+    $str = $str.replace(/\r/g, '\n'); // Mac to Unix
+    if (
+      // @ts-ignore
+      this.$cherry.options.engine.syntax.fontEmphasis.selfClosing ||
+      this.$cherry.options.engine.global.flowSessionContext
+    ) {
+      // 自动补全最后一行的加粗、斜体语法
+      if (/(^|\n)[^\n]*\*{1,3}[^\n]+$/.test($str) && $str.match(/(^|\n)([^\n]+)$/)) {
+        const lastLineStr = $str.match(/(^|\n)([^\n]+)$/)[2].split(/(\*{1,3})/g);
+        const emphasis = [];
+        for (let i = 0; i < lastLineStr.length; i++) {
+          if (/\*{1,3}/.test(lastLineStr[i])) {
+            const current = lastLineStr[i];
+            if (emphasis.length <= 0) {
+              emphasis.push(current);
+            } else {
+              if (emphasis[emphasis.length - 1] === current) {
+                emphasis.pop();
+              } else {
+                emphasis.push(current);
+              }
+            }
+          }
+        }
+        if (emphasis.length === 1) {
+          $str = $str.replace(/(\*{1,3})(\s*)([^*\n]+?)$/, '$1$2$3$2$1');
+        }
+        if (emphasis.length === 2) {
+          $str = $str.replace(/(\*{1,3})(\s*)([^*\n]+?)\*{0,2}$/, '$1$2$3$2$1');
+        }
+      }
+    }
+    // 避免正则性能问题，如/.+\n/.test(' '.repeat(99999)), 回溯次数过多
+    // 参考文章：http://www.alloyteam.com/2019/07/13574/
+    if ($str[$str.length - 1] !== '\n') {
+      $str += '\n';
+    }
+    $str = this.$fireHookAction($str, 'sentence', 'beforeMakeHtml');
+    $str = this.$fireHookAction($str, 'paragraph', 'beforeMakeHtml');
+    return $str;
+  }
+
+  $afterMakeHtml(str) {
+    let $str = this.$fireHookAction(str, 'paragraph', 'afterMakeHtml');
+    // str = this._fireHookAction(str, 'sentence', 'afterMakeHtml');
+    $str = $str.replace(/~D/g, '$');
+    $str = $str.replace(/~T/g, '~');
+    $str = $str.replace(/\\<\//g, '\\ </');
+    $str = $str
+      .replace(new RegExp(`\\\\(${PUNCTUATION})`, 'g'), (match, escapeChar) => {
+        if (escapeChar === '&') {
+          // & 字符需要特殊处理
+          return match;
+        }
+        return escapeHTMLSpecialChar(escapeChar);
+      })
+      .replace(/\\&(?!(amp|lt|gt|quot|apos);)/, () => '&amp;');
+    $str = $str.replace(/\\ <\//g, '\\</');
+    $str = $str.replace(/id="safe_(?=.*?")/g, 'id="'); // transform header id to avoid being sanitized
+    $str = UrlCache.restoreAll($str);
+    return $str;
+  }
+
+  $dealSentenceByCache(md) {
+    return this.$checkCache(md, (str) => this.$dealSentence(str));
+  }
+
+  $dealSentence(md) {
+    return this.$fireHookAction(md, 'sentence', 'makeHtml', this.$dealSentenceByCache.bind(this));
+  }
+
+  $fireHookAction(md, type, action, actionArgs) {
+    let $md = md;
+    const method = action === 'afterMakeHtml' ? 'reduceRight' : 'reduce';
+    if (!this.hooks && !this.hooks[type] && !this.hooks[type][method]) {
+      return $md;
+    }
+    try {
+      $md = this.hooks[type][method]((newMd, oneHook) => {
+        if (!oneHook.$engine) {
+          oneHook.$engine = this;
+          // Deprecated
+          Object.defineProperty(oneHook, '_engine', {
+            get() {
+              Logger.warn('`this._engine` is deprecated. Use `this.$engine` instead.');
+              return this.$engine;
+            },
+          });
+        }
+
+        if (!oneHook[action]) {
+          return newMd;
+        }
+        return oneHook[action](newMd, actionArgs, this.markdownParams);
+      }, $md);
+    } catch (e) {
+      throw new NestedError(e);
+    }
+    return $md;
+  }
+
+  /**
+   * @deprecated 已废弃，推荐使用 .hash()
+   */
+  md5(str) {
+    return this.hash(str);
+  }
+
+  /**
+   * 计算哈希值
+   * @param {String} str 被计算的字符串
+   * @returns {String} 哈希值
+   */
+  hash(str) {
+    if (!this.hashStrMap[str]) {
+      this.hashStrMap[str] = CryptoJS.SHA256(str).toString();
+    }
+    return this.hashStrMap[str];
+  }
+
+  $checkCache(str, func) {
+    const sign = this.hash(str);
+    if (typeof this.hashCache[sign] === 'undefined') {
+      this.hashCache[sign] = func(str);
+      if (BUILD_ENV !== 'production') {
+        // 生产环境屏蔽
+        Logger.log('markdown引擎渲染了：', str);
+      }
+    }
+    return { sign, html: this.hashCache[sign] };
+  }
+
+  $dealParagraph(md) {
+    return this.$fireHookAction(md, 'paragraph', 'makeHtml', this.$dealSentenceByCache.bind(this));
+  }
+
+  // 缓存大文本数据，用以提升渲染性能
+  $cacheBigData(md) {
+    let $md = md.replace(imgBase64Reg, (whole, m1, m2) => {
+      const cacheKey = `bigDataBegin${this.hash(m2)}bigDataEnd`;
+      this.cachedBigData[cacheKey] = m2;
+      return `${m1}${cacheKey})`;
+    });
+    $md = $md.replace(imgDrawioXmlReg, (whole, m1, m2) => {
+      const cacheKey = `bigDataBegin${this.hash(m2)}bigDataEnd`;
+      this.cachedBigData[cacheKey] = m2;
+      return `${m1}${cacheKey}}`;
+    });
+    $md = $md.replace(longTextReg, (whole, m1, m2) => {
+      const cacheKey = `bigDataBegin${this.hash(m2)}bigDataEnd`;
+      this.cachedBigData[cacheKey] = m2;
+      return `${m1}${cacheKey}}`;
+    });
+    return $md;
+  }
+
+  $deCacheBigData(md) {
+    return md.replace(/bigDataBegin[^\n]+?bigDataEnd/g, (whole) => {
+      return this.cachedBigData[whole];
+    });
+  }
+
+  /**
+   * 流式输出场景时，在最后增加一个光标占位
+   * @param {string} md 内容
+   * @returns {string}
+   */
+  $setFlowSessionCursorCache(md) {
+    if (this.$cherry.options.engine.global.flowSessionContext && this.$cherry.options.engine.global.flowSessionCursor) {
+      return `${md}CHERRY_FLOW_SESSION_CURSOR`;
+    }
+    return md;
+  }
+
+  /**
+   * 流式输出场景时，把最后的光标占位替换为配置的dom元素，并在一段时间后删除该元素
+   * @param {string} md 内容
+   * @returns {string}
+   */
+  $clearFlowSessionCursorCache(md) {
+    if (this.$cherry.options.engine.global.flowSessionCursor) {
+      if (this.clearCursorTimer) {
+        clearTimeout(this.clearCursorTimer);
+      }
+      this.clearCursorTimer = setTimeout(() => {
+        this.$cherry.clearFlowSessionCursor();
+      }, 2560);
+      return md.replace(/CHERRY_FLOW_SESSION_CURSOR/g, this.$cherry.options.engine.global.flowSessionCursor);
+    }
+    return md;
+  }
+
+  /**
+   * @param {string} md md字符串
+   * @returns {string} 获取html
+   */
+  makeHtml(md) {
+    let $md = this.$setFlowSessionCursorCache(md);
+    $md = this.$cacheBigData($md);
+    $md = this.$beforeMakeHtml($md);
+    $md = this.$dealParagraph($md);
+    $md = this.$afterMakeHtml($md);
+    this.$fireHookAction($md, 'paragraph', '$cleanCache');
+    $md = this.$deCacheBigData($md);
+    $md = this.$clearFlowSessionCursorCache($md);
+    return $md;
+  }
+
+  makeHtmlForBlockquote(md) {
+    let $md = md;
+    $md = this.$dealParagraph($md);
+    $md = this.$fireHookAction($md, 'paragraph', 'afterMakeHtml');
+    return $md;
+  }
+
+  mounted() {
+    this.$fireHookAction('', 'sentence', 'mounted');
+    this.$fireHookAction('', 'paragraph', 'mounted');
+    // UrlCache.clear();
+  }
+
+  /**
+   * @param {string} html html字符串
+   * @returns {string} 获取markdown
+   */
+  makeMarkdown(html) {
+    return htmlParser.run(html);
+  }
+}

package/src/Event.js

@@ -0,0 +1,140 @@
+/**
+ * Copyright (C) 2021 THL A29 Limited, a Tencent company.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import mitt from 'mitt';
+
+/**
+ * 事件管理
+ */
+export default class Event {
+  constructor(instanceId) {
+    this.instanceId = instanceId;
+  }
+  /**
+   * 事件列表
+   * @property
+   */
+  Events = {
+    previewerClose: 'previewerClose',
+    previewerOpen: 'previewerOpen',
+    editorClose: 'editorClose',
+    editorOpen: 'editorOpen',
+    toolbarHide: 'toolbarHide',
+    toolbarShow: 'toolbarShow',
+    cleanAllSubMenus: 'cleanAllSubMenus', // 清除所有子菜单弹窗
+    afterChange: 'afterChange', // 编辑器内容变化
+    afterInit: 'afterInit', // 编辑器初始化完成
+    focus: 'focus', // 焦点
+    blur: 'blur', // 失焦
+    selectionChange: 'selectionChange', // 选区内容改变时触发
+    afterChangeLocale: 'afterChangeLocale', // 语言改变
+    changeMainTheme: 'changeMainTheme', // 变更主题
+    changeCodeBlockTheme: 'changeCodeBlockTheme', // 变更代码块主题
+  };
+
+  /**
+   * @property
+   * @private
+   * @type {import('mitt').Emitter}
+   */
+  emitter = mitt();
+
+  setInstanceId(instanceId) {
+    this.instanceId = instanceId;
+  }
+
+  getInstanceId() {
+    return this.instanceId;
+  }
+
+  clearAll() {
+    this.emitter.all.clear();
+  }
+
+  bindCallbacksByOptions(options) {
+    if (options.callback.afterChange) {
+      this.on(this.Events.afterChange, (msg) => {
+        options.callback.afterChange(msg.markdownText, msg.html);
+      });
+    }
+    if (options.callback.afterInit) {
+      this.on(this.Events.afterInit, (msg) => {
+        options.callback.afterInit(msg.markdownText, msg.html);
+      });
+    }
+    if (options.event.afterChange) {
+      this.on(this.Events.afterChange, (msg) => {
+        options.event.afterChange(msg.markdownText, msg.html);
+      });
+    }
+    if (options.event.afterInit) {
+      this.on(this.Events.afterInit, (msg) => {
+        options.event.afterInit(msg.markdownText, msg.html);
+      });
+    }
+    if (options.event.focus) {
+      this.on(this.Events.focus, (event) => {
+        options.event.focus(event);
+      });
+    }
+    if (options.event.blur) {
+      this.on(this.Events.blur, (event) => {
+        options.event.blur(event);
+      });
+    }
+    if (options.event.selectionChange) {
+      this.on(this.Events.selectionChange, (event) => {
+        options.event.selectionChange(event);
+      });
+    }
+    if (options.event.afterChangeLocale) {
+      this.on(this.Events.afterChangeLocale, (locale) => {
+        options.event.afterChangeLocale(locale);
+      });
+    }
+    if (options.event.changeMainTheme) {
+      this.on(this.Events.changeMainTheme, (theme) => {
+        options.event.changeMainTheme(theme);
+      });
+    }
+    if (options.event.changeCodeBlockTheme) {
+      this.on(this.Events.changeCodeBlockTheme, (theme) => {
+        options.event.changeCodeBlockTheme(theme);
+      });
+    }
+  }
+
+  /**
+   * 注册监听事件
+   * @param {string} event 要注册监听的事件
+   * @param {(event: any) => void} handler 事件回调
+   */
+  on(event, handler) {
+    this.emitter.on(`${this.instanceId}:${event}`, handler);
+  }
+
+  off(event, handler) {
+    this.emitter.off(`${this.instanceId}:${event}`, handler);
+  }
+
+  /**
+   * 触发事件
+   * @param {string} event 要触发的事件
+   * @param {object} msg 消息体
+   */
+  emit(event, msg) {
+    this.emitter.emit(`${this.instanceId}:${event}`, msg);
+  }
+}

package/src/Factory.js

@@ -0,0 +1,180 @@
+/**
+ * Copyright (C) 2021 THL A29 Limited, a Tencent company.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import SyntaxBase, { HOOKS_TYPE_LIST } from './core/SyntaxBase';
+import ParagraphBase from './core/ParagraphBase';
+import MenuBase from './toolbars/MenuBase';
+
+/**
+ * 属性类型匹配
+ * @param {object} obj 待匹配的对象
+ * @param {string} key 待匹配的属性名
+ * @param {any} type 匹配的类型
+ */
+function matchPropTypes(obj, key, type) {
+  if (typeof obj !== 'object' || !obj) {
+    throw TypeError(`first argument must be a object, but get ${typeof obj}`);
+  }
+  // 不用检测，会存在 undefined 的情况
+  // if (!Object.keys(obj).includes(key))
+  // 递归
+  if (
+    !Array.isArray(type) &&
+    typeof type === 'object' &&
+    type !== null &&
+    typeof obj[key] === 'object' &&
+    obj[key] !== null
+  ) {
+    // 递归时，取对象里每个属性进行匹配，必须全部匹配才返回true
+    return Object.keys(obj[key]).every((objKey) => matchPropTypes(obj[key], objKey, type[objKey]));
+  }
+  if (typeof type === 'string' && typeof obj[key] === type) {
+    return true;
+  }
+  if (typeof type === 'function' && obj[key] instanceof type) {
+    return true;
+  }
+  // 联合类型
+  if (Array.isArray(type)) {
+    return type.some((type) => matchPropTypes(obj, key, type));
+  }
+  return false;
+}
+
+function filterOptions(options, whiteList, propTypes) {
+  const filteredOptions = {};
+  Object.keys(options).forEach((key) => {
+    if (whiteList.indexOf(key) === -1) {
+      return;
+    }
+    if (typeof propTypes === 'object') {
+      if (matchPropTypes(options, key, propTypes[key])) {
+        filteredOptions[key] = options[key];
+      }
+    } else if (typeof propTypes === 'string') {
+      if (typeof options[key] === propTypes) {
+        filteredOptions[key] = options[key];
+      }
+    }
+  });
+  return filteredOptions;
+}
+
+export function createSyntaxHook(name, type, options) {
+  const BaseClass = type === HOOKS_TYPE_LIST.PAR ? ParagraphBase : SyntaxBase;
+  const optionsWhiteList = ['beforeMakeHtml', 'makeHtml', 'afterMakeHtml', 'rule', 'test'];
+  const filteredOptions = filterOptions(options, optionsWhiteList, 'function');
+  const paragraphConfig = { needCache: options.needCache, defaultCache: options.defaultCache };
+  return class CustomSyntax extends BaseClass {
+    static HOOK_NAME = name;
+
+    constructor(editorConfig = {}) {
+      if (type === HOOKS_TYPE_LIST.PAR) {
+        super({ needCache: !!paragraphConfig.needCache, defaultCache: paragraphConfig.defaultCache });
+      } else {
+        super();
+      }
+
+      this.config = editorConfig.config;
+    }
+
+    beforeMakeHtml(...args) {
+      if (filteredOptions.beforeMakeHtml) {
+        return filteredOptions.beforeMakeHtml.apply(this, args);
+      }
+      return super.beforeMakeHtml(...args);
+    }
+
+    makeHtml(...args) {
+      if (filteredOptions.makeHtml) {
+        return filteredOptions.makeHtml.apply(this, args);
+      }
+      return super.makeHtml(...args);
+    }
+
+    afterMakeHtml(...args) {
+      if (filteredOptions.afterMakeHtml) {
+        return filteredOptions.afterMakeHtml.apply(this, args);
+      }
+      return super.afterMakeHtml(...args);
+    }
+
+    test(...args) {
+      if (filteredOptions.test) {
+        return filteredOptions.test.apply(this, args);
+      }
+      return super.test(...args);
+    }
+
+    rule(...args) {
+      if (filteredOptions.rule) {
+        return filteredOptions.rule.apply(this, args);
+      }
+      return super.rule(...args);
+    }
+  };
+}
+
+export function createMenuHook(name, options) {
+  const optionsWhiteList = ['subMenuConfig', 'onClick', 'shortcutKeys', 'iconName', 'icon'];
+  const propTypes = {
+    subMenuConfig: Array,
+    onClick: 'function',
+    shortcutKeys: Array,
+    iconName: 'string',
+    icon: [
+      'string',
+      {
+        type: 'string',
+        content: 'string',
+        iconStyle: ['string', 'undefined'],
+        iconClassName: ['string', 'undefined'],
+      },
+    ],
+  };
+  const filteredOptions = filterOptions(options, optionsWhiteList, propTypes);
+  return class CustomMenu extends MenuBase {
+    constructor(editorInstance) {
+      super(editorInstance);
+      if (!filteredOptions.iconName && !filteredOptions.icon) {
+        this.noIcon = true;
+      }
+      if (filteredOptions.icon) {
+        this.$currentMenuOptions.icon = filteredOptions.icon;
+        this.name = name;
+      } else {
+        this.setName(name, filteredOptions.iconName);
+      }
+      this.subMenuConfig = filteredOptions.subMenuConfig || [];
+    }
+
+    onClick(...args) {
+      if (filteredOptions.onClick) {
+        return filteredOptions.onClick.apply(this, args);
+      }
+      return super.onClick(...args);
+    }
+
+    get shortcutKeys() {
+      console.warn(
+        'shortcutKeys will deprecated in the future, please use shortcutKeyMap instead, get more info at https://github.com/Tencent/cherry-markdown/wiki',
+      );
+      if (filteredOptions.shortcutKeys) {
+        return filteredOptions.shortcutKeys;
+      }
+      return [];
+    }
+  };
+}