Skip to content

Commit

Permalink
Merge pull request #59 from kzu/dev
Browse files Browse the repository at this point in the history 
Simplify package file kind by removing doc/symbols concepts
  • Loading branch information
@kzu
kzu authored Nov 8, 2016
2 parents 948afa4 + adb745a commit 097fe56
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 32 deletions.
11 changes: 2 additions & 9 deletions src/Build/NuGet.Build.Packaging.Tasks/NuGet.Build.Packaging.props
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,6 @@ Copyright (c) .NET Foundation. All rights reserved.
<ItemGroup>
<!-- Default mapping between %(PackageFile.Kind) metadata and package folders inside .nupkg -->
<!-- PackageFolder should map to a supported folder as defined in PackagingConstants.Folders -->
<PackageItemKind Include="Library">
<PackageFolder>lib</PackageFolder>
</PackageItemKind>
<PackageItemKind Include="Symbols">
<PackageFolder>lib</PackageFolder>
</PackageItemKind>
<PackageItemKind Include="Doc">
<PackageFolder>lib</PackageFolder>
</PackageItemKind>
<PackageItemKind Include="Content">
<!-- Plain "content" is deprecated as of NuGet v3+ -->
<PackageFolder>contentFiles</PackageFolder>
Expand Down Expand Up @@ -124,6 +115,8 @@ Copyright (c) .NET Foundation. All rights reserved.
</ItemGroup>

<PropertyGroup>
<!-- Flag this project as having been "nugetized" -->
<IsNuGetized>true</IsNuGetized>
<NuGetBuildPackagingPropsImported>true</NuGetBuildPackagingPropsImported>
</PropertyGroup>

Expand Down
32 changes: 18 additions & 14 deletions src/Build/NuGet.Build.Packaging.Tasks/NuGet.Build.Packaging.targets
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ Copyright (c) .NET Foundation. All rights reserved.
<Import Project="NuGet.Build.Packaging.props" Condition="'$(NuGetBuildPackagingPropsImported)' == ''" />

<PropertyGroup>
<!-- The Kind of primary output (build, symbols and doc) set if IncludeOutputsInPackage = true -->
<PrimaryOutputPackageFileKind Condition="'$(PrimaryOutputPackageFileKind)' == ''">Lib</PrimaryOutputPackageFileKind>

<!-- Infer PackageRererence elements from packages.config/project.json files in the project -->
<InferLegacyPackageReferences Condition="'$(InferLegacyPackageReferences)' == ''">true</InferLegacyPackageReferences>
<!-- Whether to include @(Content) items in the package -->
Expand Down Expand Up @@ -49,12 +52,16 @@ Copyright (c) .NET Foundation. All rights reserved.

<ItemGroup>
<ProjectCapability Include="Packable" Condition="'$(IsPackable)' == 'true'"/>

<!-- Converts potentially multiple $(ReferenceAssemblyFrameworks) into @(ReferenceAssemblyFramework) -->
<ReferenceAssemblyFramework Include="$(ReferenceAssemblyFrameworks)" Condition="'$(ReferenceAssemblyFrameworks)' != ''" />
</ItemGroup>

<!-- Extends the built-in GetTargetPath output to signal that the project has been nugetized -->
<ItemDefinitionGroup>
<TargetPathWithTargetPlatformMoniker>
<IsPackable>$(IsPackable)</IsPackable>
<IsNuGetized>$(IsNuGetized)</IsNuGetized>
</TargetPathWithTargetPlatformMoniker>
</ItemDefinitionGroup>

Expand Down Expand Up @@ -216,7 +223,7 @@ Copyright (c) .NET Foundation. All rights reserved.
<PackageFile Include="@(BuiltProjectOutputGroupOutput -> '%(FinalOutputPath)')"
Condition="'$(IncludeOutputsInPackage)' == 'true' and '$(IsPackagingProject)' != 'true'">
<!-- Packaging projects don't contribute primary output -->
<Kind>Lib</Kind>
<Kind>$(PrimaryOutputPackageFileKind)</Kind>
</PackageFile>

