草庐IT

vue3+vite+ts使用monaco-editor编辑器

Best_卡卡 2024-03-15 原文

前言

近期要完成一个代码编辑器的内容,用的vue3.0+ts+vite架构,学习尚浅,
常在插件上遇坑
特此记录下在monaco-editor的使用
需求:yaml和sql的文件的高亮、补全


实现

  1. 安装
// ^0.34.1
yarn add monaco-editor
  1. 在vite.config.js中配置(如果不需要ts\js\html就不需要这么做)
// 强制预构建插件包
   optimizeDeps: {
    include: [
      `monaco-editor/esm/vs/language/json/json.worker`,
      `monaco-editor/esm/vs/language/css/css.worker`,
      `monaco-editor/esm/vs/language/html/html.worker`,
      `monaco-editor/esm/vs/language/typescript/ts.worker`,
      `monaco-editor/esm/vs/editor/editor.worker`
    ], 
  },
  1. 组件封装与使用
    monacoEditor.vue组件
    <template>
      <div
        ref="codeEditBox"
        class="codeEditBox"
        :class="hightChange&&'codeEditBox1'"
      />
    </template>
    <script lang="ts">
    	import {
    	  defineComponent, onBeforeUnmount, onMounted, ref, watch,
    	} from 'vue'
    	import JsonWorker from 'monaco-editor/esm/vs/language/json/json.worker?worker'
    	import CssWorker from 'monaco-editor/esm/vs/language/css/css.worker?worker'
    	import HtmlWorker from 'monaco-editor/esm/vs/language/html/html.worker?worker'
    	import TsWorker from 'monaco-editor/esm/vs/language/typescript/ts.worker?worker'
    	import EditorWorker from 'monaco-editor/esm/vs/editor/editor.worker?worker'
    	import * as monaco from 'monaco-editor'
    	import { language as sqlLanguage } from 'monaco-editor/esm/vs/basic-languages/sql/sql.js';
    	import { language as yamlLanguage } from 'monaco-editor/esm/vs/basic-languages/yaml/yaml.js';
    	import 'monaco-editor/esm/vs/basic-languages/sql/sql.contribution'
    	import { editorProps } from './monacoEditorType'
    	export default defineComponent({
    	  name: 'MonacoEditor',
    	  props: editorProps,
    	  emits: ['update:modelValue', 'change', 'editor-mounted'],
    	  setup(props, { emit }) {
    	    (self as any).MonacoEnvironment = {
    	      getWorker(_: string, label: string) {
    	        if (label === 'json') {
    	          return new JsonWorker()
    	        }
    	        if (['css', 'scss', 'less'].includes(label)) {
    	          return new CssWorker()
    	        }
    	        if (['html', 'handlebars', 'razor'].includes(label)) {
    	          return new HtmlWorker()
    	        }
    	        if (['typescript', 'javascript'].includes(label)) {
    	          return new TsWorker()
    	        }
    	        return new EditorWorker()
    	      },
    	    }
    	    let editor: any
    	    const codeEditBox = ref()
    	
    	    const init = () => {
    	      monaco.languages.typescript.javascriptDefaults.setDiagnosticsOptions({
    	        noSemanticValidation: true,
    	        noSyntaxValidation: false,
    	      })
    	      monaco.languages.typescript.javascriptDefaults.setCompilerOptions({
    	        target: monaco.languages.typescript.ScriptTarget.ES2020,
    	        allowNonTsExtensions: true,
    	      })
    	      monaco.languages.registerCompletionItemProvider('sql', {
    	        provideCompletionItems() {
    	          const suggestions:any = [];
    	          // 这个keywords就是sql.js文件中有的
    	          sqlLanguage.keywords.forEach((item:any) => {
    	            suggestions.push({
    	              label: item,
    	              kind: monaco.languages.CompletionItemKind.Keyword,
    	              insertText: item,
    	            });
    	          })
    	          sqlLanguage.operators.forEach((item:any) => {
    	            suggestions.push({
    	              label: item,
    	              kind: monaco.languages.CompletionItemKind.Operator,
    	              insertText: item,
    	            });
    	          })
    	          sqlLanguage.builtinFunctions.forEach((item:any) => {
    	            suggestions.push({
    	              label: item,
    	              kind: monaco.languages.CompletionItemKind.Function,
    	              insertText: item,
    	            });
    	          })
    	          sqlLanguage.builtinVariables.forEach((item:any) => {
    	            suggestions.push({
    	              label: item,
    	              kind: monaco.languages.CompletionItemKind.Variable,
    	              insertText: item,
    	            });
    	          })
    	          return {
    	            // 最后要返回一个数组
    	            suggestions,
    	          };
    	        },
    	      })
    	      monaco.languages.registerCompletionItemProvider('yaml', {
    	        provideCompletionItems() {
    	          const suggestions:any = [];
    	          // 这个keywords就是python.js文件中有的
    	          yamlLanguage.keywords.forEach((item:any) => {
    	            suggestions.push({
    	              label: item,
    	              kind: monaco.languages.CompletionItemKind.Keyword,
    	              insertText: item,
    	            });
    	          })
    	          return {
    	            // 最后要返回一个数组
    	            suggestions,
    	          };
    	        },
    	      })
    	
    	      editor = monaco.editor.create(codeEditBox.value, {
    	        value: props.modelValue,
    	        language: props.language,
    	        readOnly: props.readOnly,
    	        theme: props.theme,
    	        ...props.options,
    	      })
    
          // 监听值的变化
          editor.onDidChangeModelContent(() => {
            const value = editor.getValue() // 给父组件实时返回最新文本
            emit('update:modelValue', value)
            emit('change', value)
          })
    
          emit('editor-mounted', editor)
        }
        watch(
          () => props.modelValue,
          (newValue) => {
            if (editor) {
              const value = editor.getValue()
              if (newValue !== value) {
                editor.setValue(newValue)
              }
            }
          },
        )
    
        watch(
          () => props.options,
          (newValue) => {
            editor.updateOptions(newValue)
          },
          { deep: true },
        )
        watch(
          () => props.readOnly,
          () => {
            console.log('props.readOnly', props.readOnly)
            editor.updateOptions({ readOnly: props.readOnly })
          },
          { deep: true },
        )
    
        watch(
          () => props.language,
          (newValue) => {
            monaco.editor.setModelLanguage(editor.getModel()!, newValue)
          },
        )
    
        onBeforeUnmount(() => {
          editor.dispose()
        })
    
        onMounted(() => {
          init()
        })
    
        return { codeEditBox }
      },
    })
    </script>
      <style lang="scss" scoped>
      .codeEditBox {
        width: 100%;
        flex: 1;
        min-height: 100px;
        // height: 200px;
        overflow-y: auto;
      }
      .codeEditBox1{
        height: calc(100% - 323px);
      }
      </style>
    
  2. monacoEditorType.ts类型定义文件
    	import { PropType } from 'vue'
    	
    	export type Theme = 'vs' | 'hc-black' | 'vs-dark'
    	export type FoldingStrategy = 'auto' | 'indentation'
    	export type RenderLineHighlight = 'all' | 'line' | 'none' | 'gutter'
    	export interface Options {
    	  automaticLayout: boolean // 自适应布局
    	  foldingStrategy: FoldingStrategy // 折叠方式  auto | indentation
    	  renderLineHighlight: RenderLineHighlight // 行亮
    	  selectOnLineNumbers: boolean // 显示行号
    	  placeholder:string
    	  minimap: {
    	    // 关闭小地图
    	    enabled: boolean
    	  }
    	  // readOnly: Boolean // 只读
    	  fontSize: number // 字体大小
    	  scrollBeyondLastLine: boolean // 取消代码后面一大段空白
    	  overviewRulerBorder: boolean // 不要滚动条的边框
    	}
    	
    	export const editorProps = {
    	  modelValue: {
    	    type: String as PropType<string>,
    	    default: null,
    	  },
    	  hightChange: {
    	    type: Boolean,
    	    default: false,
    	  },
    	  width: {
    	    type: [String, Number] as PropType<string | number>,
    	    default: '100%',
    	  },
    	  height: {
    	    type: [String, Number] as PropType<string | number>,
    	    default: '100%',
    	  },
    	  language: {
    	    type: String as PropType<string>,
    	    default: 'javascript',
    	  },
    	  readOnly: {
    	    type: Boolean,
    	    default: false,
    	  },
    	  theme: {
    	    type: String as PropType<Theme>,
    	    validator(value: string): boolean {
    	      return ['vs', 'hc-black', 'vs-dark', 'hc-light'].includes(value)
    	    },
    	    default: 'vs',
    	  },
    	  options: {
    	    type: Object as PropType<Options>,
    	    default() {
    	      return {
    	        automaticLayout: true,
    	        // foldingStrategy: 'indentation',
    	        foldingStrategy: 'indentation', // 折叠方式  auto | indentation
    	        // renderLineHighlight: 'all',
    	        renderLineHighlight: 'all' || 'line' || 'none' || 'gutter', // 行亮
    	        selectOnLineNumbers: true, // 显示行号
    	        minimap: {
    	          // 关闭小地图
    	          enabled: false,
    	        },
    	        placeholder: 'ss',
    	        // readOnly: false, // 只读
    	        fontSize: 16, // 字体大小
    	        scrollBeyondLastLine: false, // 取消代码后面一大段空白
    	        overviewRulerBorder: false, // 不要滚动条的边框
    	      }
    	    },
    	  },
    	}
    
  3. 在父组件中使用
    	<monacoEditor
       	v-model="value"
         :language="language"
         :hight-change="hightChange"
         :read-only="tablist.length===0"
         width="100%"
         height="100%"
         @editor-mounted="editorMounted"
       />
       import monacoEditor from './monacoEditor.vue'
       const value = ref('-- select * from infrastructure;')
       const language = ref('sql')
       const hightChange = ref<any>(false)
       const editorMounted = (editor: any) => {
         console.log('editor实例加载完成', editor)
       }
    
        value:编辑器代码显示的值
        language:要加载的语言类型
        hightChange:改变编辑器的高度(可去掉,我这边有个sql查表的实现,需要在编辑区下面加一个sql查询的表格,所以需要这个参数)
        read-only:编辑区是否是只读的,当左侧文件树为空时没有文件,编辑区不可写
        editorMounted:加载完成操作
    
    //记得在env.d.ts配置包的
    declare module 'monaco-editor';
    declare module 'monaco-editor/esm/vs/language/typescript/ts.worker?worker'
    declare module 'monaco-editor/esm/vs/basic-languages/sql/sql.js';
    declare module 'monaco-editor/esm/vs/basic-languages/yaml/yaml.js';
    declare module 'monaco-editor/esm/vs/language/json/json.worker?worker'
    declare module 'monaco-editor/esm/vs/language/css/css.worker?worker'
    declare module 'monaco-editor/esm/vs/language/html/html.worker?worker'
    declare module 'monaco-editor/esm/vs/editor/editor.worker?worker'
    declare module 'monaco-editor/esm/vs/basic-languages/javascript/javascript.js'
    

