如何使用 CodeSmith 工具将生成的文件添加到多个项目

Question

我在当前的项目中使用 CodeSmith，并试图解决一个问题。对于我的 CodeSmith 项目 (.csp)，我可以选择一个选项，让它自动将所有生成的文件添加到当前项目 (.csproj)。但我希望能够将输出添加到多个项目（.csproj）。 CodeSmith 内部是否有选项允许这样做？或者有没有一种好的方法可以通过编程来做到这一点？

谢谢。

Answer 1

我无法找到让 CodeSmith 自动处理此问题的方法，因此我最终在代码隐藏文件中编写了一个自定义方法来处理此问题。

一些注意事项：
- proj 文件是 XML，因此相当容易编辑，但保存项目中包含的文件列表的实际“ItemGroup”节点实际上并未以任何特殊方式进行标记。我最终选择了具有“Contains”子节点的“ItemGroup”节点，但可能有更好的方法来确定应该使用哪个。
- 我建议立即更改所有 proj 文件，而不是在创建/更新每个文件时进行更改。否则，如果您从 Visual Studio 启动生成，您可能会收到大量“此项目已更改，您想重新加载吗”
- 如果您的文件处于源代码管理之下（它们是，对吧？！），您将需要处理检出文件并将它们添加到源代码管理以及编辑项目文件。

这是（或多或少）我用来将文件添加到项目的代码：

/// <summary>
/// Adds the given file to the indicated project
/// </summary>
/// <param name="project">The path of the proj file</param>
/// <param name="projectSubDir">The subdirectory of the project that the 
/// file is located in, otherwise an empty string if it is at the project root</param>
/// <param name="file">The name of the file to be added to the project</param>
/// <param name="parent">The name of the parent to group the file to, an 
/// empty string if there is no parent file</param>
public static void AddFileToProject(string project, string projectSubDir, 
        string file, string parent)
{
    XDocument proj = XDocument.Load(project);

    XNamespace ns = "http://schemas.microsoft.com/developer/msbuild/2003";
    var itemGroup = proj.Descendants(ns + "ItemGroup").FirstOrDefault(x => x.Descendants(ns + "Compile").Count() > 0);

    if (itemGroup == null)
        throw new Exception(string.Format("Unable to find an ItemGroup to add the file {1} to the {0} project", project, file));

    //If the file is already listed, don't bother adding it again
    if(itemGroup.Descendants(ns + "Compile").Where(x=>x.Attribute("Include").Value.ToString() == file).Count() > 0)
        return; 

    XElement item = new XElement(ns + "Compile", 
                    new XAttribute("Include", Path.Combine(projectSubDir,file)));

    //This is used to group files together, in this case the file that is 
    //regenerated is grouped as a dependent of the user-editable file that
    //is not changed by the code generator
    if (string.IsNullOrEmpty(parent) == false)
        item.Add(new XElement(ns + "DependentUpon", parent));

    itemGroup.Add(item);

    proj.Save(project); 

}

Answer 2

您是否考虑过只编译成共享程序集 (DLL)，然后可供所有项目引用？

我知道这可能不适合您的要求，但我认为这将是实现所有项目都可以使用的单一源的最佳方法之一，并且只有一个代码库可以根据需要进行维护。