<!-- Remove when https://github.com/Microsoft/msbuild/pull/1076 ships -->
Expand All @@ -227,20 +234,20 @@ Copyright (c) .NET Foundation. All rights reserved.
<PackageFile Include="@(_DocumentationProjectOutputGroupOutput -> '%(FinalOutputPath)')"
Condition="'$(IncludeOutputsInPackage)' == 'true' and '$(IsPackagingProject)' != 'true'">
<!-- Packaging projects don't contribute primary docs -->
<Kind>Doc</Kind>
<Kind>$(PrimaryOutputPackageFileKind)</Kind>
</PackageFile>

<PackageFile Include="@(DebugSymbolsProjectOutputGroupOutput -> '%(FinalOutputPath)')"
Condition="'$(IncludeOutputsInPackage)' == 'true' and '$(IncludeSymbolsInPackage)' == 'true' and '$(IsPackagingProject)' != 'true'">
<!-- Packaging projects don't contribute primary symbols -->
<Kind>Symbols</Kind>
<Kind>$(PrimaryOutputPackageFileKind)</Kind>
</PackageFile>

<!-- Change to %(FinalOutputPath) when https://github.com/Microsoft/msbuild/pull/1115 ships -->
<PackageFile Include="@(SatelliteDllsProjectOutputGroupOutput -> '%(FullPath)')"
Condition="'$(IncludeOutputsInPackage)' == 'true' and '$(IsPackagingProject)' != 'true'">
<!-- Packaging projects don't contribute satellite dlls -->
<Kind>Lib</Kind>
<Kind>$(PrimaryOutputPackageFileKind)</Kind>
</PackageFile>

<!-- NOTE: Content is opt-out (must have IncludeInPackage=false to exclude) -->
Expand Down Expand Up @@ -279,6 +286,7 @@ Copyright (c) .NET Foundation. All rights reserved.
<ItemGroup>
<PackageFile>
<PackageId>$(PackageId)</PackageId>
<Platform>$(Platform)</Platform>
<TargetFrameworkMoniker Condition="'$(IsPackagingProject)' != 'true'">$(TargetFrameworkMoniker)</TargetFrameworkMoniker>
</PackageFile>
</ItemGroup>
Expand Down Expand Up @@ -325,9 +333,7 @@ Copyright (c) .NET Foundation. All rights reserved.
<!-- Clear the target framework since it trumps the TFM in AsignPackagePath now -->
<!-- Only do this for Library assets that come from project references that don't build nugets (PackageId=='' above) -->
<TargetFramework Condition="'%(_ReferencedPackageContentWithOriginalValues.Kind)' == 'Lib' or
'%(_ReferencedPackageContentWithOriginalValues.Kind)' == 'Library' or
'%(_ReferencedPackageContentWithOriginalValues.Kind)' == 'Symbols' or
'%(_ReferencedPackageContentWithOriginalValues.Kind)' == 'Doc'"></TargetFramework>
'%(_ReferencedPackageContentWithOriginalValues.Kind)' == 'Lib'"></TargetFramework>
<!-- NOTE: we're always overwriting the TFM in this case since
this item will end up making up the contents of this package
project in its current TFM configuration.
Expand All @@ -346,9 +352,7 @@ Copyright (c) .NET Foundation. All rights reserved.
<!-- Clear the target framework since it trumps the TFM in AsignPackagePath now -->
<!-- Only do this for Library assets that come from project references that don't build nugets (PackageId=='' above) -->
<TargetFramework Condition="'%(_ReferencedPackageContentWithOriginalValues.Kind)' == 'Lib' or
'%(_ReferencedPackageContentWithOriginalValues.Kind)' == 'Library' or
'%(_ReferencedPackageContentWithOriginalValues.Kind)' == 'Symbols' or
'%(_ReferencedPackageContentWithOriginalValues.Kind)' == 'Doc'"></TargetFramework>
'%(_ReferencedPackageContentWithOriginalValues.Kind)' == 'Lib'"></TargetFramework>
<TargetFrameworkMoniker>%(OriginalTargetFrameworkMoniker)</TargetFrameworkMoniker>
</_ReferencedPackageContentWithOriginalValues>
</ItemGroup>
Expand Down Expand Up @@ -468,7 +472,7 @@ Copyright (c) .NET Foundation. All rights reserved.

