开发一个在线代码对比工具

sxkk20082年前知识分享309

前言

在开发过程中,我们经常需要用到代码对比,对比下代码是否一致,有哪些改动,方便我们可以查看问题,今天我们就来说实现下,其实很简单,不需要后端,纯前端就可以实现。

Monaco Editor

Monaco Editor 是 VS Code 中使用的开源代码编辑器, 拥有代码高亮和代码自动补全的功能,并且内置了一个 Diff Editor。

官网 Diff editor

官网就有一个 Diff Editor 的演示,我们要开发的就是在这个基础之上,加上语言切换的功能,让这个 Diff Editor 拥有内置云语言的语法高亮。

TypeScript, JavaScript, CSS, LESS, SCSS, JSON, HTML、XML, PHP, C#, C++, Razor, Markdown, Diff, Java, VB, CoffeeScript, Handlebars, Batch, Pug, F#, Lua, Powershell, Python, Ruby, SASS, R, Objective-C

官网罗列了这些语言,但远不止于此。

马上掘金

使用 monaco-editor 创建一个简单的代码编辑器

使用 monaco-editor 创建一个简单的 Diff 编辑器

Monaco Editor 有 2 种加载方式,分别是 amd 和 esm,也就是 RequirejsES Modules。马上掘金中使用的是 requirejs

技术栈选择

我准备把常用的工具做成一个工具网站,所以我选择使用 next.js,并且可以使用 vercel 免费持续部署。

关于 Monaco Editor 在 next.js 中的配置,之前有介绍过,大家可以看这篇文章 《在 Next.js 中使用 Monaco Editor》

实现 Diff Editor

import type { editor as MonacoEditor } from 'monaco-editor'
import { useEffect, useRef, useState } from 'react'
import * as monaco from 'monaco-editor'

export default function TextDiffPage() {
  const editorContainer = useRef<HTMLDivElement | null>(null)
  const [language, setLanguage] = useState('text')
  const [inlineView, setInlineView] = useState(false)

  const [diffEditor, setDiffEditor] = useState<MonacoEditor.IStandaloneDiffEditor | null>(null)

  const createModel = (value: string, language: string, type: 'original' | 'modified') => {
    return monaco.editor.createModel(value, language)
  }

  const initEditor = async () => {
    const originalModel = createModel(`Hello World`, language, 'original')
    const modifiedModel = createModel(`Goodbye World`, language, 'modified')
    const editor = monaco.editor.createDiffEditor(editorContainer.current, {
      minimap: { enabled: false },
      theme: 'vs-dark',
      renderSideBySide: !inlineView,
      originalEditable: true,
    })
    editor.setModel({
      original: originalModel,
      modified: modifiedModel,
    })

    setDiffEditor(editor)
  }

  useEffect(() => {
    initEditor()
    return () => {
      if (diffEditor) diffEditor.dispose()
    }
  }, [])

  useEffect(() => {
    if (diffEditor) {
      diffEditor.updateOptions({
        renderSideBySide: !inlineView,
      })
    }
  }, [inlineView])

  return (
    <div className="flex h-screen flex-col">
      <header className="flex h-16 flex-shrink-0 items-center space-x-5 border-b px-3 dark:border-neutral-800">
        <label className="flex items-center space-x-1">
          <input
            type="checkbox"
            checked={inlineView}
            onChange={(e) => setInlineView(e.target.checked)}
          />
          <span>Inline diffspan>
        label>
      header>
      <div ref={editorContainer} className="h-full">div>
    div>
  )
}

上述代码很简单,可能有同学对 createModel 方法比较疑惑,为什么是 Model ?好比 Monaco Editor 是一个容器,容器可以设置 Model、切换 Model,比如 vscode 中,每打开一个文件就是一个 Model,文件切换就是切换 model,每个文件都有状态,比如光标位置,历史记录等,这些状态都存在 model 中,这样就不会因为文件切换而状态混淆。

// typescript 禁用类型检查
monaco.languages.typescript.typescriptDefaults.setDiagnosticsOptions({
  noSemanticValidation: true,
  noSyntaxValidation: false,
})

// typescript jsx 格式使用 React 语法解析
monaco.languages.typescript.typescriptDefaults.setCompilerOptions({
  jsx: monaco.languages.typescript.JsxEmit.React,
})

对与一些 typescript 的语法校验我们可以选择关闭,jsx 不支持,可以设置为 react 语法支持。

最后

最后我的工具网站也开源了,包含一些前端常用工具,还可以在线刷面试题。

如果对你有帮助,可以随手点个赞,这对我真的很重要。

以上就是本文全部内容,希望这篇文章对大家有所帮助,也可以参考我往期的文章或者在评论区交流你的想法和心得,欢迎一起探索前端。

相关文章

AI机器人的崛起和应用探究

AI机器人的崛起和应用探究

  随着科技的不断进步,智能机器人已经成为时代的一部分。AI机器人是一种可编程的智能机器人,能够通过模拟人类的行为、感官和思维等方面的活动,完成人类所需的工作和任务。在未来,...

AI智能小助手:提升生活品质的未来伴侣

AI智能小助手:提升生活品质的未来伴侣

  随着科技的飞速发展,人工智能(AI)已经成为现代社会的重要组成部分。在各个领域中,AI智能小助手越来越受欢迎,为我们的生活带来了许多便利和创新。作为一种强大的工具,AI智...

百度天工:人工智能的引领者与探索者

百度天工:人工智能的引领者与探索者

  近年来,人工智能技术以其强大的学习和推理能力赢得了广泛关注和应用。在这个领域的先驱者和探索者之一,就是中国科技巨头百度旗下的“百度天工”(Baidu Research...

免费部署一个“土味情话”生成网站

前言“你喜欢什么面?”——“你的心里面”“来者何人” ——“你的人”像上面的这种听起来又肉麻又害羞又有点儿乡土感觉的小情话,就是土味情话啦。 作为程序员肯定想不出这些肉麻的话,如不做个土味情话生成器,...

无线智能家居:探索现代化生活的方向

无线智能家居:探索现代化生活的方向

  随着科技的快速发展,无线智能家居正逐渐进入人们的生活。从智能音箱到智能灯光系统,从智能锁到智能温控器,这些智能设备不仅使我们的生活更加便利舒适,还为我们带来了全新的生活体...

使用AI检测技术的重要性及应用领域探索

使用AI检测技术的重要性及应用领域探索

  随着人工智能(AI)技术的快速发展,以AI检测为中心的应用逐渐成为社会各个领域的热点。AI检测利用计算机视觉和深度学习等算法,通过自动分析和理解图像、视频或声音等数据,从...

发表评论    

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。