Add SDK package for generating global CLI tool shims #660
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <Project> | ||
| <PropertyGroup Condition="'$(DisableDefaultTargets)' != 'true'"> | ||
| <PrepareDependsOn>PreinstallBundledPackages;$(PrepareDependsOn)</PrepareDependsOn> | ||
| </PropertyGroup> | ||
|
|
||
| <!-- | ||
| This is a workaround for https://github.com/Microsoft/msbuild/issues/2914. | ||
| This pre-populates the NuGet cache with bundled packages. | ||
| --> | ||
| <Target Name="PreinstallBundledPackages"> | ||
| <MSBuild Targets="Restore" | ||
| Projects="$(MSBuildThisFileDirectory)BundledPackageRestorer.csproj" | ||
| Properties="RestoreSources=$(KoreBuildBundledPackageFolder)" /> | ||
| </Target> | ||
| </Project> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| <Project> | ||
|
|
||
| <Import Project="Sdk.props" Sdk="Microsoft.NET.Sdk" /> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>netcoreapp2.0</TargetFramework> | ||
| <NuspecFile>$(MSBuildThisFileDirectory)$(MSBuildProjectName).nuspec</NuspecFile> | ||
| <Serviceable>false</Serviceable> | ||
| <NoPackageAnalysis>true</NoPackageAnalysis> | ||
| <IncludeBuildOutput>false</IncludeBuildOutput> | ||
| <IncludeSource>false</IncludeSource> | ||
| <IncludeSymbols>false</IncludeSymbols> | ||
| </PropertyGroup> | ||
|
|
||
| <Target Name="SetPackageProperties" BeforeTargets="GenerateNuspec"> | ||
| <PropertyGroup> | ||
| <NuspecProperties>$(NuspecProperties);id=$(PackageId)</NuspecProperties> | ||
| <NuspecProperties>$(NuspecProperties);version=$(PackageVersion)</NuspecProperties> | ||
| <NuspecProperties>$(NuspecProperties);copyright=$(Copyright)</NuspecProperties> | ||
| </PropertyGroup> | ||
| </Target> | ||
|
|
||
| <Import Project="Sdk.targets" Sdk="Microsoft.NET.Sdk" /> | ||
|
|
||
| <Target Name="Compile" /> | ||
| <Target Name="CopyFilesToOutputDirectory" /> | ||
| </Project> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd"> | ||
| <metadata> | ||
| <id>$id$</id> | ||
| <version>$version$</version> | ||
| <authors>Microsoft</authors> | ||
| <requireLicenseAcceptance>false</requireLicenseAcceptance> | ||
| <description>Provides additional support to .NET Core teams producing global CLI tools. This package is only intended for internal Microsoft use.</description> | ||
| <copyright>$copyright$</copyright> | ||
| <packageTypes> | ||
| <!-- This project needs to be MSBuildSdk because its targets need to influence the way /t:Restore works --> | ||
| <packageType name="MSBuildSdk" /> | ||
|
There was a problem hiding this comment. Does Razor Sdk need one of these? There was a problem hiding this comment. Depends. Do you expect users to reference razor as a PackageReference or only as an Sdk? If you add this, UI tooling in VS for PackageReference will break. There was a problem hiding this comment. Preferably both. We use it as a PackageReference in other repos in aspnet There was a problem hiding this comment. If NuGet UI tooling wasn't a concern, I would say you should add this to your .nuspec <packageTypes>
<packageType name="Dependency" /> <!-- PackageReference usage -->
<packageType name="MSBuildSdk" /> <!-- Sdk usage -->
</packageTypes>But that might be dangerous because the NuGet team is thinking of breaking packages with multiple types. See NuGet/Home#6298 and NuGet/Home#6484 for context. |
||
| </packageTypes> | ||
| </metadata> | ||
| <files> | ||
| <file src="_._" target="lib/netstandard1.0/_._" /> | ||
| <file src="sdk\**\*" target="sdk/" /> | ||
| </files> | ||
| </package> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| Microsoft.DotNet.GlobalTools.Sdk | ||
| ================================ | ||
|
|
||
| Provides additional support to .NET Core teams producing global CLI tools. This package is only intended for internal Microsoft use. | ||
|
|
||
| ## Usage | ||
| Projects that need to bundle and sign the global CLI tool shim should add this to their .csproj file. This will include files in the .nupkg. | ||
|
|
||
| ```xml | ||
| <!-- In MyTool.csproj --> | ||
| <Project> | ||
| <Sdk Name="Microsoft.NET.Sdk" /> | ||
| <Sdk Name="Microsoft.DotNet.GlobalTools.Sdk" /> | ||
|
|
||
| <PropertyGroup> | ||
| <PackAsTool>true</PackAsTool> | ||
| <GenerateToolShims>true</GenerateToolShims> | ||
| </PropertyGroup> | ||
| </Project> | ||
| ``` | ||
|
|
||
| ```js | ||
| // in global.json | ||
| { | ||
| "msbuild-sdks": { | ||
| "Microsoft.DotNet.GlobalTools.Sdk": "2.1.0-rtm-12345" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Additional options | ||
|
|
||
| #### `GenerateToolShims` (property) | ||
|
|
||
| A boolean flag. When `true`, tool shims will be generated for each RID listed in `GeneratedShimRuntimeIdentifiers` and included in the .nupkg. | ||
|
|
||
| Default value = `false` | ||
|
|
||
| #### `GeneratedShimRuntimeIdentifiers` (property) | ||
|
|
||
| A semi-colon separate list of RIDs for which to generate and pack the shim. | ||
|
|
||
| Default value = `win-x86;win-x64;osx-x64` |
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> | ||
|
|
||
| <PropertyGroup> | ||
| <MSBuildAllProjects>$(MSBuildAllProjects);$(MSBuildThisFileFullPath)</MSBuildAllProjects> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup Condition="'$(DisableImplicitFrameworkReferences)' != 'true'"> | ||
| <PackageReference Include="Microsoft.NETCore.DotNetAppHost" Version="$(MicrosoftNETCoreDotNetAppHostImplicitPackageVersion)" PrivateAssets="All" /> | ||
| </ItemGroup> | ||
| </Project> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> | ||
|
|
||
| <PropertyGroup> | ||
| <MSBuildAllProjects>$(MSBuildAllProjects);$(MSBuildThisFileFullPath)</MSBuildAllProjects> | ||
| <TargetsForTfmSpecificContentInPackage>$(TargetsForTfmSpecificContentInPackage);GetDotNetToolShimPackageContent</TargetsForTfmSpecificContentInPackage> | ||
| </PropertyGroup> | ||
|
|
||
| <PropertyGroup> | ||
| <!-- | ||
| Define the package version of Microsoft.NETCore.DotNetAppHost to match the shared runtime version | ||
| --> | ||
| <MicrosoftNETCoreDotNetAppHostImplicitPackageVersion Condition="'$(MicrosoftNETCoreDotNetAppHostImplicitPackageVersion)' == ''">$(RuntimeFrameworkVersion)</MicrosoftNETCoreDotNetAppHostImplicitPackageVersion> | ||
|
|
||
| <!-- | ||
| Only generate shims for these platforms. | ||
| --> | ||
| <GeneratedShimRuntimeIdentifiers Condition="'$(GeneratedShimRuntimeIdentifiers)' == ''">win-x86;win-x64;osx-x64</GeneratedShimRuntimeIdentifiers> | ||
|
|
||
| <!-- | ||
| Define runtime identifiers to NuGet will restore the apphost for that RID. | ||
| --> | ||
| <RuntimeIdentifiers>$(RuntimeIdentifiers);$(GeneratedShimRuntimeIdentifiers)</RuntimeIdentifiers> | ||
| </PropertyGroup> | ||
|
|
||
| <!-- | ||
| ************************************************************ | ||
| Target: GetDotNetToolShimPackageContent | ||
|
|
||
| Gets package content items for the global shim, without building anything. | ||
| ************************************************************ | ||
| --> | ||
| <Target Name="GetDotNetToolShimPackageContent" DependsOnTargets="_ComputeGeneratedDotNetToolShims"> | ||
| <ItemGroup> | ||
| <!-- Add the file to the package --> | ||
| <TfmSpecificPackageFile Include="@(GeneratedDotNetToolShim)" /> | ||
| </ItemGroup> | ||
| </Target> | ||
|
|
||
| <!-- | ||
| ************************************************************ | ||
| Target: GenerateDotNetToolShims | ||
|
|
||
| Generates the dotnettool shims | ||
| ************************************************************ | ||
| --> | ||
| <Target Name="GenerateDotNetToolShims" | ||
| DependsOnTargets="_ComputeGeneratedDotNetToolShims;_CoreGenerateDotNetToolShim" | ||
| BeforeTargets="CoreCompile" /> | ||
|
|
||
| <Target Name="_ComputeGeneratedDotNetToolShims"> | ||
| <PropertyGroup> | ||
| <_NormalizedPackageVersion>$(PackageVersion)</_NormalizedPackageVersion> | ||
| <_NormalizedPackageVersion Condition="$(_NormalizedPackageVersion.Contains('+'))">$(_NormalizedPackageVersion.Substring($(_NormalizedPackageVersion.IndexOf('+'))))</_NormalizedPackageVersion> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <_ShimRids Include="$(GeneratedShimRuntimeIdentifiers)" AppHostFileName="$(AssemblyName)" /> | ||
| <_ShimRids Update="%(_ShimRids.Identity)" AppHostFileName="$(AssemblyName).exe" Condition="$([System.String]::new('%(_ShimRids.Identity)').StartsWith('win'))" /> | ||
|
|
||
| <GeneratedDotNetToolShim Condition="'%(_ShimRids.Identity)' != ''" Include="$(IntermediateOutputPath)shims/%(_ShimRids.Identity)/%(_ShimRids.AppHostFileName)"> | ||
| <RuntimeIdentifier>%(_ShimRids.Identity)</RuntimeIdentifier> | ||
| <OutputDir>$(IntermediateOutputPath)shims/%(_ShimRids.Identity)/</OutputDir> | ||
| <PackagePath>tools/$(TargetFramework)/any/shims/%(_ShimRids.Identity)/</PackagePath> | ||
| <RelativeAppBinaryFilePath>.store/$(PackageId.ToLowerInvariant())/$(_NormalizedPackageVersion)/$(PackageId.ToLowerInvariant())/$(_NormalizedPackageVersion)/tools/$(TargetFramework)/any/$(TargetFileName)</RelativeAppBinaryFilePath> | ||
| </GeneratedDotNetToolShim> | ||
| </ItemGroup> | ||
| </Target> | ||
|
|
||
| <!-- This task is defined in Microsoft.NET.Sdk --> | ||
| <UsingTask TaskName="EmbedAppNameInHost" AssemblyFile="$(MicrosoftNETBuildTasksAssembly)" /> | ||
|
|
||
| <Target Name="_CoreGenerateDotNetToolShim" | ||
| DependsOnTargets="_ComputeGeneratedDotNetToolShims" | ||
| Inputs="$(MSBuildAllProjects);$(ProjectAssetsFile)" | ||
| Outputs="@(GeneratedDotNetToolShim)"> | ||
|
|
||
| <MSBuild | ||
| Targets="_CoreGenerateDotNetToolShimForRid" | ||
| Projects="$(MSBuildProjectFullPath)" | ||
| Properties=" | ||
| TargetFramework=$(TargetFramework); | ||
| RuntimeIdentifier=%(GeneratedDotNetToolShim.RuntimeIdentifier); | ||
| _ShimRelativeAppBinaryFilePath=%(GeneratedDotNetToolShim.RelativeAppBinaryFilePath); | ||
| _ShimOutputDir=%(GeneratedDotNetToolShim.OutputDir)" | ||
| Condition="'%(GeneratedDotNetToolShim.Identity)' != ''" /> | ||
| </Target> | ||
|
|
||
| <Target Name="_CoreGenerateDotNetToolShimForRid" DependsOnTargets="ResolvePackageAssets"> | ||
| <ItemGroup> | ||
| <NativeRestoredAppHostNETCore Include="@(NativeCopyLocalItems)" | ||
| Condition="'%(NativeCopyLocalItems.FileName)%(NativeCopyLocalItems.Extension)' == '$(_DotNetAppHostExecutableName)'"/> | ||
| </ItemGroup> | ||
|
|
||
| <NETSdkError Condition="'@(NativeRestoredAppHostNETCore->Count())' > 1" | ||
| ResourceName="MultipleFilesResolved" | ||
| FormatArguments="$(_DotNetAppHostExecutableName)" /> | ||
|
|
||
| <EmbedAppNameInHost AppHostSourcePath="@(NativeRestoredAppHostNETCore)" | ||
| AppHostDestinationDirectoryPath="$(_ShimOutputDir)" | ||
| AppBinaryName="$(_ShimRelativeAppBinaryFilePath)"/> | ||
| </Target> | ||
|
|
||
| </Project> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> | ||
|
|
||
| <PropertyGroup> | ||
| <MSBuildAllProjects>$(MSBuildAllProjects);$(MSBuildThisFileFullPath)</MSBuildAllProjects> | ||
| </PropertyGroup> | ||
|
|
||
| <Import | ||
| Project="Microsoft.DotNetTool.ShimGeneration.props" | ||
| Condition="'$(PackAsTool)' == 'true' AND '$(GenerateToolShims)' == 'true' AND '$(TargetFramework)' != ''" /> | ||
| </Project> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this need
RestoreSourcesor does it pick the one via Directory.Build.props?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's set in the PreinstallBundledPackages target (see below). We can't set it here since the path will be machine-specific.