まず最初に成果物のリンクを。
VSCodeとMulti Targetingなプロジェクトの今
VSCode で Multi Targeting な Project を開くと、基本的には <TargetFrameworks></TargetFrameworks> に囲まれた先頭のTargetがコード補完などに使用するTargetに設定されます。
そのため、例えばmacOSで先頭が.NET Frameworkなプロジェクトを開くとコードが補完されない、もしくはOmniSharpが正常に動作しないといったことが起こります。 そのため取り入れられている解決手段としてTargetFrameworksの先頭に.netstandardなTargetを持ってくるといったものがあります。
例えばこんなPR
この様にまずはプロジェクトを開くことが出来るようにしようというのは全とっかえで済むことがわかっています。
では、そんな中なぜこの拡張を作ったのか、その理由などを次に述べます。
Targetを切り替えたくなるプロジェクト
最近クロスプラットフォーム開発フレームワークの MAUI がPreviewですがリリースされました。 MAUIについては詳しくは述べませんが、一つのプロジェクトでiOS, Android, macOS, Windows向けのアプリケーションが作れるものと認識してもらえれば。
このMAUIを採用するアプリケーションもMulti Targetingなプロジェクトとして作られるのですが、前述したように基本的には <TargetFrameworks></TargetFrameworks> に囲まれた先頭のTargetがコード補完などに使用されます。
これが何を意味するかと言うと、Platform非依存のInterfaceを定義して、Platform依存の実装を書く際にTargetFrameworksの先頭に対象のPlatformのTargetが書かれていないとコードの補完が行われず、PlatformのAPIをエスパーして書かなければならないということです。
流石にエスパーして書くわけにはいかないので、対象PlatformのTargetを先頭に持ってきたりするわけですが、そういった書き換えを自分で行うのは非常に手間がかかります。
そのためその書き換えに近いことを行うことを支援する拡張として TargetFrameworksSwitcher for C# が生まれました。
拡張機能が提供する機能
拡張機能名前そのままですが、TargetFrameworkを切り替えてくれます。
動作の様子は以下のGifを。
この様に拡張機能を使って定義されているTargetを指定すると、そのTargetのAPIなどが補完されるようになります。 上記のGifではMAUIのプロジェクトで利用したものですが、例えば
jwt/JWT.csproj at c871e2428c1587c237069c509a530635076d53bf · jwt-dotnet/jwt · GitHub
<TargetFrameworks>net35;net40;net46;netstandard1.3;netstandard2.0;net50</TargetFrameworks>
のように、先頭に.NET Frameworkが含まれるプロジェクトでも同様に動作します。
macOSやLinuxでこういったプロジェクトを開発する方にとっては割と便利な拡張なのでは？と思うので、是非とも使ってみてください。
以下どういう仕組なのか知りたい人向け
どの様に実現しているか
GitHub - yamachu/TargetFrameworksSwitcherForOmniSharp
実際のコアライブラリ
GitHub - yamachu/NodeCsprojModifier
上記のコアライブラリを見てもらえるとなんとなくわかると思うのでさらっと解説。
MSBuildのtargetファイルに明示的に<TargetFramework></TargetFramework>のプロパティを挿入し、そのtargetファイルをcsprojから読むようにして実現しています。
TargetFrameworkSwitcher.targets
<Project> <!-- NOTE: DO NOT EDIT YOURSELF You should add this file to gitignore --> <PropertyGroup> <TargetFramework>net6.0-maccatalyst</TargetFramework> </PropertyGroup> </Project>
Some.csproj
<Project Sdk="Microsoft.NET.Sdk.Razor"> + <!-- NOTE: TargetFrameworkSwitcher inserts it, DO NOT EDIT YOURSELF and IT REQUIRES TOP-LEVEL EVALUATION BEFORE USING "TargetFramework" VARIABLE --> + <Import Project="$(MSBuildProjectDirectory)\TargetFrameworkSwitcher.targets" Condition="Exists('$(MSBuildProjectDirectory)\TargetFrameworkSwitcher.targets')" /> +
これはMAUIプロジェクトで拡張機能を使って net6.0-maccatalyst をTargetFrameworkに指定した例です。 プロジェクトの先頭でtargetsをImportしTargetFrameworksの構成を変更せずTargetFrameworkを指定する、と言った方法で切り替えを実現しています。
NOTEとして書いているように、targetsファイルはあってもなくてもビルドは出来るというものにすることで、Visual Studioで開発している人とVSCodeで開発している人、拡張機能を入れている人と入れていない人でも問題ないようにしています（そのためどちらかと言うとlocalファイルないしuserファイルに近いのでignoreすべきと書いています）。
OmniSharp-Roslyn自体を拡張するのは非常に大変ですが、VSCodeの拡張機能で監視されているcsproj自体に作用してしまえば解決できると思ったこの課題、手法としては悪手ではなかったと思うので自分では満足しています。 使っていく中で見つけた更なる課題や、使ってくださった方からIssueが上がったらまた解消していこうと思います。