<ItemGroup>
<PackageFile Include="@(_ReferencedProjectDebugSymbols -> '%(FinalOutputPath)')">
<Kind>Symbols</Kind>
<Kind>Lib</Kind>
<TargetFrameworkMoniker Condition="'$(IsPackagingProject)' == 'true'">$(_ReferencedProjectTFM)</TargetFrameworkMoniker>
</PackageFile>
</ItemGroup>
Expand All @@ -485,7 +489,7 @@ Copyright (c) .NET Foundation. All rights reserved.
<ItemGroup>
<PackageFile Include="@(_ReferencedProjectOutputDependencySymbols -> '%(FullPath)')"
Condition="'%(_ReferencedProjectOutputDependencySymbols.CopyLocal)' == 'true'">
<Kind>Symbols</Kind>
<Kind>Lib</Kind>
<TargetFrameworkMoniker Condition="'$(IsPackagingProject)' == 'true'">$(_ReferencedProjectTFM)</TargetFrameworkMoniker>
</PackageFile>
</ItemGroup>
Expand All @@ -508,7 +512,7 @@ Copyright (c) .NET Foundation. All rights reserved.
<FinalFullOutputPath Condition="$([System.IO.Path]::IsPathRooted('%(_ReferencedProjectDocumentation.FinalOutputPath)')) == 'false'">$([System.IO.Path]::GetDirectoryName('%(_ReferencedProjectDocumentation.MSBuildSourceProjectFile)'))\%(_ReferencedProjectDocumentation.FinalOutputPath)</FinalFullOutputPath>
</_ReferencedProjectDocumentationFullPath>
<PackageFile Include="@(_ReferencedProjectDocumentationFullPath -> '%(FinalFullOutputPath)')">
<Kind>Doc</Kind>
<Kind>Lib</Kind>
<TargetFrameworkMoniker Condition="'$(IsPackagingProject)' == 'true'">$(_ReferencedProjectTFM)</TargetFrameworkMoniker>
</PackageFile>
</ItemGroup>
Expand All @@ -524,7 +528,7 @@ Copyright (c) .NET Foundation. All rights reserved.
<ItemGroup Condition="'@(_ReferencedProjectDocumentationDependency)' != ''">
<PackageFile Include="@(_ReferencedProjectDocumentationDependency -> '%(FullPath)')"
Condition="'%(_ReferencedProjectDocumentationDependency.CopyLocal)' == 'true'">
<Kind>Doc</Kind>
<Kind>Lib</Kind>
<TargetFrameworkMoniker Condition="'$(IsPackagingProject)' == 'true'">$(_ReferencedProjectTFM)</TargetFrameworkMoniker>
</PackageFile>
</ItemGroup>
Expand Down
4 changes: 2 additions & 2 deletions src/Build/NuGet.Build.Packaging.Tests/given_a_complex_pack.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -144,14 +144,14 @@ public void when_preparing_d_without_package_id_then_does_not_set_package_path()
{
Filename = "d",
Extension = ".dll",
Kind = "Lib",
Kind = PackageItemKind.Lib,
PackagePath = "",
}));
Assert.Contains(result.Items, item => item.Matches(new
{
Filename = "d",
Extension = ".xml",
Kind = "Doc",
Kind = PackageItemKind.Lib,
PackagePath = "",
}));
}
Expand Down
8 changes: 4 additions & 4 deletions src/Build/NuGet.Build.Packaging.Tests/given_a_library_with_project_reference.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ public void when_getting_package_contents_then_retrieves_main_assembly_transitiv
Assert.Equal(TargetResultCode.Success, result.ResultCode);