打包报错的处理

yarn build 时会发生下述报错


我在这里看到了解决办法https://github.com/microsoft/monaco-editor/blob/main/docs/integrate-esm.md

在monacoEditor.vue组件,重写getWorker方法

<template>
  <div
    ref="codeEditBox"
    class="codeEditBox"
    :class="hightChange&&'codeEditBox1'"
  />
</template>

<script lang="ts">
import {
  defineComponent, onBeforeUnmount, onMounted, ref, watch,
} from 'vue'
// 减去以下包
--  import JsonWorker from 'monaco-editor/esm/vs/language/json/json.worker?worker'
--  import CssWorker from 'monaco-editor/esm/vs/language/css/css.worker?worker'
--  import HtmlWorker from 'monaco-editor/esm/vs/language/html/html.worker?worker'
--  import TsWorker from 'monaco-editor/esm/vs/language/typescript/ts.worker?worker'
--  import EditorWorker from 'monaco-editor/esm/vs/editor/editor.worker?worker'

import * as monaco from 'monaco-editor'
import { language as sqlLanguage } from 'monaco-editor/esm/vs/basic-languages/sql/sql.js';
import { language as yamlLanguage } from 'monaco-editor/esm/vs/basic-languages/yaml/yaml.js';
import 'monaco-editor/esm/vs/basic-languages/sql/sql.contribution'
import 'monaco-editor/esm/vs/basic-languages/yaml/yaml.contribution'
import 'monaco-editor/esm/vs/basic-languages/javascript/javascript.contribution'
import { editorProps } from './monacoEditorType'

