git-conflict.nvim

https://user-images.githubusercontent.com/22454918/159362564-a66d8c23-f7dc-4d1d-8e88-c5c73a49047e.mov

一个用于在neovim中可视化和解决冲突的插件。 这个插件的灵感来自 conflict-marker.vim

状态

该插件正在积极开发中，通常应该能正常工作，但在使用过程中可能会遇到一些bug。

要求

• git
• nvim 0.7+

安装

-- packer.nvim
use {'akinsho/git-conflict.nvim', tag = "*", config = function()
  require('git-conflict').setup()
end}

-- lazy.nvim
{'akinsho/git-conflict.nvim', version = "*", config = true}

我建议使用包管理器的{tag|version}字段，这样只有在推送新标签时才会更新此插件的版本，因为main分支本身可能不稳定。

配置

{
  default_mappings = true, -- 禁用此插件创建的缓冲区本地映射
  default_commands = true, -- 禁用此插件创建的命令
  disable_diagnostics = false, -- 这将在冲突期间禁用缓冲区中的诊断
  list_opener = 'copen', -- 打开冲突列表的命令或函数
  highlights = { -- 它们必须有背景颜色，否则将使用默认颜色
    incoming = 'DiffAdd',
    current = 'DiffText',
  }
}

命令

• GitConflictChooseOurs — 选择当前更改。
• GitConflictChooseTheirs — 选择传入的更改。
• GitConflictChooseBoth — 选择两个更改。
• GitConflictChooseNone — 不选择任何更改。
• GitConflictNextConflict — 移动到下一个冲突。
• GitConflictPrevConflict — 移动到上一个冲突。
• GitConflictListQf — 将所有冲突添加到quickfix

列出冲突

你可以使用GitConflictListQf命令在quickfix列表中列出冲突

<img width="475" alt="Screen Shot 2022-03-27 at 12 03 43" src="https://yellow-cdn.veclightyear.com/835a84d5/2865e01d-8f98-414d-b201-f59e7a7376d3.png">

使用nvim-pqf显示的quickfix

自动命令

当此插件检测到冲突时，会触发一个名为GitConflictDetected的User自动命令。当冲突解决后，会触发另一个名为GitConflictResolved的命令。

这两个命令都可以用来在处理冲突时运行逻辑，例如：

vim.api.nvim_create_autocmd('User', {
  pattern = 'GitConflictDetected',
  callback = function()
    vim.notify('在 '..vim.fn.expand('<afile>')..' 中检测到冲突')
    vim.keymap.set('n', 'cww', function()
      engage.conflict_buster()
      create_buffer_local_mappings()
    end)
  end
})

映射

此插件在冲突文件中提供默认的缓冲区本地映射。这主要是因为通过全局映射无法仅将这些映射应用于相关缓冲区。但用户可以通过设置default_mappings = false来禁用这些映射，并创建如下所示的全局映射。 默认映射为：

• <kbd>c</kbd><kbd>o</kbd> — 选择我们的
• <kbd>c</kbd><kbd>t</kbd> — 选择他们的
• <kbd>c</kbd><kbd>b</kbd> — 选择两者
• <kbd>c</kbd><kbd>0</kbd> — 不选择
• <kbd>]</kbd><kbd>x</kbd> — 移动到上一个冲突
• <kbd>[</kbd><kbd>x</kbd> — 移动到下一个冲突

如果你不想使用这些，你可以指定自己的映射。

require'git-conflict'.setup {
  default_mappings = {
    ours = 'o',
    theirs = 't',
    none = '0',
    both = 'b',
    next = 'n',
    prev = 'p',
  },
}

或者，设置default_mappings = false并自行应用映射

<details><summary>手动映射示例</summary>

vim.keymap.set('n', 'co', '<Plug>(git-conflict-ours)')
vim.keymap.set('n', 'ct', '<Plug>(git-conflict-theirs)')
vim.keymap.set('n', 'cb', '<Plug>(git-conflict-both)')
vim.keymap.set('n', 'c0', '<Plug>(git-conflict-none)')
vim.keymap.set('n', '[x', '<Plug>(git-conflict-prev-conflict)')
vim.keymap.set('n', ']x', '<Plug>(git-conflict-next-conflict)')

</details>

API

此插件提供了一个API，可以提取它收集的一些数据用于其他目的。

<details><summary>conflict_count({bufnr})</summary>

    返回给定缓冲区中的冲突数量。
    

    参数：
	{bufnr} (number) 指定你想知道冲突数量的缓冲区（默认：当前缓冲区）。

    返回值：
	number: 冲突的数量。

</details>

问题

请阅读这个 — 这个插件的目的只是提供华丽的视觉效果和一些处理冲突解决的映射。 它不会扩展成为一个完整的git管理插件，已经有无数插件做这个了，这个插件不会成为其中之一。

功能请求

开源应该是协作的，如果你有想要添加的功能的想法，请提交PR而不是功能请求。