Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add dotnet local tool instructions tab #8433

Merged
merged 4 commits into from
Mar 25, 2021
Merged

Add dotnet local tool instructions tab #8433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a564efd
Update wording for .NET CLI (Global) tools
augustoproiete Feb 28, 2021
1819c08
Add .NET local tool installation instructions
augustoproiete Feb 28, 2021
c000338
Add multi-line support for install instruction commands
augustoproiete Mar 21, 2021
f097268
Modified one liner approach to use server-side rendering
augustoproiete Mar 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/NuGetGallery/ViewModels/PackageManagerViewModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ public PackageManagerViewModel(string name)
public string CommandPrefix { get; set; }

/// <summary>
/// A string that represents the command used to install a specific package.
/// One or more strings that represent the command(s) used to install a specific package.
/// </summary>
public string InstallPackageCommand { get; set; }
public string[] InstallPackageCommands { get; set; }

/// <summary>
/// The alert message that contains clarifications about the command/scenario
Expand Down
49 changes: 33 additions & 16 deletions src/NuGetGallery/Views/Packages/DisplayPackage.cshtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,32 @@
{
packageManagers = new PackageManagerViewModel[]
{
new PackageManagerViewModel(".NET CLI")
new PackageManagerViewModel(".NET CLI (Global)")
{
Id = "dotnet-cli",
Id = "dotnet-cli-global",
CommandPrefix = "> ",
InstallPackageCommands = new [] { string.Format("dotnet tool install --global {0} --version {1}", Model.Id, Model.Version) },
AlertLevel = AlertLevel.Info,
AlertMessage = "This package contains a <a href='https://aka.ms/global-tools'>.NET tool</a> you can call from the shell/command line.",
},

new PackageManagerViewModel(".NET CLI (Local)")
{
Id = "dotnet-cli-local",
CommandPrefix = "> ",
InstallPackageCommand = string.Format("dotnet tool install --global {0} --version {1}", Model.Id, Model.Version),
InstallPackageCommands = new []
{
"dotnet new tool-manifest # if you are setting up this repo",
string.Format("dotnet tool install --local {0} --version {1}", Model.Id, Model.Version),
},
AlertLevel = AlertLevel.Info,
AlertMessage = "This package contains a <a href='https://aka.ms/global-tools'>.NET Core Global Tool</a> you can call from the shell/command line.",
AlertMessage = "This package contains a <a href='https://aka.ms/global-tools'>.NET tool</a> you can call from the shell/command line.",
},

new ThirdPartyPackageManagerViewModel("Cake", "https://cakebuild.net/support/nuget")
{
Id = "cake-dotnet-tool",
InstallPackageCommand = Model.GetCakeInstallPackageCommand(),
InstallPackageCommands = new [] { Model.GetCakeInstallPackageCommand() },
},
};
}
Expand All @@ -52,7 +65,7 @@
{
Id = "dotnet-cli",
CommandPrefix = "> ",
InstallPackageCommand = string.Format("dotnet new --install {0}::{1}", Model.Id, Model.Version),
InstallPackageCommands = new [] { string.Format("dotnet new --install {0}::{1}", Model.Id, Model.Version) },
AlertLevel = AlertLevel.Info,
AlertMessage = "This package contains a <a href='https://aka.ms/dotnet-new'>.NET Core Template Package</a> you can call from the shell/command line.",
}
Expand All @@ -66,26 +79,26 @@
{
Id = "package-manager",
CommandPrefix = "PM> ",
InstallPackageCommand = string.Format("Install-Package {0} -Version {1}", Model.Id, Model.Version)
InstallPackageCommands = new [] { string.Format("Install-Package {0} -Version {1}", Model.Id, Model.Version) },
},

new PackageManagerViewModel(".NET CLI")
{
Id = "dotnet-cli",
CommandPrefix = "> ",
InstallPackageCommand = string.Format("dotnet add package {0} --version {1}", Model.Id, Model.Version)
InstallPackageCommands = new [] { string.Format("dotnet add package {0} --version {1}", Model.Id, Model.Version) },
},

