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

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

相关文章

SpringBoot项目中报错The field screenShot exceeds its maximum permitted size of 1048576 bytes.的问题及解决

《SpringBoot项目中报错ThefieldscreenShotexceedsitsmaximumpermittedsizeof1048576bytes.的问题及解决》这篇文章... 目录项目场景问题描述原因分析解决方案总结项目场景javascript提示:项目相关背景:项目场景:基于Spring

解决Maven项目idea找不到本地仓库jar包问题以及使用mvn install:install-file

《解决Maven项目idea找不到本地仓库jar包问题以及使用mvninstall:install-file》:本文主要介绍解决Maven项目idea找不到本地仓库jar包问题以及使用mvnin... 目录Maven项目idea找不到本地仓库jar包以及使用mvn install:install-file基

springboot项目如何开启https服务

《springboot项目如何开启https服务》:本文主要介绍springboot项目如何开启https服务方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录springboot项目开启https服务1. 生成SSL证书密钥库使用keytool生成自签名证书将

将Java项目提交到云服务器的流程步骤

《将Java项目提交到云服务器的流程步骤》所谓将项目提交到云服务器即将你的项目打成一个jar包然后提交到云服务器即可,因此我们需要准备服务器环境为:Linux+JDK+MariDB(MySQL)+Gi... 目录1. 安装 jdk1.1 查看 jdk 版本1.2 下载 jdk2. 安装 mariadb(my

Node.js 数据库 CRUD 项目示例详解(完美解决方案)

《Node.js数据库CRUD项目示例详解(完美解决方案)》:本文主要介绍Node.js数据库CRUD项目示例详解(完美解决方案),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考... 目录项目结构1. 初始化项目2. 配置数据库连接 (config/db.js)3. 创建模型 (models/

springboot项目中常用的工具类和api详解

《springboot项目中常用的工具类和api详解》在SpringBoot项目中,开发者通常会依赖一些工具类和API来简化开发、提高效率,以下是一些常用的工具类及其典型应用场景,涵盖Spring原生... 目录1. Spring Framework 自带工具类(1) StringUtils(2) Coll

Spring Boot项目部署命令java -jar的各种参数及作用详解

《SpringBoot项目部署命令java-jar的各种参数及作用详解》:本文主要介绍SpringBoot项目部署命令java-jar的各种参数及作用的相关资料,包括设置内存大小、垃圾回收... 目录前言一、基础命令结构二、常见的 Java 命令参数1. 设置内存大小2. 配置垃圾回收器3. 配置线程栈大小

Spring Boot项目中结合MyBatis实现MySQL的自动主从切换功能

《SpringBoot项目中结合MyBatis实现MySQL的自动主从切换功能》:本文主要介绍SpringBoot项目中结合MyBatis实现MySQL的自动主从切换功能,本文分步骤给大家介绍的... 目录原理解析1. mysql主从复制(Master-Slave Replication)2. 读写分离3.

一文教你如何将maven项目转成web项目

《一文教你如何将maven项目转成web项目》在软件开发过程中,有时我们需要将一个普通的Maven项目转换为Web项目,以便能够部署到Web容器中运行,本文将详细介绍如何通过简单的步骤完成这一转换过程... 目录准备工作步骤一:修改​​pom.XML​​1.1 添加​​packaging​​标签1.2 添加

tomcat多实例部署的项目实践

《tomcat多实例部署的项目实践》Tomcat多实例是指在一台设备上运行多个Tomcat服务,这些Tomcat相互独立,本文主要介绍了tomcat多实例部署的项目实践,具有一定的参考价值,感兴趣的可... 目录1.创建项目目录,测试文China编程件2js.创建实例的安装目录3.准备实例的配置文件4.编辑实例的