export default defineComponent({
  name: 'MonacoEditor',
  props: editorProps,
  emits: ['update:modelValue', 'change', 'editor-mounted'],
  setup(props, { emit }) {
    (self as any).MonacoEnvironment = {
     ++ getWorker: (_: string, label: string) => {
     ++   const getWorkerModule = (moduleUrl:string, label:string) => new Worker((self as any).MonacoEnvironment.getWorkerUrl(moduleUrl), {
     ++     name: label,
     ++     type: 'module',
     ++   });

     ++   switch (label) {
     ++     case 'json':
     ++       return getWorkerModule('/monaco-editor/esm/vs/language/json/json.worker?worker', label);
     ++     case 'css':
     ++     case 'scss':
     ++     case 'less':
     ++       return getWorkerModule('/monaco-editor/esm/vs/language/css/css.worker?worker', label);
     ++     case 'html':
     ++     case 'handlebars':
     ++     case 'razor':
     ++       return getWorkerModule('/monaco-editor/esm/vs/language/html/html.worker?worker', label);
     ++     case 'typescript':
     ++     case 'javascript':
     ++       return getWorkerModule('/monaco-editor/esm/vs/language/typescript/ts.worker?worker', label);
     ++     default:
     ++       return getWorkerModule('/monaco-editor/esm/vs/editor/editor.worker?worker', label);
     ++   }
     ++ },
      // 原来的减去
      -- getWorker(_: string, label: string) {
      --   if (label === 'json') {
      --     return new JsonWorker()
      --   }
      --   if (['css', 'scss', 'less'].includes(label)) {
      --     return new CssWorker()
      --   }
      --   if (['html', 'handlebars', 'razor'].includes(label)) {
      --     return new HtmlWorker()
      --   }
      --   if (['typescript', 'javascript'].includes(label)) {
      --     return new TsWorker()
      --   }
      --   return new EditorWorker()
      -- },
    }
    let editor: any
    const codeEditBox = ref()

    const init = () => {
      monaco.languages.typescript.javascriptDefaults.setDiagnosticsOptions({
        noSemanticValidation: true,
        noSyntaxValidation: false,
      })
      monaco.languages.typescript.javascriptDefaults.setCompilerOptions({
        target: monaco.languages.typescript.ScriptTarget.ES2020,
        allowNonTsExtensions: true,
      })
      monaco.languages.registerCompletionItemProvider('sql', {
        provideCompletionItems() {
          const suggestions:any = [];
          // 这个keywords就是sql.js文件中有的
          sqlLanguage.keywords.forEach((item:any) => {
            suggestions.push({
              label: item,
              kind: monaco.languages.CompletionItemKind.Keyword,
              insertText: item,
            });
          })
          sqlLanguage.operators.forEach((item:any) => {
            suggestions.push({
              label: item,
              kind: monaco.languages.CompletionItemKind.Operator,
              insertText: item,
            });
          })
          sqlLanguage.builtinFunctions.forEach((item:any) => {
            suggestions.push({
              label: item,
              kind: monaco.languages.CompletionItemKind.Function,
              insertText: item,
            });
          })
          sqlLanguage.builtinVariables.forEach((item:any) => {
            suggestions.push({
              label: item,
              kind: monaco.languages.CompletionItemKind.Variable,
              insertText: item,
            });
          })
          return {
            // 最后要返回一个数组
            suggestions,
          };
        },
      })
      monaco.languages.registerCompletionItemProvider('yaml', {
        provideCompletionItems() {
          const suggestions:any = [];
          // 这个keywords就是python.js文件中有的
          yamlLanguage.keywords.forEach((item:any) => {
            suggestions.push({
              label: item,
              kind: monaco.languages.CompletionItemKind.Keyword,
              insertText: item,
            });
          })
          return {
            // 最后要返回一个数组
            suggestions,
          };
        },
      })

      editor = monaco.editor.create(codeEditBox.value, {
        value: props.modelValue,
        language: props.language,
        readOnly: props.readOnly,
        theme: props.theme,
        ...props.options,
      })

      // 监听值的变化
      editor.onDidChangeModelContent(() => {
        const value = editor.getValue() // 给父组件实时返回最新文本
        emit('update:modelValue', value)
        emit('change', value)
      })

      emit('editor-mounted', editor)
    }
    watch(
      () => props.modelValue,
      (newValue) => {
        if (editor) {
          const value = editor.getValue()
          if (newValue !== value) {
            editor.setValue(newValue)
          }
        }
      },
    )

    watch(
      () => props.options,
      (newValue) => {
        editor.updateOptions(newValue)
      },
      { deep: true },
    )
    watch(
      () => props.readOnly,
      () => {
        console.log('props.readOnly', props.readOnly)
        editor.updateOptions({ readOnly: props.readOnly })
      },
      { deep: true },
    )

    watch(
      () => props.language,
      (newValue) => {
        monaco.editor.setModelLanguage(editor.getModel()!, newValue)
      },
    )

    onBeforeUnmount(() => {
      editor.dispose()
    })

    onMounted(() => {
      init()
    })

    return { codeEditBox }
  },
})
</script>

  <style lang="scss" scoped>
  .codeEditBox {
    width: 100%;
    flex: 1;
    min-height: 100px;
    // height: 200px;
    overflow-y: auto;
  }
  .codeEditBox1{
    height: calc(100% - 323px);
  }
  </style>

