开篇: 为什么要做这个项目?

2024-09-08 05:44
文章标签 项目 开篇

本文主要是介绍开篇: 为什么要做这个项目?,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

背景

最近工作中遇到一个需求需要实现一版在线的Web编辑器,类似 Vue Playground 的效果,但是Vue playground 整体体验下来不是很好,和本地 VSCode 编辑器开发体验差距较大(虽然理解在线编辑器没必要完全照着本地开发体验来)。
经过多方体验调研,发现目前的业界方案主要两种:

  1. 基于Monaco / Codemirror 实现,也是大多数场景使用的方案,但是效果却是参差不齐,很多的能力也有缺失,很难找到一个满足需求并且开放扩展性较好的方案;
  2. 基于VSCode编辑器,或者CodeSandbox 的方案,但是初步开发入手成本较高,编辑器本身内容很丰富,开发体验也最接近本地编辑器(但是大部分在Web端用不上)。扩展能力通过VS Code 插件进行处理也不是很方便开发,定制扩展性不够。

在调研过程中,也发现了一个用于对VSCode 编辑器进行 overlay 的包,能够比较方便在运行起VSCode项目,同时对一些能力进行删减,定制等,但是整体体验下来还是有些问题,一些私有化场景的定制难以实现。这里附上其github链接,有兴趣的可以参考尝试 monaco-vscode-api

预期的效果

这里说一下我希望的一个编辑器效果是什么样的:

  1. 开发体验尽可能的贴近本地VS Code开发,功能上只需要包括核心的部分能力
  2. 能够是一个组件形式的,现在前端开发大部分都是 Vue/React 框架基础上进行的,面向组件的使用方式是最容易上手接入的;
  3. 使用足够简单,能够按需使用,比如只需要编辑器部分,文件系统部分等。
  4. 扩展性足够,能够基于组件进行扩展,提供自定义的能力
  5. 简化配置,Monaco编辑器要使用还是需要有一些配置的,能够尽可能的简化掉

最后

经过调研和体验下来,并没有能够找到一款完全符合我预期的编辑器产品,最终决定下来自己来做这么一个编辑器,一方面解决当前的工作问题,也将这个项目的流程和开发实现中遇到的问题提取出来,帮助有需要的人。

这里也简单介绍写这个项目实现的功能部分:

  • 基于Monaco实现的前端代码编辑器(包括Vue语言的支持)
  • 内存文件系统管理,包括文件创建,目录创建,重命名,文件移动等等
  • 在线依赖安装,并且能够对编辑器提供包类型提示支持
  • 代码搜索,类似VSCode编辑器的文件搜索,内容替换等能力
  • 多编辑器代码分栏编辑
  • Prettier 代码自动格式化

项目采用的技术方案:

  • Monaco-Editor
  • Vue3 + Vite5
  • ant-design-vue4

项目最终会封装成一个Vue3组件包的形式,支持按需使用和扩展,最后附上一张最后的效果图:

在这里插入图片描述

这篇关于开篇: 为什么要做这个项目?的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1147280

相关文章

一文详解如何在idea中快速搭建一个Spring Boot项目

《一文详解如何在idea中快速搭建一个SpringBoot项目》IntelliJIDEA作为Java开发者的‌首选IDE‌,深度集成SpringBoot支持,可一键生成项目骨架、智能配置依赖,这篇文... 目录前言1、创建项目名称2、勾选需要的依赖3、在setting中检查maven4、编写数据源5、开启热

SpringBoot项目配置logback-spring.xml屏蔽特定路径的日志

《SpringBoot项目配置logback-spring.xml屏蔽特定路径的日志》在SpringBoot项目中,使用logback-spring.xml配置屏蔽特定路径的日志有两种常用方式,文中的... 目录方案一:基础配置(直接关闭目标路径日志)方案二:结合 Spring Profile 按环境屏蔽关

MySQL版本问题导致项目无法启动问题的解决方案

《MySQL版本问题导致项目无法启动问题的解决方案》本文记录了一次因MySQL版本不一致导致项目启动失败的经历,详细解析了连接错误的原因,并提供了两种解决方案:调整连接字符串禁用SSL或统一MySQL... 目录本地项目启动报错报错原因:解决方案第一个:第二种:容器启动mysql的坑两种修改时区的方法:本地

springboot项目中使用JOSN解析库的方法

《springboot项目中使用JOSN解析库的方法》JSON,全程是JavaScriptObjectNotation,是一种轻量级的数据交换格式,本文给大家介绍springboot项目中使用JOSN... 目录一、jsON解析简介二、Spring Boot项目中使用JSON解析1、pom.XML文件引入依

使用vscode搭建pywebview集成vue项目实践

《使用vscode搭建pywebview集成vue项目实践》:本文主要介绍使用vscode搭建pywebview集成vue项目实践,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地... 目录环境准备项目源码下载项目说明调试与生成可执行文件核心代码说明总结本节我们使用pythonpywebv

Maven项目中集成数据库文档生成工具的操作步骤

《Maven项目中集成数据库文档生成工具的操作步骤》在Maven项目中,可以通过集成数据库文档生成工具来自动生成数据库文档,本文为大家整理了使用screw-maven-plugin(推荐)的完... 目录1. 添加插件配置到 pom.XML2. 配置数据库信息3. 执行生成命令4. 高级配置选项5. 注意事

eclipse如何运行springboot项目

《eclipse如何运行springboot项目》:本文主要介绍eclipse如何运行springboot项目问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目js录当在eclipse启动spring boot项目时出现问题解决办法1.通过cmd命令行2.在ecl

SpringBoot项目Web拦截器使用的多种方式

《SpringBoot项目Web拦截器使用的多种方式》在SpringBoot应用中,Web拦截器(Interceptor)是一种用于在请求处理的不同阶段执行自定义逻辑的机制,下面给大家介绍Sprin... 目录一、实现 HandlerInterceptor 接口1、创建HandlerInterceptor实

Maven项目打包时添加本地Jar包的操作步骤

《Maven项目打包时添加本地Jar包的操作步骤》在Maven项目开发中,我们经常会遇到需要引入本地Jar包的场景,比如使用未发布到中央仓库的第三方库或者处理版本冲突的依赖项,本文将详细介绍如何通过M... 目录一、适用场景说明​二、核心操作命令​1. 命令格式解析​2. 实战案例演示​三、项目配置步骤​1

golang实现动态路由的项目实践

《golang实现动态路由的项目实践》本文主要介绍了golang实现动态路由项目实践,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习... 目录一、动态路由1.结构体(数据库的定义)2.预加载preload3.添加关联的方法一、动态路由1