教你做个在线代码编辑器,体验堪比 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

(0)
上一篇 2024年4月28日 17:28
下一篇 2024年4月28日 17:28

相关推荐

  • 直板机不需要的副屏,已成为折叠屏手机的标配

    日前,有消息源曝光了据称是华为nova13 Ultra概念设计图,显示这款机型或将会在后摄模组旁安置一块矩形副屏,能够支持显示诸如天气、通知等简单信息,还可以借助其实现部分操控功能。尽管这种差异化的设计使得产品在外观上有了更高的辨识度,但副屏方案在直板机型上一直就有着不小的争议,部分用户认为其不仅实用度不足、还拉高了整机的成本。 外观设计作为体现产品差异化的…

    2024年5月15日
    3500
  • 斗破苍穹:魂虚子动用虚无吞炎天地之火,萧炎让小伊炼制数千药材

    《斗破苍穹》第593话更新,这一话中,混续租动用虚无吞炎天地子火,药万火和神农老人纷纷动用异火。不过轮到萧炎之时,那就更加厉害,直接让小伊炼制数千药材。 虚无吞炎天地之火 魂虚子是魂族第一炼药师,所以他一定要拿下天下第一炼药师的称号。可以看出魂虚子动用黑鼎炼制丹药,而且还动用了虚无吞炎。看到虚无吞炎出现之后,神农老人和药万火也是一惊。那么这到底是不是虚无吞炎…

    2024年5月5日
    5400
  • 如何判断自己适合创业还是上班?

    点击上方卡片关注👆 创业的人面临的风险更大,但存在的机遇也更大;上班的人虽然日复一日地重复着格子间的节奏,但是却也享受了那一份每月工资到账的安稳。 如何判断自己更适合哪一条路呢?一起看看答主们的分析。 十个信号 答主 @金瀛若愚 分享了创业人身上会有的十个特质: 如有以下十个信号,说明你对创业感兴趣: 从心里抵触被别人安排的工作风格,希望执行自己的想法。即使…

    热点 2024年4月26日
    6100
  • 中国车企出海:卖到哪里?谁赚麻了?

    来源:定焦(dingjiaoone) 作者:黎明 去年,中国一共卖掉了3009万辆汽车,其中有491万辆被卖到海外。如果算上二手车,海外的数字还要多出31万。 这让中国超越日本,成为汽车出口第一大国。 今年前三个月,中国又卖出去新车672万辆,其中出口132万辆。跟去年同期比,总量增长了11%,而出口增长了33%。 这个数据堪称炸裂。在中国生产的汽车,正在加…

    2024年5月12日
    2200
  • 当一个女人先后死了丈夫和儿女

    “ 自20多岁开始,丈夫和孩子先后患相同的遗传病去世,一次次送别血亲的女人,会度过怎样的一生。她一次次目睹患病的家人离开,同样的疾病又缠上了另一名血亲,无尽地告别。 罹患遗传性小脑萎缩后,湖北女孩谢微宁发现,外婆在一生中不断面对至亲离世,命运困顿如同《活着》里的富贵。 生死本有顺序,外婆却始终是被留在世上的那个。她持续遭受噩耗锤击,徒步走过漫长的…

    2024年5月4日
    6400

发表回复

登录后才能评论

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

工作时间:周一至周五,9:30-18:30,节假日休息

关注微信
原欣文网读者需要重新注册,平台不断升级敬请见谅!