在vue中实现Monaco Editor自定义提示功能

TANKING 发布于2019-08-23 18:29 / 3458人阅读

摘要：这次接到一个需求，要在浏览器的中支持自定义提示功能，如下所示可以看到，它可以根据用户输入的内容来一项一项排除，只显示完全匹配的那一项。

这次接到一个需求，要在浏览器的IDE中支持自定义提示功能，如下所示：

可以看到，它可以根据用户输入的内容来一项一项排除，只显示完全匹配的那一项。
项目的框架是Vue，编辑器用的是Monaco Editor。

什么是Monaco Editor

vscode是我们经常在用的编辑器，它的前身是微软的一个叫Monaco Workbench的项目，而Monaco Editor就是从这个项目中成长出来的一个web编辑器，他们很大一部分的代码都是共用的，所以Monaco Editor和VSCode在编辑代码，交互及UI上几乎是一摸一样的。不同的是，两者的平台不一样，Monaco Editor基于浏览器，而VSCode基于electron，所以功能上VSCode更加健全，性能比较强大。

用法

安装

npm install monaco-editor --save

使用

import * as monaco from "monaco-editor";
this.fileEditor = this.monaco.editor.create(document.getElementById("monaco"), {
  value: null,
  language: "sql"  // 这里以sql为例
})

this.fileEditor.dispose(); // 使用完后销毁

这里引入monaco要注意，在react中以下面方式引入：

import * as monaco from "monaco-editor/esm/vs/editor/editor.api";

实现自定义提示功能

查看了资料后，发现在monaco中有提供一个提示功能的方法registerCompletionItemProvider，具体实现如下：

this.monaco.languages.registerCompletionItemProvider("sql", { // 这里以sql语言为例
  provideCompletionItems () {
    return [{
      label: "${_DB",  // 显示的提示内容
      kind: this.monaco.languages.CompletionItemKind["Function"], // 用来显示提示内容后的不同的图标
      insertText: "{_DB", // 选择后粘贴到编辑器中的文字
      detail: "" // 提示内容后的说明
    }];
  },
  triggerCharacters: ["$"] // 触发提示的字符，可以写多个
});

