Automatically set Link metadata on items outside the project folder #1246

dsplaisted · 2017-05-24T01:06:00Z

Automatically add Link metadata for Compile, AdditionalFiles, None, Content, and EmbeddedResource items where:
- Link metadata is not already set, and
- The item’s FullPath is outside of the project directory
If setting the Link metadata automatically, the value will be set to %(LinkBase)\%(RecursiveDir)%(Filename)%(Extension). If LinkBase or RecursiveDir are not defined, then those pieces will be left out of the value. So <Compile Include="..\Shared\**\*.cs" LinkBase="Shared" /> would show the items under the "Shared" folder in solution explorer, instead of the root, and would preserve any heirarchy under the shared folder.
Allow opting out of automatically adding Link metadata by setting the SetLinkMetadataAutomatically property to false

nguerrera · 2017-05-24T03:58:37Z

src/Tasks/Microsoft.NET.Build.Tasks/build/Microsoft.NET.Sdk.DefaultItems.targets

@@ -102,6 +102,53 @@ Copyright (c) .NET Foundation. All rights reserved.
    <RuntimeFrameworkVersion Condition="'$(RuntimeFrameworkVersion)' == ''">$(_TargetFrameworkVersionWithoutV)</RuntimeFrameworkVersion>
  </PropertyGroup>

+  <ItemGroup Condition="'$(SetLinkMetadataAutomatically)' != 'false'">
+    <Compile Update="@(Compile)">
+      <Link Condition="'%(Link)' == '' And !$([System.IO.Path]::GetFullPath('%(FullPath)').StartsWith('$([System.IO.Path]::GetFullPath('$(MSBuildProjectDirectory)'))\'))">*NeedsLink*</Link>


Can this be separate NeedsLink=true metadata? The sentinel feels hacky.

Have you checked the perf of calling get full path this way on every item?

nguerrera · 2017-05-24T04:00:50Z

src/Tasks/Microsoft.NET.Build.Tasks/build/Microsoft.NET.Sdk.DefaultItems.targets

+      <Link Condition="'%(Link)' == '*NeedsLink*' And '%(RecursiveDir)' != '' And '%(LinkBase)' == ''">%(RecursiveDir)%(Filename)%(Extension)</Link>
+      <Link Condition="'%(Link)' == '*NeedsLink*' And '%(RecursiveDir)' != '' And '%(LinkBase)' != ''">%(LinkBase)\%(RecursiveDir)%(Filename)%(Extension)</Link>
+      <Link Condition="'%(Link)' == '*NeedsLink*' And '%(RecursiveDir)' == '' And '%(LinkBase)' == ''">%(Filename)%(Extension)</Link>
+      <Link Condition="'%(Link)' == '*NeedsLink*' And '%(RecursiveDir)' == '' And '%(LinkBase)' != ''">%(LinkBase)\%(Filename)%(Extension)</Link>


Can you just use %(RecursiveDir) without checking if it's empty. Seems it would evaluate to the right thing in both cases.

nguerrera · 2017-05-24T10:46:09Z

src/Tasks/Microsoft.NET.Build.Tasks/build/Microsoft.NET.Sdk.DefaultItems.targets

+      <Link Condition="'%(Link)' == '*NeedsLink*' And '%(RecursiveDir)' == '' And '%(LinkBase)' != ''">%(LinkBase)\%(Filename)%(Extension)</Link>
+    </EmbeddedResource >
+  </ItemGroup>
+


Shouldn't LinkBase work inside the project cone as well? I might want to display/copy in/to a different relative path.

…ndows

dsplaisted · 2017-05-24T20:46:06Z

@MattGertz for approval

Customer scenario

Including files (for compilation, copying to output, etc) that are outside of a project folder in a project. Without this change, those items will not be shown in Solution Explorer by default.

Bugs this fixes:

#1115

Workarounds, if any