// TODO: build some helpers to make this easier to assert.
Assert.True(result.Items.Any(i => i.GetMetadata("FileName") == "a" && i.GetMetadata("Extension") == ".dll" && i.GetMetadata("Kind") == "Lib"), "Did not include main project output as Library");
Assert.True(result.Items.Any(i => i.GetMetadata("FileName") == "b" && i.GetMetadata("Extension") == ".dll" && i.GetMetadata("Kind") == "Lib"), "Did not include referenced project output as Library");
Assert.True(result.Items.Any(i => i.GetMetadata("FileName") == "a" && i.GetMetadata("Extension") == ".dll" && i.GetMetadata("Kind") == PackageItemKind.Lib), "Did not include main project output as Library");
Assert.True(result.Items.Any(i => i.GetMetadata("FileName") == "b" && i.GetMetadata("Extension") == ".dll" && i.GetMetadata("Kind") == PackageItemKind.Lib), "Did not include referenced project output as Library");
}


Expand All @@ -39,8 +39,8 @@ public void when_getting_package_contents_then_retrieves_symbols_transitively()
Assert.Equal(TargetResultCode.Success, result.ResultCode);

// TODO: build some helpers to make this easier to assert.
Assert.True(result.Items.Any(i => i.GetMetadata("FileName") == "a" && i.GetMetadata("Extension") == ".pdb" && i.GetMetadata("Kind") == "Symbols"), "Did not include main project symbols");
Assert.True(result.Items.Any(i => i.GetMetadata("FileName") == "b" && i.GetMetadata("Extension") == ".pdb" && i.GetMetadata("Kind") == "Symbols"), "Did not include referenced project symbols");
Assert.True(result.Items.Any(i => i.GetMetadata("FileName") == "a" && i.GetMetadata("Extension") == ".pdb" && i.GetMetadata("Kind") == PackageItemKind.Lib), "Did not include main project symbols");
Assert.True(result.Items.Any(i => i.GetMetadata("FileName") == "b" && i.GetMetadata("Extension") == ".pdb" && i.GetMetadata("Kind") == PackageItemKind.Lib), "Did not include referenced project symbols");
}

[Fact]
Expand Down
4 changes: 2 additions & 2 deletions src/Build/NuGet.Build.Packaging.Tests/given_an_empty_library_project.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ public void when_getting_package_contents_then_includes_xmldoc()
Assert.Contains(result.Items, item => item.Matches(new
{
Extension = ".xml",
Kind = "Doc",
Kind = PackageItemKind.Lib,
}));
}

Expand All @@ -111,7 +111,7 @@ public void when_include_output_in_package_is_false_then_does_not_include_xmldoc
Assert.DoesNotContain(result.Items, item => item.Matches(new
{
Extension = ".xml",
Kind = "Doc",
Kind = PackageItemKind.Lib,
}));
}

Expand Down
3 changes: 3 additions & 0 deletions src/VisualStudio/NuGet.Packaging.VisualStudio/Rules/general.browseobject.xaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,8 @@

<StringProperty Name="PackageId" DisplayName="Package ID" />
<StringProperty Name="Title" DisplayName="Title" />
<StringProperty Name="ReferenceAssemblyFrameworks"
DisplayName="Reference Assembly Frameworks"
Description="Generate a reference assembly for the given target framework by intersecting the APIs of all referenced projects." />

</Rule>
2 changes: 1 addition & 1 deletion src/VisualStudio/NuGet.Packaging.VisualStudio/source.extension.vsixmanifest
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<License>LICENSE.txt</License>
</Metadata>
<Installation>
<InstallationTarget Id="Microsoft.VisualStudio.Pro" Version="14.0" />
<InstallationTarget Id="Microsoft.VisualStudio.Pro" Version="[14.0,)" />
</Installation>
<Dependencies>
<!--<Dependency Id="Microsoft.Framework.NDP" DisplayName="Microsoft .NET Framework" d:Source="Manual" Version="4.6" />-->
Expand Down

0 comments on commit 097fe56

Please sign in to comment.