以上的用法，我试了一下之后发现，虽然triggerCharacters的值是数组，可以有多个，但是里面的字符串只能识别一个字符。一开始的需求是输入${_之后提示${_DB，但是由于不能识别多个字符，只能做到出现$就提示。

还有一个问题就是registerCompletionItemProvider的第一个参数只能是字符串，如果有多种语言只能叠加重复写，恰巧我的需求是有多种语言，所以只能如下解决，也就是每种语言都写了一遍：

["json", "yaml", "php", "go", "sql", "java", "markdown", "plaintext"].map(item => {
  this.monaco.languages.registerCompletionItemProvider(item, {
    provideCompletionItems () {
      return [{
        label: "${_DB",
        kind: this.monaco.languages.CompletionItemKind["Function"],
        insertText: "{_DB",
        detail: ""
      }];
    },
    triggerCharacters: ["$"]
  });
});

需求是${_DB:key:value，也就是说在输入${_DB后，再输入一个:提示出key，在key之后输入:提示value。

这里又碰到一个问题，需要知道当前输入的内容来判断是$还是:，而且后面两个触发提示的符号同是:，无法区分，只能通过识别:的位置来判断是提示key还是value，所以还要知道当前输入的:之前的内容。

那么只有在provideCompletionItems这一步判断，但是查遍了资料没有发现这样的参数，provideCompletionItems只有model、position、token这几个参数，后来发现model中的getLineContent方法可以获取指定行的所有内容，而position可以获取当前输入行的行数和列数，于是就有了以下解决方法：

this.monaco.languages.registerCompletionItemProvider(item, {
  provideCompletionItems (model, position) {
    // 获取当前行数
    const line = position.lineNumber
    
    // 获取当前列数
    const column = position.column
    
    // 获取当前输入行的所有内容
    const content = model.getLineContent(line)
    
    // 通过下标来获取当前光标后一个内容，即为刚输入的内容
    const sym = content[column - 2]
    
    if (sym === "$") {
      return [{
        label: "${_DB",
        kind: this.monaco.languages.CompletionItemKind["Function"],
        insertText: "{_DB",
        detail: ""
      }];
    }
    
    return [{
      label: ":abb",
      kind: this.monaco.languages.CompletionItemKind["Function"],
      insertText: "abb",
      detail: ""
    },
    {
      label: ":bc",
      kind: this.monaco.languages.CompletionItemKind["Function"],
      insertText: "bc",
      detail: ""
    }];
  },
  triggerCharacters: ["$", ":"]
});

能获取光标后的第一个内容，后面的内容就都能获取啦，如果识别到前面的内容是${_DB就提示key，否则提示value。

最后总结下来就是一定要多看文档，勤于测试就能解决问题啦~

啦啦啦~ 交差去啦~

混合云服务器托管 fec在webrtc中实现在浏览器中实现webrtc视频传输自定义提示框中实现单点登录

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/105308.html

精读《手写 SQL 编译器 - 智能提示》

摘要：经过连续几期的介绍，手写编译器系列进入了智能提示模块，前几期从词法到文法语法，再到构造语法树，错误提示等等，都是为智能提示做准备。 1 引言词法、语法、语义分析概念都属于编译原理的前端领域，而这次的目的是做具备完善语法提示的 SQL 编辑器，只需用到编译原理的前端部分。经过连续几期的介绍，《手写 SQL 编译器》系列进入了智能提示模块，前几期从词法到文法、语法，再到构造语法...

ztyzz 2019-08-23 14:15 评论0 收藏0
精读《手写 SQL 编译器 - 智能提示》

摘要：经过连续几期的介绍，手写编译器系列进入了智能提示模块，前几期从词法到文法语法，再到构造语法树，错误提示等等，都是为智能提示做准备。 1 引言词法、语法、语义分析概念都属于编译原理的前端领域，而这次的目的是做具备完善语法提示的 SQL 编辑器，只需用到编译原理的前端部分。经过连续几期的介绍，《手写 SQL 编译器》系列进入了智能提示模块，前几期从词法到文法、语法，再到构造语法...

godruoyi 2019-07-01 16:06 评论0 收藏0
支持多框架的组件库KPC 1.0正式发布

摘要：自从年月份对外公布以来，已经经过了个月的迭代，期间发布了几十个正式版本，但一直没有到，因为我们觉得是个里程碑版本，我们必须做的足够完善才敢称之为。自从17年11月份对外公布以来，KPC已经经过了8个月的迭代，期间发布了几十个正式版本，但一直没有到1.0，因为我们觉得1.0是个里程碑版本，我们必须做的足够完善才敢称之为1.0。而如今我们有信心对外宣布：KPC 1.0终于来了！其实距离...

刘厚水 2019-08-26 10:10 评论0 收藏0
支持多框架的组件库KPC 1.0正式发布

摘要：自从年月份对外公布以来，已经经过了个月的迭代，期间发布了几十个正式版本，但一直没有到，因为我们觉得是个里程碑版本，我们必须做的足够完善才敢称之为。自从17年11月份对外公布以来，KPC已经经过了8个月的迭代，期间发布了几十个正式版本，但一直没有到1.0，因为我们觉得1.0是个里程碑版本，我们必须做的足够完善才敢称之为1.0。而如今我们有信心对外宣布：KPC 1.0终于来了！其实距离...

Cheng_Gang 2019-08-05 17:39 评论0 收藏0
VS Code配置及插件推荐

摘要：宋体以像素为单位控制字号。将其设置为可隐藏窗格。是否已启用自动刷新是否启用自动拉取以像素为单位控制终端的字号，这是的默认值。要求工作区使用高于版本的。用户设置打开文件 > 首选项 > 用户设置(U)，（忽略覆盖工作区提示） { // 一个制表符等于的空格数。该设置在 `editor.detectIndentation` 启用时根据文件内容进行重写。 editor.tabS...

wpw 2019-08-20 14:42 评论0 收藏0