如何在多项目 .vstemplate 中包含外部文件？

Question

我正在创建一个 VS2010 多项目模板，并尝试从 vstemplate 添加一个文件（.hgignore）到解决方案（而不是项目）。

我尝试了这个，但它不起作用：

< VSTemplate Version="3.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="ProjectGroup">

    < TemplateData>...< /TemplateData>

    < TemplateContent >

        < ProjectItem> .hgignore < /ProjectItem >

        < ProjectCollection >       

            < ProjectTemplateLink ProjectName="$safeprojectname$.xxx">....< /ProjectTemplateLink>
            < ProjectTemplateLink ProjectName="$safeprojectname$.xxx">....< /ProjectTemplateLink>

        < /ProjectCollection>

    < /TemplateContent>

< /VSTemplate>

非常感谢你

PS：我无法在编辑器中创建正确的 XML 标签，所以我不得不添加空格...

Answer 1

没有内置的方法可以做到这一点。但是，VSTemplate 向导引擎支持可扩展性模型，使您可以在解决方案/项目创建过程中运行自定义逻辑。您需要实现一个实现 IWizard 接口，然后在 .vstemplate 文件中添加WizardExtension 元素。

查看 Craig Skibo 在 此问题上的回答MSDN 论坛问题，了解有关通过 IWizard.RunFinished 方法使用 DTE 自动化 API 添加解决方案项的详细信息。

Answer 2

可以通过 IWizard 以编程方式执行此操作。

示例向导，从 VSIX 复制 Nuget.Config（通过“包含在 VSIX 中”属性包含）：

class AppCustomizationWizard : IWizard
{
    private const string NugetConfig = "Nuget.Config";

    private static string GetVsixFullPath(string filename)
    {
        var vsixDir = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
        if (string.IsNullOrEmpty(vsixDir))
        {
            return null;
        }

        return Path.Combine(
            vsixDir,
            filename
        );
    }

    private static void CopyNugetConfig(Dictionary<string, string> replacementsDictionary)
    {
        var solutionDir = replacementsDictionary["$solutiondirectory$"];
        var vsixNugetConfig = GetVsixFullPath(NugetConfig);
        if (solutionDir != null && vsixNugetConfig != null)
        {
            File.Copy(vsixNugetConfig, Path.Combine(solutionDir, NugetConfig));
        }
    }

    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)
    {
        XElement wizardInfo = XElement.Parse(replacementsDictionary["$wizarddata$"]);
        XNamespace defaultNamespace = wizardInfo.GetDefaultNamespace();
        string itemType = wizardInfo.Element(defaultNamespace + "Type").Value;

        if (itemType == "Application")
        {
            CopyNugetConfig(replacementsDictionary);
        }
    }

    public bool ShouldAddProjectItem(string filePath)
    {
        return true;
    }
}