Set Link metadata manually on items (this is very hard to figure out how to do if you're including items via a glob).

Risk

Low. This change will cause some items that were included via NuGet packages to show up in solution explorer where they weren't previously displayed. An analysis of packages on NuGet.org indicated that at most 43 packages would be affected by this.

Performance impact

Low.

Is this a regression from a previous update?

No

Root cause analysis:

n/a - This is more of a feature / improved experience than a bug

How was the bug found?

n/a

nguerrera · 2017-05-24T21:24:48Z

src/Tasks/Microsoft.NET.Build.Tasks/build/Microsoft.NET.Sdk.DefaultItems.targets

+      <Link Condition="'%(Link)' == '' And !$([MSBuild]::ValueOrDefault('%(FullPath)', '').StartsWith($([MSBuild]::EnsureTrailingSlash($(MSBuildProjectDirectory)))))">%(LinkBase)%(RecursiveDir)%(Filename)%(Extension)</Link>
+    </Content>
+
+    <EmbeddedResource Update="@(EmbeddedResource )">


whitespace: @(EmbeddedResource ) -> @(EmbeddedResource)

nguerrera · 2017-05-24T21:25:08Z

src/Tasks/Microsoft.NET.Build.Tasks/build/Microsoft.NET.Sdk.DefaultItems.targets

+    <EmbeddedResource Update="@(EmbeddedResource )">
+      <LinkBase Condition="'%(LinkBase)' != ''">$([MSBuild]::EnsureTrailingSlash(%(LinkBase)))</LinkBase>
+      <Link Condition="'%(Link)' == '' And !$([MSBuild]::ValueOrDefault('%(FullPath)', '').StartsWith($([MSBuild]::EnsureTrailingSlash($(MSBuildProjectDirectory)))))">%(LinkBase)%(RecursiveDir)%(Filename)%(Extension)</Link>
+    </EmbeddedResource >


whitespace:

@(EmbeddedResource ) -> @(EmbeddedResource)
</EmbeddedResource /> -> </EmbeddedResource>

dsplaisted · 2017-05-25T18:50:10Z

@nguerrera @livarcocc Can one of you sign off on this?

…130.4 (dotnet#1246) - Microsoft.DotNet.Arcade.Sdk - 5.0.0-beta.20080.4

dnfclas added the cla-already-signed label May 24, 2017

dsplaisted force-pushed the 1115-LinkBase branch from 9f12580 to 0961d23 Compare May 24, 2017 01:40

Automatically set Link metadata on items outside the project folder

0038c5a

dsplaisted force-pushed the 1115-LinkBase branch from 0961d23 to 0038c5a Compare May 24, 2017 02:32

nguerrera reviewed May 24, 2017

View reviewed changes

dsplaisted added 2 commits May 24, 2017 07:53

Fix test for whether items are inside the project directory on non-Wi…

5a88319

…ndows

Simplify conditions for automatically setting link metadata

1e87e64

dsplaisted requested review from livarcocc and davkean May 24, 2017 20:19

dsplaisted changed the base branch from master to release/2.0.0 May 24, 2017 20:37

dsplaisted added the Pending Shiproom Approval label May 24, 2017

MattGertz added Approved to merge and removed Pending Shiproom Approval labels May 24, 2017

nguerrera reviewed May 25, 2017

View reviewed changes

Fix whitespace

9c1e948

nguerrera approved these changes May 25, 2017

View reviewed changes

dsplaisted merged commit e321f3c into dotnet:release/2.0.0 May 25, 2017

This was referenced May 26, 2017

Including files outside the project cone don't show up in soln explorer dotnet/project-system#1233

Closed

Need support globs outside of the project cone #1115

Closed

This was referenced May 31, 2017

For projects using the .NET SDK, don't set link metadata on items added from outside the project folder as links dotnet/project-system#2335

Open

[WIP] Move NETFramework ns2.0 support into SDK #1273

Closed

nguerrera mentioned this pull request Jul 14, 2017

dotnet sdk 2.0 degrades shared projects experience in VS #1415

Closed

This was referenced Jul 20, 2017

dotnet SDK 2.0 preview 2 CLI is very slow or hangs fable-compiler/Fable#1042

Closed

Don't automatically set Link metadata for items coming from Shared Projects #1432

Merged

NightOwl888 mentioned this pull request Sep 11, 2017

Files that have a subfolder in LinkBase do not recognize DefineConstants #1575

Closed

dasMulli mentioned this pull request Dec 10, 2017

Allow CopyToOutputDirectory to have a custom destination path dotnet/msbuild#2795

Closed

dsplaisted mentioned this pull request Mar 2, 2018

Unmanaged DLLs of a nuget package show up in the root .csproj in vs2017 Solution Explorer dotnet/project-system#3302

Closed

singlis mentioned this pull request Apr 20, 2018

[REEF-1999] Add C# executalble project for two process bridge. apache/reef#1446

Closed

Styxxy mentioned this pull request Aug 22, 2018

Document LinkBase dotnet/docs#7191

Closed

vatsan-madhavan mentioned this pull request Feb 27, 2019

Automatic Link generation from LinkBase does not work for Page, Resource items #2697

Closed

gewarren mentioned this pull request Apr 28, 2020

Document publish output settings dotnet/docs#18145

Closed

mmitche pushed a commit to mmitche/sdk that referenced this pull request Jun 5, 2020

Update dependencies from https://github.com/dotnet/arcade build 20200…

a524f50

…130.4 (dotnet#1246) - Microsoft.DotNet.Arcade.Sdk - 5.0.0-beta.20080.4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automatically set Link metadata on items outside the project folder #1246

Automatically set Link metadata on items outside the project folder #1246

dsplaisted commented May 24, 2017

nguerrera May 24, 2017

nguerrera May 24, 2017

nguerrera May 24, 2017

nguerrera May 24, 2017

dsplaisted commented May 24, 2017

nguerrera May 24, 2017 •

edited

Loading

nguerrera May 24, 2017 •

edited

Loading

dsplaisted commented May 25, 2017

Automatically set Link metadata on items outside the project folder #1246

Automatically set Link metadata on items outside the project folder #1246

Conversation

dsplaisted commented May 24, 2017

nguerrera May 24, 2017

Choose a reason for hiding this comment

nguerrera May 24, 2017

Choose a reason for hiding this comment

nguerrera May 24, 2017

Choose a reason for hiding this comment

nguerrera May 24, 2017

Choose a reason for hiding this comment

dsplaisted commented May 24, 2017

nguerrera May 24, 2017 • edited Loading

Choose a reason for hiding this comment

nguerrera May 24, 2017 • edited Loading

Choose a reason for hiding this comment

dsplaisted commented May 25, 2017

nguerrera May 24, 2017 •

edited

Loading

nguerrera May 24, 2017 •

edited

Loading