Posted at

VisualStudioで項目テンプレートを作成する+プロジェクトのプロパティを使う

More than 1 year has passed since last update.


この記事でやること

項目テンプレートの中でcsprojファイルにあるプロパティを使用する方法として↓を順にやる。


  • 項目テンプレートを作成する

  • VSIXを作成する

  • ウィザードを作成する

  • 項目テンプレートを修正する


前提

必要なものは2つ。


Visual Studio SDK

VisualStudioの拡張機能を作成するためのSDK (以下、VSSDK)。テンプレートだけでなく、Visual Studio のメニューを増やしたりすることもできる。

Visual Studio の Installer から選択してインストールしておく。

個別のコンポーネントからも可。

VSSDKの使い道は↓が参考になる。

http://tech.tanaka733.net/entry/how-to-find-how-to-develop-vs-sdk


項目テンプレートとVSIX

テンプレートを作成し、拡張機能として「ツール」メニューからインストールできるようにする。


項目テンプレートの作成

C#プロジェクトから、Extensibilityのカテゴリに「C# Item Template」があるので選んでプロジェクトを作成する。


AppliesToをわすれない

↓のようにプロジェクトが生成される。C#のプロジェクト内で項目を追加できるようにしたい場合は、<AppliesTo>タグを追加してCSharpに指定する。最初の生成時にはないので注意。

<ProjectItem>として最初はClass.csが生成される。ReplaceParameter=trueとなっているように、パラメータの置換ができる。

使えるパラメータ名には\$itemname\$などあるが、項目テンプレートでは\$projectname\$など使えないものもある。

使えないので仕方なく以降でウィザードをつくる。

カスタムパラメータを使うと自分で置換する組をつくれる。


ProjectItemはコンテンツにする

Class.csをProjectItemにしたいときは、ビルドアクションを「コンパイル」から「コンテンツ」にする。(xamlなどでも同じ)

忘れると、\$\$がついたパラメータのままコンパイルされてエラーがたくさん。


VSIXの作成

ただテンプレートを作るだけだとzipを適当な場所に置くことになるが、VSIXをつくっておくと、拡張機能としてインストールとか更新ができるので便利。

ここでは、さっき作成した項目テンプレートのソリューションに新しいプロジェクトを追加する。

VSIX Projectを追加したら↓みたいになる。


VSIX Projectを作ったら、テンプレートを追加

生成された「source.extension.vsixmanifest」を選んで↓の1~6の順でItemTemplate1を選ぶとVSIXにテンプレートを追加する。

VSIXをスタートアップ設定してF5でデバッグ実行すると、実験用のVSが立ち上がって拡張機能が追加されているので、項目テンプレートを試しに使ってみることも可。


プロジェクトファイルの情報を使うために

そのままだと使えるパラメータが少ないので、ウィザードを経由して使えるパラメータを増やす。


ウィザードの作成

https://msdn.microsoft.com/ja-jp/library/ms185301.aspx


テンプレートウィザードはdllを作る

ウィザードはクラスライブラリ(.dll)として作成する。パラメータをユーザが指定するようにしたければ、画面を作ってもよい。(が、パラメータを使いたいだけなので今回はパス。)


IWizardを継承したエントリクラスを作る

IWizardを使うために、クラスライブラリにNuGetでVSSDK.TemplateWizardInterfaceを追加する。参照を右クリック、NuGetパッケージの管理から↓の画面に。

「Microsoft.VisualStudio.TemplateWizard.IWizard」を継承したクラスをつくる。

using EnvDTE;

using Microsoft.VisualStudio.TemplateWizard;

namespace ClassLibrary1
{
public class Class1 : Microsoft.VisualStudio.TemplateWizard.IWizard
{
public void BeforeOpeningFile(ProjectItem projectItem) { }

public void ProjectFinishedGenerating(Project project) { }

public void ProjectItemFinishedGenerating(ProjectItem projectItem) { }

public void RunFinished() { }

public void RunStarted(object automationObject, Dictionary<string, string> replacementsDictionary, WizardRunKind runKind, object[] customParams)
{
// ここに処理とか画面出したりとかを書く
}

public bool ShouldAddProjectItem(string filePath) => true; // 無条件でProjectItemを生成する
}
}


プロジェクトのプロパティをとってくる

automationObjectを使って選択中のプロジェクトを探してプロパティを使えるようにするコードを書く。

public void RunStarted(object automationObject, Dictionary<string, string> replacementsDictionary, WizardRunKind runKind, object[] customParams)

{
// 選択中のプロジェクトはActiveSolutionProjectsの配列の先頭にある
var dte = (EnvDTE._DTE)automationObject;
var array = dte.ActiveSolutionProjects as Array;
var project = array.GetValue(0) as EnvDTE.Project;

// プロジェクトのプロパティをテンプレートで使えるように、置換リストに追加する
foreach(Property prop in project.Properties)
{
try
{
replacementsDictionary.Add($"${prop.Name}$", prop.Value.ToString());
}
catch (Exception) { }
}
}

カスタムテンプレートの辞書に追加したので、項目テンプレートから各パラメータを使用可能になる。


ウィザードを使うにはアセンブリに署名が必要

クラスライブラリのプロパティから署名を作成します。

key.snkが生成されます。ここから、アセンブリの読み込みに必要なパブリックトークンを確認する。(ここ面倒)

参考:「メモ: dllファイルのPublicKeyTokenの確認方法」

http://d.hatena.ne.jp/torazuka/20131121/sn

開発者用コマンドプロンプトを開き、sn.exe -T <dllのパス>を使う。

↓のようにトークンが表示される。あとで使うのでメモしておく。

Microsoft(R) .NET Framework Strong Name Utility バージョン 4.0.30319.0

Copyright (c) Microsoft Corporation. All rights reserved.

公開キー トークン 7e8b2aa4e85d22d3


ウィザードを作成したら、VSIXに追加

ウィザードが完成したら、今度はAssemblyを選んでVSIXのAssetsに追加する。dllがVSIX内に配置されるようになる。


項目テンプレートからウィザードが動くようにする

ItemTemplate1.vstemplateを開いてWizardExtensionを追加する。

<?xml version="1.0" encoding="utf-8"?>

<VSTemplate Version="3.0.0" Type="Item" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" xmlns:sdk="http://schemas.microsoft.com/developer/vstemplate-sdkextension/2010">
<TemplateData>
<Name>ItemTemplate1</Name>
~省略~
</TemplateData>
<TemplateContent>
~省略~
<ProjectItem ReplaceParameters="true">Class.cs</ProjectItem>
</TemplateContent>
<WizardExtension>
<!-- アセンブリ名とバージョン、言語、確認したトークンを入れる -->
<Assembly>ClassLibrary1, Version=1.0.0.0, Culture=Neutral, PublicKeyToken=7e8b2aa4e85d22d3</Assembly>
<!-- IWizardを継承したエントリクラスを名前空間込みで入れる -->
<FullClassName>ClassLibrary1.Class1</FullClassName>
</WizardExtension>
</VSTemplate>