Aでは動くのにBでは動かないNeovimのデバッグ設定を見直した

local M = {}

M.markers = {
  ".vscode", "go.mod", "package.json", "tsconfig.json",
  "pyproject.toml", "requirements.txt", ".git",
  function(name)
    local extension = vim.fs.ext(name)
    return extension == "sln" or extension == "slnx" or extension == "csproj"
  end,
}

local function buffer_path(bufnr)
  local name = vim.api.nvim_buf_get_name(bufnr or 0)
  return name ~= "" and vim.fs.dirname(name) or vim.uv.cwd()
end

function M.root(bufnr)
  return vim.fs.root(buffer_path(bufnr), M.markers) or vim.uv.cwd()
end

function M.use_root(bufnr)
  local root = M.root(bufnr)
  if root ~= vim.fn.getcwd() then
    vim.cmd("lcd " .. vim.fn.fnameescape(root))
  end
  return root
end

function M.dotnet_project(bufnr)
  local project_root = vim.fs.root(buffer_path(bufnr), function(name)
    return vim.fs.ext(name) == "csproj"
  end)
  local projects = project_root
    and vim.fn.glob(vim.fs.joinpath(project_root, "*.csproj"), false, true)
    or {}
  table.sort(projects)
  return projects[1]
end

function M.dotnet_target(bufnr)
  local project = M.dotnet_project(bufnr)
  if not project or vim.fn.executable("dotnet") ~= 1 then
    return nil
  end
  local output = vim.fn.system({
    "dotnet", "msbuild", project, "-nologo",
    "-getProperty:TargetPath", "--property:Configuration=Debug",
  })
  if vim.v.shell_error ~= 0 then
    return nil
  end
  local decoder = vim.json and vim.json.decode or vim.fn.json_decode
  local ok, data = pcall(decoder, output)
  local target = ok and data and data.Properties and data.Properties.TargetPath
  if type(target) == "string" and target ~= "" then
    return target
  end
  local plain_target = vim.trim(output)
  return plain_target:match("%.dll$") and plain_target or nil
end

return M

C#のコンソールアプリでは、ブレークポイントで止めて標準入力を与えながら値を確認します。API開発でも、リクエストを送って処理の途中で止める使い方をします。

問題は、デバッグするDLLの場所です。プロジェクト名、ターゲットフレームワーク、絶対パスを設定へ書くと、その一つのプロジェクトでしか動きません。

現在は、開いているC#ファイルから上へたどり、近いcsprojを候補にします。同じディレクトリに複数あれば、今の設定ではファイル名順で先頭を選びます。そのうえでMSBuildへTargetPathを問い合わせます。ライブラリの中を開いている時は、近いプロジェクトが実行対象とは限りません。その時は選択UIかプロジェクト側の設定が必要です。

local function nearest_csproj(path)
  local directory = vim.fs.root(path, function(name)
    return vim.fs.ext(name) == "csproj"
  end)
  local projects = directory
    and vim.fn.glob(vim.fs.joinpath(directory, "*.csproj"), false, true)
    or {}
  table.sort(projects)
  return projects[1]
end

local project = nearest_csproj(vim.api.nvim_buf_get_name(0))
if not project then
  error("現在のファイルからcsprojを見つけられません")
end

local output = vim.fn.system({
  "dotnet",
  "msbuild",
  project,
  "-nologo",
  "-getProperty:TargetPath",
  "--property:Configuration=Debug",
})

MicrosoftのMSBuildコマンドラインリファレンスでは、-getPropertyで評価後のプロパティ値を取得できます。この問い合わせだけではビルドされません。実際の設定では、コマンドの終了コードを確認し、出力が単一の値なら前後の空白と改行を除いてDLLのパスとして扱います。ただし、返ってきたパスのファイル存在までは確認していません。ここでは、固定のDLLパスをやめた部分だけを載せました。

既定のC#デバッグ構成にはpreLaunchTask = "dotnet: build"を付けています。F5でこの構成を使い、信頼したtasks.jsonに同名のタスクがある場合はそのタスクを実行します。タスクがない場合、作業ルート直下に*.csprojか*.slnがあればdotnet buildを実行し、成功後にNetCoreDbgへ進みます。どちらもないルートでは既定ビルドをせずに進むため、全プロジェクトで自動ビルドされるわけではありません。なお、tasks.jsonのタスクがisBackgroundなら、今の設定は起動から3秒待ってデバッグへ進み、タスクの成功までは確認しません。事前タスクの出力は<leader>doで再表示できます。コンソールはintegratedTerminalにし、標準入力を受け取れるようにしています。

複数のcsprojを持つ検証用ソリューションも作り、深いディレクトリのC#ファイルから候補を検出できることを確認しました。実際に.NET 10でビルドし、生成されたApp.dllをMSBuildのTargetPathから取得できました。複数候補のうちどれを選ぶかはプロジェクト構成に依存するため、実運用では選択UIや明示設定を加える余地があります。

debugpyを起動するPythonと、対象アプリを実行するPythonは同じとは限りません。nvim-dap-pythonの公式READMEにも、debugpy用の環境とプロジェクトの仮想環境は分けられるとあります。

プロジェクト側のPythonは次の順で探します。

1. VIRTUAL_ENV
2. プロジェクト直下の.venv、venv、env、.env
3. PATH上のpython3またはpython

WindowsはScripts/python.exe、WSL2はbin/pythonです。ここを一つの固定パスへすると、仮想環境名やOSが変わっただけでデバッグ対象の依存パッケージを読み込めなくなります。

Goはnvim-dap-goとDelveを使います。nvim-dap-goの公式READMEには、現在のファイル、パッケージ、テスト、実行中プロセスへの接続などの構成があります。

普通のAPIや処理はF5から起動します。一方、ターミナルUIのように/dev/ttyを直接使うアプリは、通常のヘッドレスなDelveでは入力がうまく渡りません。そのため<leader>dTだけは、Neovimの下部ターミナルでDelveを起動してからDAPで接続します。

/dev/ttyはWindowsにはないため、この操作はWSL2専用です。Windowsでは無理に互換処理を入れず、警告を出して止めます。すべてを共通化するのではなく、OS固有の機能を一か所へ隔離しました。

TypeScriptはjs-debug-adapterとNode.jsを使います。単純な一枚ファイルなら、現在のNode.jsが持つ型除去機能でそのまま起動できます。

ただしNode.jsのTypeScript公式ドキュメントでは、組み込みの型除去はtsconfig.jsonを読まず、パスエイリアスやJavaScript生成が必要な構文には対応しないと説明されています。

そのため、この設定は小さなスクリプトの確認用です。フレームワークやビルド手順を持つ実プロジェクトでは、プロジェクト側の.vscode/launch.jsonを使います。