如何配置Neovim实现与VS/VS Code一致的C# .NET开发格式化

你日常使用Visual Studio Professional 2019和VS Code进行C# .NET Framework及WPF XAML开发，现在想要尝试Neovim（尤其看重其undotree功能），同时需要保证所有编辑器的代码格式化规则完全一致。下面是具体的配置方案：

当前已有的编辑器配置 #

VS Code的settings.json #

{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "[csharp]": {
    "editor.defaultFormatter": "ms-dotnettools.csharp"
  },
  "[xml]": {
    "editor.defaultFormatter": "DotJoshJohnson.xml"
  }
}

Visual Studio 2019 #

使用默认C#格式化工具，快捷键为Ctrl+K, Ctrl+D

一、基础准备：插件管理器与配置文件位置 #

1. 插件管理器选择 #

选lazy.nvim，这是目前Neovim生态最流行、性能最优的插件管理器，Windows下安装简单易维护。

2. 配置文件位置 #

Windows系统中，Neovim的配置根目录为：%USERPROFILE%\AppData\Local\nvim
核心需要修改的文件：

• init.lua：Neovim的主配置入口
• 可选创建lua/plugins文件夹：拆分插件配置，提升可读性

二、核心插件安装与配置 #

1. 先安装lazy.nvim #

在init.lua开头添加以下代码，自动完成lazy.nvim的安装：

local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not vim.loop.fs_stat(lazypath) then
  vim.fn.system({
    "git",
    "clone",
    "--filter=blob:none",
    "https://github.com/folke/lazy.nvim.git",
    "--branch=stable",
    lazypath,
  })
end
vim.opt.rtp:prepend(lazypath)

-- 初始化lazy.nvim
require("lazy").setup({
  -- 插件列表写在这里
})

2. 核心插件配置 #

将以下插件加入lazy.nvim的setup列表，包含LSP、格式化、undotree等功能：

require("lazy").setup({
  -- 1. C# LSP支持：OmniSharp（官方LSP）
  {
    "neovim/nvim-lspconfig",
    config = function()
      local lspconfig = require("lspconfig")
      -- 配置OmniSharp，需先通过Chocolatey安装：choco install omnisharp -y
      lspconfig.omnisharp.setup({
        cmd = { "omnisharp" }, -- 已加入系统PATH可直接写，否则写全路径
        on_attach = function(client, bufnr)
          -- 保存时自动格式化
          vim.api.nvim_create_autocmd("BufWritePre", {
            buffer = bufnr,
            callback = function()
              vim.lsp.buf.format({ bufnr = bufnr })
            end,
          })
        end,
        settings = {
          OmniSharp = {
            FormattingOptions = {
              EnableEditorConfigSupport = true, -- 开启.editorconfig支持
            },
          },
        },
      })
    end,
  },

  -- 2. Undotree功能
  {
    "mbbill/undotree",
    keys = {
      { "<leader>u", "<cmd>UndotreeToggle<cr>", desc = "打开/关闭Undotree" },
    },
    config = function()
      vim.g.undotree_SetFocusWhenToggle = 1 -- 打开时自动聚焦到Undotree窗口
    end,
  },

  -- 3. XML/XAML格式化（配合dotnet-format）
  {
    "nvimtools/none-ls.nvim",
    dependencies = { "nvim-lua/plenary.nvim" },
    config = function()
      local null_ls = require("null-ls")
      -- 需先安装dotnet-format：dotnet tool install -g dotnet-format
      null_ls.setup({
        sources = {
          null_ls.builtins.formatting.dotnet_format.with({
            filetypes = { "xml", "xaml" },
          }),
        },
        on_attach = function(client, bufnr)
          -- 保存时自动格式化XML/XAML
          vim.api.nvim_create_autocmd("BufWritePre", {
            buffer = bufnr,
            callback = function()
              vim.lsp.buf.format({ bufnr = bufnr })
            end,
          })
        end,
      })
    end,
  },

  -- 可选：C#调试支持（按需添加）
  {
    "mfussenegger/nvim-dap",
    dependencies = { "rcarriga/nvim-dap-ui" },
    config = function()
      -- 调试配置可根据需求自行补充
    end,
  },
})

3. 全局基础配置 #

在init.lua中添加基础编辑器设置，对齐VS/VSCode的行为：

-- 缩进设置
vim.opt.expandtab = true -- 用空格代替制表符
vim.opt.shiftwidth = 4 -- 缩进宽度4
vim.opt.tabstop = 4 -- 制表符宽度4
vim.opt.autoindent = true -- 自动缩进
vim.opt.smartindent = true -- 智能缩进

-- 启用文件类型检测
vim.cmd("filetype plugin indent on")

三、跨编辑器格式化一致性核心：.editorconfig #

所有编辑器（VS2019、VSCode、Neovim）均支持.editorconfig，在项目根目录创建该文件，写入以下规则即可统一所有格式化行为：

# 标记为根配置，子目录无需重复设置
root = true

# 所有文件通用规则
[*]
charset = utf-8
end_of_line = crlf
insert_final_newline = true
trim_trailing_whitespace = true

# C#文件规则（对齐VS默认行为）
[*.cs]
indent_style = space
indent_size = 4
tab_width = 4
dotnet_sort_system_directives_first = true
dotnet_separate_import_directive_groups = false
csharp_indent_case_contents = true
csharp_indent_switch_labels = true
csharp_preserve_single_line_blocks = true
csharp_space_after_cast = false

# XML/XAML文件规则
[*.{xml,xaml}]
indent_style = space
indent_size = 2
tab_width = 2
xml_space_around_equal_signs_in_attributes = true
xml_keep_blank_lines = 1

四、具体问题解答 #

1. 配置Neovim用于C#开发需修改哪些文件？ #

• 主配置文件：%USERPROFILE%\AppData\Local\nvim\init.lua
• 可选拆分插件配置到%USERPROFILE%\AppData\Local\nvim\lua目录下的文件
• 项目根目录的.editorconfig文件

2. 这些配置文件的内容应如何编写？ #

参考上面给出的init.lua示例和.editorconfig规则，可根据个人习惯微调细节。

3. 需安装哪些插件以实现对应功能？ #

• LSP支持：nvim-lspconfig + OmniSharp（需单独通过Chocolatey安装）
• 代码格式化：none-ls.nvim（配合dotnet-format，需通过dotnet命令安装） + OmniSharp自带格式化
• C#专属功能：nvim-dap（调试）、undotree（历史撤销树）
• 插件管理器：lazy.nvim

4. 如何确保与VS Code和Visual Studio的格式化一致性？ #

核心是通过.editorconfig统一所有格式化规则，同时在各编辑器中开启支持：

• VS2019：默认已支持，无需额外配置
• VSCode：确保安装EditorConfig for VS Code插件（一般默认已预装）
• Neovim：在OmniSharp和none-ls的配置中开启.editorconfig支持（上述配置已包含）

内容的提问来源于stack exchange，提问作者Foad S. Farimani