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

sxkk20082年前知识分享252

前言

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

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绘画生成器 - 让机器也能成为艺术家

AI绘画生成器 - 让机器也能成为艺术家

  最近,一个名为“AI绘画生成器”的网站开始在社交媒体上走红。这个网站可以根据用户的输入,通过人工智能技术生成一幅艺术画作。这种新型的艺术创造方式引起了不少关注,因此我们有...

SVG + 动画 实现一个有个性的404页面

前言我们的博客网站有时候 404 页面比较普通,我们可以通过 SVG 加动画来实现一个有个性的页面效果代码片段实现在undraw网站下载喜欢的插画,下载格式为 svg将 svg 转为 HTML 网页观...

智能智慧系统:打造智能化社会和智慧行业

智能智慧系统:打造智能化社会和智慧行业

  智能智慧系统是利用人工智能技术开发的智能化管理系统的核心机构。通过集成各类传感器、数据分析技术和自动控制系统,实现对智能设备及系统的智能化管理和优化。在智能智慧系统,我们...

发表评论    

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