验证解决方案项目之间没有文件引用

Question

假设 .NET 解决方案中有两个项目：

Solution
    - Project1
    - Project2

我只想 Project References 从项目 2 到项目 1，例如：

<ItemGroup>
  <ProjectReference Include="Project1.csproj" />
</ItemGroup>

但有时开发人员会添加错误的 File References 而不是：

<ItemGroup>
  <Reference Include="Project1">
    <HintPath>path\to\Project1.dll</HintPath>
  </Reference>
</ItemGroup>

如何确定解决方案项目之间没有 File References？理想情况下它应该是构建错误，但实现它的最佳方法是什么？

Answer 1

你可以写一个简单的PowerShell

$path = "D:\temp\Solution1"
$extension = "csproj"


#-------------------

$projects = Get-ChildItem -Path $path -Recurse -Filter "*.$($extension)"

$projectsList = @()

# Create the project's solution list
foreach ($project in $projects)
{
    $projectsList += $project
}


foreach($project in $projectsList)
{   
    # Read the project xml
    [xml]$proj = [System.IO.File]::ReadAllText($project.FullName)

    # loop throught ItemGroup
    foreach($item in $proj.Project.ItemGroup)
    {

        # Looking for project reference
        $all = $projectsList | where {$_.Name -eq "$($item.Reference.Include).$($extension)"} 

        foreach($ref in $all)
        {
            Write-Warning "Find wrong reference for $($ref.Name) on $($project.Name)"
        }
    }

}

Answer 2

我找到了解决方案。可以添加 MSBuild 任务（目标）来检查所有解决方案项目的文件引用。必须将此任务添加到所有项目或添加到 Directory.Build.targets。这是目标：

<Project>
  <Target Name="BeforeBuild">
    <Message Text="Analyzing '$(MSBuildProjectFile)' for file references between solution projects...&#xA;" />

    <GetSolutionProjects Solution="$(MSBuildThisFileDirectory)\YourSolutionName.sln">
      <Output ItemName="Projects" TaskParameter="Output"/>
    </GetSolutionProjects>

    <PropertyGroup>
      <Expression>(@(Projects->'%(ProjectName)', '|')).dll</Expression>
    </PropertyGroup>

    <XmlRead XmlFileName="$(MSBuildProjectFile)" XPath="//Project/ItemGroup/Reference/HintPath">
      <Output ItemName="FileReferences" TaskParameter="Value"/>
    </XmlRead>

    <RegexMatch Input="@(FileReferences)" Expression="$(Expression)">
      <Output TaskParameter="Output" ItemName ="ProjectReferences" />
    </RegexMatch>

    <Error Text="There must be no file references between solution projects, but it was found in '$(MSBuildProjectFile)' to the following file(s): %(ProjectReferences.Identity)"
           Condition="'%(ProjectReferences.Identity)' != ''" />
  </Target>
</Project>

此目标使用 MSBuild Community Tasks 因此不要忘记将此 NuGet 包添加到您的所有项目（或添加到 Directory.Build.props）。

验证解决方案项目之间没有文件引用

Verify there is no file references between solution projects

c#

.net

msbuild

solution