教你做个在线代码编辑器,体验堪比 VSCode!

有的需求需要在网页上写代码。

比如在线执行代码的 playground:

教你做个在线代码编辑器,体验堪比 VSCode!

或者在线面试:

教你做个在线代码编辑器,体验堪比 VSCode!

如果让你实现网页版 TypeScript 编辑器,你会如何做呢?

有的同学说,直接用微软的 monaco editor 呀:

教你做个在线代码编辑器,体验堪比 VSCode!

确实,直接用它就可以,但是有挺多地方需要处理的。

我们来试试看。

npx create-vite
教你做个在线代码编辑器,体验堪比 VSCode!

创建个 vite + react 的项目。

安装依赖:

npm install

npm install @monaco-editor/react

这里用 @monaco-editor/react 这个包,它把 monaco editor 封装成了 react 组件。

去掉 main.tsx 里的 index.css

教你做个在线代码编辑器,体验堪比 VSCode!

然后在 App.tsx 用一下:

import MonacoEditor from '@monaco-editor/react'

export default function App({

  const code = `import lodash from 'lodash';
function App() {
  return 
guang
  
}  
  `
;

  return MonacoEditor
      height={'100vh'}
      path={"guang.tsx"}
      language={"typescript"}
      value={code}
  />
}

跑下开发服务:

npm run dev

试下看:

教你做个在线代码编辑器,体验堪比 VSCode!

现在就可以在网页写 ts 代码了。

但是有报错:

教你做个在线代码编辑器,体验堪比 VSCode!

jsx 语法不知道怎么处理。

这里明显要改 typescript 的 tsconfig.json。

怎么改呢?

这样:

教你做个在线代码编辑器,体验堪比 VSCode!
import MonacoEditor, { OnMount } from '@monaco-editor/react'

export default function App({

  const code = `import lodash from 'lodash';
function App() {
  return 
guang
  
}  
  `
;

  const handleEditorMount: OnMount = (editor, monaco) => {
    monaco.languages.typescript.typescriptDefaults.setCompilerOptions({
        jsx: monaco.languages.typescript.JsxEmit.Preserve,
        esModuleInteroptrue,
    })

}

  return MonacoEditor
      height={'100vh'}
      path={"guang.tsx"}
      language={"typescript"}
      onMount={handleEditorMount}
      value={code}
  />
}

onMount 的时候,设置 ts 的 compilerOptions。

这里设置 jsx 为 preserve,也就是输入

输出

,保留原样。

如果设置为 react 会输出 React.createElement(“div”)。

再就是 esModuleInterop,这个也是 ts 常用配置。

默认 fs 要这么引入,因为它是 commonjs 的包,没有 default 属性:

import * as fs from 'fs';

设置 esModuleInterop 会在编译的时候自动加上 default 属性。

就可以这样引入了:

import fs from 'fs';

可以看到,现在 jsx 就不报错了:

教你做个在线代码编辑器,体验堪比 VSCode!

还有一个错误:

教你做个在线代码编辑器,体验堪比 VSCode!

没有 lodash 的类型定义。

教你做个在线代码编辑器,体验堪比 VSCode!

写 ts 代码没提示怎么行呢?

我们也要支持下。

这里用到 @typescript/ata 这个包:

教你做个在线代码编辑器,体验堪比 VSCode!

ata 是 automatic type acquisition 自动类型获取。

它可以传入源码,自动分析出需要的 ts 类型包,然后自动下载。

我们新建个 ./ata.ts,复制文档里的示例代码:

import { setupTypeAcquisition } from '@typescript/ata'
import typescriprt from 'typescript';

export function createATA(onDownloadFile: (code: string, path: string) => void{
  const ata = setupTypeAcquisition({
    projectName'my-ata',
    typescript: typescriprt,
    loggerconsole,
    delegate: {
      receivedFile(code, path) => {
        console.log('自动下载的包', path);
        onDownloadFile(code, path);
      }
    },
  })

  return ata;
}

安装用到的包:

npm install --save @typescript/ata -f 

这里就是用 ts 包去分析代码,然后自动下载用到的类型包,有个 receivedFile 的回调函数里可以拿到下载的代码和路径。

然后在 mount 的时候调用下:

教你做个在线代码编辑器,体验堪比 VSCode!
const ata = createATA((code, path) => {
    monaco.languages.typescript.typescriptDefaults.addExtraLib(code, `file://${path}`)
})

editor.onDidChangeModelContent(() => {
    ata(editor.getValue());
});

ata(editor.getValue());

就是最开始获取一次类型,然后内容改变之后获取一次类型,获取类型之后用 addExtraLib 添加到 ts 里。

看下效果:

教你做个在线代码编辑器,体验堪比 VSCode!
教你做个在线代码编辑器,体验堪比 VSCode!

有类型了!

写代码的时候用到的包也会动态去下载它的类型:

教你做个在线代码编辑器,体验堪比 VSCode!

比如我们用到了 ahooks,就会实时下载它的类型包然后应用。

这样,ts 的开发体验就有了。

再就是现在字体有点小,明明内容不多右边却有一个滚动条:

教你做个在线代码编辑器,体验堪比 VSCode!

这些改下 options 的配置就好了:

教你做个在线代码编辑器,体验堪比 VSCode!scrollBeyondLastLine 是到了最后一行之后依然可以滚动一屏,关闭后就不会了。

minimap 就是缩略图,关掉就没了。

scrollbar 是设置横向纵向滚动条宽度的。

theme 是修改主题。

return MonacoEditor
      height={'100vh'}
      path={"guang.tsx"}
      language={"typescript"}
      onMount={handleEditorMount}
      value={code}
      options={
        {
          fontSize: 16,
          
          scrollBeyondLastLine: false,
          minimap: {
            enabled: false,
          },
          scrollbar: {
            verticalScrollbarSize: 6,
            horizontalScrollbarSize: 6,
          }
        }
    }
  />
教你做个在线代码编辑器,体验堪比 VSCode!

好多了。

我们还可以添加快捷键的交互:

教你做个在线代码编辑器,体验堪比 VSCode!默认 cmd(windows 下是 ctrl) + j 没有处理。

我们可以 cmd + j 的时候格式化代码。

教你做个在线代码编辑器,体验堪比 VSCode!
editor.addCommand(monaco.KeyMod.CtrlCmd | monaco.KeyCode.KeyJ, () => {
    editor.getAction('editor.action.formatDocument')?.run()
});

试下效果:

教你做个在线代码编辑器,体验堪比 VSCode!

有同学可能问,monaco editor 还有哪些 action 呢?

打印下就知道了:

editor.addCommand(monaco.KeyMod.CtrlCmd | monaco.KeyCode.KeyJ, () => {
    // editor.getAction('editor.action.formatDocument')?.run()
    let actions = editor.getSupportedActions().map((a) => a.id);
    console.log(actions);
});

有 131 个:

教你做个在线代码编辑器,体验堪比 VSCode!

用到再搜就行。

这样,我们的网页版 TypeScript 编辑器就完成了。

总结

有的需求需要实现网页版编辑器,我们一般都用 monaco editor 来做。

今天我们基于 @monaco-editor/react 实现了 TypeScript 编辑器。

可以在 options 里配置滚动条、字体大小、主题等。

然后 onMount 里可以设置 compilerOptions,用 addCommand 添加快捷键等。

并且我们基于 @typescript/ata 实现了自动下载用到的 ts 类型的功能,它会扫描代码里的 import,然后自动下载类型,之后 addExtraLib 添加到 ts 里。

这样在网页里就有和 vscode 一样的 ts 编写体验了。


👇🏻 点击下方阅读原文,获取鱼皮往期编程干货。

往期推荐

我的新项目又来咯!

我们团队前端的自学经历,三本又怎样?

面对狗血小 Bug,我再也不慌了~

偷偷分享下我们公司的研发规范~

我们做的小工具,爆了!

大厂,是怎么提高研发效率的?

唉,新项目内测延期了。。我的一点思考

本内容观点仅代表发布作者本人观点立场,欣文网平台只做信息内容展示和存储。发布作者:全网转载,转转请注明出处:https://www.xinenw.com/6044.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2024年4月28日 17:28
下一篇 2024年4月28日 17:28

相关推荐

  • 发售43天销量200万,华为Pura70这次是真的杀疯了

    不知道大伙还记不记得这个玩意儿。 没印象的小伙伴,可能觉得就只是个普通的手机壳。 但有印象的话,就知道这是个「5G 通信壳」。 前两年华为手机因为一些懂的都懂的原因,只能用 4G。 于是数源科技就整了个 5G 通信壳,通过外接 eSIM 的方式,让 4G 手机也能体验 5G 冲浪。 不过吧,这玩意儿还真不便宜,原价 640~899 不等。 但自打去年华为 M…

    2024年6月2日
    14300
  • 成长有方法:一年如何抵三年

    在人生中,我们时常渴望快速成长,希望能在有限的时间内实现自我价值的最大化。然而,成长并非一蹴而就,它需要我们掌握正确的方法,遵循一定的规律,并付出持续不断的努力。在这篇文章中,如何通过五大步骤实现快速成长,让一年抵得上三年的努力。 一、选题:确定成长的方向 成长的第一步是明确目标,选择正确的方向。没有准确的目标,就像无头苍蝇一样乱撞,难以取得真正的进步。因此…

    2024年6月8日
    18000
  • 常见ZIP密码破解工具

    zip文件是我们工作和生活中常见的工具。有时为了安全,我们会给文件添加密码。可是时间久了,密码也忘记了。本文为大家收集了一些好用的zip密码恢复工具。希望对大家有所帮助。 ZIP-Password-BruteForcer 优点: 支持跨平台 快速 高效。 缺点: 仅支持字典破解。 使用: 在Linux中我们可以使用下面命令安装和使用。需要提前部署python…

    2024年10月6日
    4100
  • 自我提升,向上生长

    人生如白驹过隙,短暂而宝贵。在这有限的时光里,我们如何能够让那些零碎的时间变得充实而有意义呢?答案就在自我提升之中。无论是运动、阅读、观看辩论赛,还是纪录片,这些活动都能为成长添砖加瓦。 高尔基曾言:“书籍是人类进步的阶梯。”阅读,无疑是自我提升的重要途径。当我们沉浸在书籍的海洋中,那些纷繁复杂的压力便仿佛被抛诸脑后。书中的故事、人物、情感,将我们带入一个全…

    2024年6月5日
    14800
  • 游戏+文旅彻底出圈,下一步该怎么走?

    ‍‍         国庆长假,旅游成为社媒的焦点,这一次,游戏+文旅成了显眼包。 众多关于国庆旅游分析的报道中,不约而同提到了《黑神话:悟空》对山西文旅的帮助。据央视网报道,山西成为各旅游平台最火爆的旅游目的地之一,其中因游戏《黑神话:悟空》爆火的临汾隰县成“旅游新贵”,小西天景区迎来“泼天的流量”,接待游客人数9.17万人次,同比增长335%。 当然这样…

    2024年10月11日
    2400

发表回复

登录后才能评论

联系我们

400-800-8888

在线咨询: QQ交谈

邮件A:xinenw@qq.com

邮箱B:xinenw@163.com

工作时间:周一至周五,8:30-23:30;周六周日10:30-18:30;节假日休息

关注微信