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

sxkk20082年前知识分享268

前言

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

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机器人是一种智能化的机器人,在模拟人类思维,学习人类行为方面有着较强的优势。这...

使用 Web Speech API 和 ChatGPT API 开发一个智能语音机器人

前言随着 AI 的不断发展,我们前端工程师也可以开发出一个智能语音机器人,下面是我开发的一个简单示例,大家可以访问这个视频地址查看效果。原理首先说一下这个 demo 的实现原理和步骤我们使用 Web...

如何利用区块链赚钱?

如何利用区块链赚钱?

  区块链,作为一种新兴技术,已经在全球范围内引起了极大的关注。人们普遍认为,区块链不仅具有革命性的潜力,还能够为个人和企业带来巨大的收益。本文将探讨如何利用区块链赚钱的一些...

使用 React 和 Tailwind 创建阅读进度条

目录前言实现逻辑代码样式前言我们在上网的时候经常会看到一些优秀的博客顶部有个进度条,这个进度条有助于读者衡量阅读进度,我认为这个功能可以带来良好的用户体验,所以,应该将其添加到我个人博客上的文章中。那...

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

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

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

文本转语音如此简单

文本转语音如此简单

Your browser does not support the audio element.前言哈喽,大家好,我是Ai知识分享,这两天在研究文本转音的功能,有时候担心自己的普通话不标准,比方说要录...

发表评论    

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