new PackageManagerViewModel("PackageReference")
{
Id = "package-reference",
InstallPackageCommand = Model.DevelopmentDependency
InstallPackageCommands = new [] { Model.DevelopmentDependency
? string.Format(string.Join(Environment.NewLine,
"<PackageReference Include=\"{0}\" Version=\"{1}\">",
" <PrivateAssets>all</PrivateAssets>",
" <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>",
"</PackageReference>"), Model.Id, Model.Version)
: string.Format("<PackageReference Include=\"{0}\" Version=\"{1}\" />", Model.Id, Model.Version),
: string.Format("<PackageReference Include=\"{0}\" Version=\"{1}\" />", Model.Id, Model.Version) },
AlertLevel = AlertLevel.Info,
AlertMessage = string.Format("For projects that support <a href=\"{0}\">PackageReference</a>, copy this XML node into the project file to reference the package.",
"https://docs.microsoft.com/en-us/nuget/consume-packages/package-references-in-project-files"),
Expand All @@ -96,14 +109,14 @@
{
Id = "paket-cli",
CommandPrefix = "> ",
InstallPackageCommand = string.Format("paket add {0} --version {1}", Model.Id, Model.Version),
InstallPackageCommands = new [] { string.Format("paket add {0} --version {1}", Model.Id, Model.Version) },
},

new PackageManagerViewModel("F# Interactive")
{
Id = "fsharp-interactive",
CommandPrefix = "> ",
InstallPackageCommand = string.Format("#r \"nuget: {0}, {1}\"", Model.Id, Model.Version),
InstallPackageCommands = new [] { string.Format("#r \"nuget: {0}, {1}\"", Model.Id, Model.Version) },
AlertLevel = AlertLevel.Info,
AlertMessage = string.Format(
"For F# scripts that support <a href=\"{0}\">#r syntax</a>, copy this into the source code to reference the package.",
Expand All @@ -113,7 +126,7 @@
new ThirdPartyPackageManagerViewModel("Cake", "https://cakebuild.net/support/nuget")
{
Id = Model.IsCakeExtension() ? "cake-extension" : "cake",
InstallPackageCommand = Model.GetCakeInstallPackageCommand()
InstallPackageCommands = new [] { Model.GetCakeInstallPackageCommand() },
},
};
}
Expand Down Expand Up @@ -165,11 +178,15 @@
@helper CommandPanel(PackageManagerViewModel packageManager, bool active)
{
var thirdPartyPackageManager = packageManager as ThirdPartyPackageManagerViewModel;

<div role="tabpanel" class="tab-pane @(active ? "active" : string.Empty)" id="@packageManager.Id">
<div>
<div class="install-script-row">
<pre class="install-script" id="@packageManager.Id-text">@packageManager.InstallPackageCommand</pre>
@{
var lastIndex = packageManager.InstallPackageCommands.Length - 1;
var cs = packageManager.InstallPackageCommands.Select((c, i) => i < lastIndex ? c + Environment.NewLine : c);
}
@* Writing out the install command must be on a single line to avoid undesired whitespace in the <pre> tag. *@
<pre class="install-script" id="@packageManager.Id-text">@foreach (var c in cs) {<span class="install-command-row">@c</span>}</pre>
<div class="copy-button">
<!--In order to statisfy the requirement to announce button status both on NVDA/Narrator, other screen reader like NVDA will
announce the data-content "Copied" everytime when we press button, however, it won't work with Narrator when we use bootstrap popover
Expand Down Expand Up @@ -1184,7 +1201,7 @@
continue;
}

packageManagersCss += "#" + packageManager.Id + " .install-script::before {";
packageManagersCss += "#" + packageManager.Id + " .install-command-row::before {";
packageManagersCss += " content: \"" + packageManager.CommandPrefix + "\"";
packageManagersCss += "}";
}
Expand Down