乐趣区

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

jiezi

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

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

什么是Monaco Editor

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

用法

  1. 安装

    npm install monaco-editor --save

  2. 使用

    <div id="monaco" class="monaco-editor"></div>
    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。

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

啦啦啦~ 交差去啦~

退出移动版