有关vue3+vite+ts使用monaco-editor编辑器的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  3. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法? - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  4. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇,就使用ruby​​onrails自动化单元测试而言,你们正在做什么?您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您?git中的预提交Hook?只是手动调用?我完全理解测试,但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的,并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您? 最佳答案 不确定您到底想听什么,但是有几个级别的自动代码库控制:在处理某项功能时,您可以使用类似autotest的内容获得关于哪些有效,哪些无效的即时反馈。要确保您的提

  5. ruby - 在 Ruby 中使用匿名模块 - 2

    假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外,还有什么方法可以访问C和m中的其他内容?我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)?如何在使用完匿名模块后将其删除,使其定义的常量不再存在? 最佳答案 三个答案:是的,使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

  6. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

    我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封,在我看来soap请求没有正确的命名空间。任何人都可以建议我

  7. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  8. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

  9. ruby - 使用 ruby​​ 将 HTML 转换为纯文本并维护结构/格式 - 2

    我想将html转换为纯文本。不过,我不想只删除标签,我想智能地保留尽可能多的格式。为插入换行符标签,检测段落并格式化它们等。输入非常简单,通常是格式良好的html(不是整个文档,只是一堆内容,通常没有anchor或图像)。我可以将几个正则表达式放在一起,让我达到80%,但我认为可能有一些现有的解决方案更智能。 最佳答案 首先,不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案,它会随着HTML的变化而崩溃,或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h

  10. ruby - 在 64 位 Snow Leopard 上使用 rvm、postgres 9.0、ruby 1.9.2-p136 安装 pg gem 时出现问题 - 2

    我想为Heroku构建一个Rails3应用程序。他们使用Postgres作为他们的数据库,所以我通过MacPorts安装了postgres9.0。现在我需要一个postgresgem并且共识是出于性能原因你想要pggem。但是我对我得到的错误感到非常困惑当我尝试在rvm下通过geminstall安装pg时。我已经非常明确地指定了所有postgres目录的位置可以找到但仍然无法完成安装:$envARCHFLAGS='-archx86_64'geminstallpg--\--with-pg-config=/opt/local/var/db/postgresql90/defaultdb/po

随机推荐