From 348c967b7ba018b6b6411a5d36ee758678e8cd11 Mon Sep 17 00:00:00 2001 From: Mariana Dematte Date: Tue, 20 Jun 2023 00:58:53 -0300 Subject: [PATCH 1/7] Draft of details command docs --- docs/core/tools/dotnet-new-details.md | 62 +++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 docs/core/tools/dotnet-new-details.md diff --git a/docs/core/tools/dotnet-new-details.md b/docs/core/tools/dotnet-new-details.md new file mode 100644 index 0000000000000..12e1e2b4c6301 --- /dev/null +++ b/docs/core/tools/dotnet-new-details.md @@ -0,0 +1,62 @@ +--- +title: dotnet new details +description: The dotnet new details command displays template package metadata. +ms.date: 04/15/2022 +--- +# dotnet new details + +**This article applies to:** ✔️ .NET Core ??? SDK and later versions + +## Name + +`dotnet new details` - Displays template package metadata. + +## Synopsis + +``` +add the thingS +``` + +## Description + +The `dotnet new details` command displays the metdata of the template package from the package name provided. For information on a specific version specify the version in with the `--version (check if this is correct)` option. By default, the command searches for the latest available version. +If the package is installed locally or is found on the official NuGet website, it also displays the templates that the package contains, otherwise it will only display basic package metadata. + +## Arguments + +- **`PACKAGE NAME`** + +Name of the package being searched for metadata. + + +## Options + +- **`--version `** +Specific version of the package being searched. If this is not specified, the command will look for the latest version. + +- **`--add-source|--nuget-source `** + + By default, `dotnet new details` uses the hierarchy of NuGet configuration files from the current directory to determine the NuGet source the package can be installed from. If `--nuget-source` is specified, the source will be added to the list of sources to be checked. + To check the configured sources for the current directory use [`dotnet nuget list source`](dotnet-nuget-list-source.md). For more information, see [Common NuGet Configurations](/nuget/consume-packages/configuring-nuget-behavior) + +[!INCLUDE [interactive](../../../includes/cli-interactive-5-0.md)] + +- **`-d|--diagnostics`** + + Enables diagnostic output. Available since .NET SDK 7.0.100. + +- **`-h|--help`** + + Prints out help for the search command. Available since .NET SDK 7.0.100. + + +## Examples + + +## See also + +- [dotnet new command](dotnet-new.md) +- [dotnet new uninstall command](dotnet-new-uninstall.md) +- [dotnet new list command](dotnet-new-list.md) +- [dotnet new search command](dotnet-new-search.md) +- [Custom templates for dotnet new](custom-templates.md) \ No newline at end of file From fb1cb8ff0401d78703d49472899fcd84b7aa991d Mon Sep 17 00:00:00 2001 From: Mariana Dematte Date: Thu, 22 Jun 2023 11:42:16 -0300 Subject: [PATCH 2/7] Filled in information about details command --- docs/core/tools/dotnet-new-details.md | 30 +++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/docs/core/tools/dotnet-new-details.md b/docs/core/tools/dotnet-new-details.md index 12e1e2b4c6301..92b75caf4b0a0 100644 --- a/docs/core/tools/dotnet-new-details.md +++ b/docs/core/tools/dotnet-new-details.md @@ -13,26 +13,27 @@ ms.date: 04/15/2022 ## Synopsis -``` -add the thingS +```dotnetcli +dotnet new details [] [--version ] [--interactive] [--add-source|--nuget-source ] + [--force] [-d|--diagnostics] [-h|--help] ``` ## Description The `dotnet new details` command displays the metdata of the template package from the package name provided. For information on a specific version specify the version in with the `--version (check if this is correct)` option. By default, the command searches for the latest available version. -If the package is installed locally or is found on the official NuGet website, it also displays the templates that the package contains, otherwise it will only display basic package metadata. +If the package is installed locally or is found on the official NuGet website, it also displays the templates that the package contains, otherwise it will only display basic metadata. ## Arguments - **`PACKAGE NAME`** -Name of the package being searched for metadata. - + The package identifier to display the details for. ## Options - **`--version `** -Specific version of the package being searched. If this is not specified, the command will look for the latest version. + + Specifies the version of the package. If none is passed, the command displays information from the latest package version. - **`--add-source|--nuget-source `** @@ -52,6 +53,23 @@ Specific version of the package being searched. If this is not specified, the co ## Examples +- Displays package data from the latest version of SPA templates for ASP.NET Core: + + ```dotnetcli + dotnet new details Microsoft.DotNet.Web.Spa.ProjectTemplates + ``` + +- Displays package data from version 2.0 of the SPA templates for ASP.NET Core: + + ```dotnetcli + dotnet new install Microsoft.DotNet.Web.Spa.ProjectTemplates --version 2.0.0 + ``` + +- Displays package data from version 2.0 of the SPA templates for ASP.NET Core from a custom NuGet source using interactive mode: + + ```dotnetcli + dotnet new details Microsoft.DotNet.Web.Spa.ProjectTemplates --version 2.0.0 --add-source "https://api.my-custom-nuget.com/v3/index.json" --interactive + ``` ## See also From 0aa4663c9931013f40bc0835a26ddfeebb17d562 Mon Sep 17 00:00:00 2001 From: Mariana Dematte Date: Wed, 28 Jun 2023 14:09:59 -0300 Subject: [PATCH 3/7] markdown fix --- docs/core/tools/dotnet-new-details.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/core/tools/dotnet-new-details.md b/docs/core/tools/dotnet-new-details.md index 92b75caf4b0a0..0806688ceb390 100644 --- a/docs/core/tools/dotnet-new-details.md +++ b/docs/core/tools/dotnet-new-details.md @@ -32,7 +32,7 @@ If the package is installed locally or is found on the official NuGet website, i ## Options - **`--version `** - + Specifies the version of the package. If none is passed, the command displays information from the latest package version. - **`--add-source|--nuget-source `** @@ -50,7 +50,6 @@ If the package is installed locally or is found on the official NuGet website, i Prints out help for the search command. Available since .NET SDK 7.0.100. - ## Examples - Displays package data from the latest version of SPA templates for ASP.NET Core: @@ -77,4 +76,4 @@ If the package is installed locally or is found on the official NuGet website, i - [dotnet new uninstall command](dotnet-new-uninstall.md) - [dotnet new list command](dotnet-new-list.md) - [dotnet new search command](dotnet-new-search.md) -- [Custom templates for dotnet new](custom-templates.md) \ No newline at end of file +- [Custom templates for dotnet new](custom-templates.md) From c2d8637be4d9e87aeb5fe974421409352b0b65b6 Mon Sep 17 00:00:00 2001 From: Mariana Dematte Date: Thu, 6 Jul 2023 15:56:00 -0300 Subject: [PATCH 4/7] removed version option from details command --- docs/core/tools/dotnet-new-details.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/docs/core/tools/dotnet-new-details.md b/docs/core/tools/dotnet-new-details.md index 0806688ceb390..999a612f54bf9 100644 --- a/docs/core/tools/dotnet-new-details.md +++ b/docs/core/tools/dotnet-new-details.md @@ -1,11 +1,11 @@ --- title: dotnet new details description: The dotnet new details command displays template package metadata. -ms.date: 04/15/2022 +ms.date: 06/07/2023 --- # dotnet new details -**This article applies to:** ✔️ .NET Core ??? SDK and later versions +**This article applies to:** ✔️ .NET 8 preview 6 ## Name @@ -14,7 +14,7 @@ ms.date: 04/15/2022 ## Synopsis ```dotnetcli -dotnet new details [] [--version ] [--interactive] [--add-source|--nuget-source ] +dotnet new details [] [--interactive] [--add-source|--nuget-source ] [--force] [-d|--diagnostics] [-h|--help] ``` @@ -31,10 +31,6 @@ If the package is installed locally or is found on the official NuGet website, i ## Options -- **`--version `** - - Specifies the version of the package. If none is passed, the command displays information from the latest package version. - - **`--add-source|--nuget-source `** By default, `dotnet new details` uses the hierarchy of NuGet configuration files from the current directory to determine the NuGet source the package can be installed from. If `--nuget-source` is specified, the source will be added to the list of sources to be checked. From d5f22f2738bea0c7c335a8bf556d918d34941efe Mon Sep 17 00:00:00 2001 From: Mariana Dematte Date: Fri, 7 Jul 2023 09:12:26 -0300 Subject: [PATCH 5/7] Missed removing version from examples --- docs/core/tools/dotnet-new-details.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/docs/core/tools/dotnet-new-details.md b/docs/core/tools/dotnet-new-details.md index 999a612f54bf9..a494c827562c2 100644 --- a/docs/core/tools/dotnet-new-details.md +++ b/docs/core/tools/dotnet-new-details.md @@ -54,16 +54,10 @@ If the package is installed locally or is found on the official NuGet website, i dotnet new details Microsoft.DotNet.Web.Spa.ProjectTemplates ``` -- Displays package data from version 2.0 of the SPA templates for ASP.NET Core: +- Displays package data of the SPA templates for ASP.NET Core from a custom NuGet source using interactive mode: ```dotnetcli - dotnet new install Microsoft.DotNet.Web.Spa.ProjectTemplates --version 2.0.0 - ``` - -- Displays package data from version 2.0 of the SPA templates for ASP.NET Core from a custom NuGet source using interactive mode: - - ```dotnetcli - dotnet new details Microsoft.DotNet.Web.Spa.ProjectTemplates --version 2.0.0 --add-source "https://api.my-custom-nuget.com/v3/index.json" --interactive + dotnet new details Microsoft.DotNet.Web.Spa.ProjectTemplates --add-source "https://api.my-custom-nuget.com/v3/index.json" --interactive ``` ## See also From 64b58f02d392cd964b273ca9538e48a86b644e64 Mon Sep 17 00:00:00 2001 From: Mariana Dematte Date: Tue, 11 Jul 2023 13:16:53 -0300 Subject: [PATCH 6/7] Addressed PR comments --- docs/core/tools/dotnet-new-details.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/core/tools/dotnet-new-details.md b/docs/core/tools/dotnet-new-details.md index a494c827562c2..c349bd641bb24 100644 --- a/docs/core/tools/dotnet-new-details.md +++ b/docs/core/tools/dotnet-new-details.md @@ -20,44 +20,44 @@ dotnet new details [] [--interactive] [--add-source|--nuget-source ## Description -The `dotnet new details` command displays the metdata of the template package from the package name provided. For information on a specific version specify the version in with the `--version (check if this is correct)` option. By default, the command searches for the latest available version. -If the package is installed locally or is found on the official NuGet website, it also displays the templates that the package contains, otherwise it will only display basic metadata. +The `dotnet new details` command displays the metdata of the template package from the package name provided. By default, the command searches for the latest available version. +If the package is installed locally or is found on the official NuGet website, it also displays the templates that the package contains, otherwise it only displays basic metadata. ## Arguments -- **`PACKAGE NAME`** +- **`PACKAGE_NAME`** - The package identifier to display the details for. + The package identifier to display the details for. ## Options - **`--add-source|--nuget-source `** - By default, `dotnet new details` uses the hierarchy of NuGet configuration files from the current directory to determine the NuGet source the package can be installed from. If `--nuget-source` is specified, the source will be added to the list of sources to be checked. + By default, `dotnet new details` uses the hierarchy of NuGet configuration files from the current directory to determine the NuGet source the package can be installed from. If `--nuget-source` is specified, the source is added to the list of sources to be checked. To check the configured sources for the current directory use [`dotnet nuget list source`](dotnet-nuget-list-source.md). For more information, see [Common NuGet Configurations](/nuget/consume-packages/configuring-nuget-behavior) -[!INCLUDE [interactive](../../../includes/cli-interactive-5-0.md)] +[!INCLUDE [interactive](../../../includes/cli-interactive.md)] - **`-d|--diagnostics`** - Enables diagnostic output. Available since .NET SDK 7.0.100. + Enables diagnostic output. - **`-h|--help`** - Prints out help for the search command. Available since .NET SDK 7.0.100. + Prints out help for the search command. ## Examples -- Displays package data from the latest version of SPA templates for ASP.NET Core: +- Display package data from the latest version of NUnit templates: ```dotnetcli - dotnet new details Microsoft.DotNet.Web.Spa.ProjectTemplates + dotnet new details NUnit3.DotNetNew.Template ``` -- Displays package data of the SPA templates for ASP.NET Core from a custom NuGet source using interactive mode: +- Display package data of the NUnit templates from a custom NuGet source using interactive mode: ```dotnetcli - dotnet new details Microsoft.DotNet.Web.Spa.ProjectTemplates --add-source "https://api.my-custom-nuget.com/v3/index.json" --interactive + dotnet new details NUnit3.DotNetNew.Template --add-source "https://api.my-custom-nuget.com/v3/index.json" --interactive ``` ## See also From 87e81fe4f4f997682149fea8734665904dcf7bec Mon Sep 17 00:00:00 2001 From: Mariana Dematte Date: Tue, 11 Jul 2023 13:23:27 -0300 Subject: [PATCH 7/7] Added page to the toc file --- docs/navigate/tools-diagnostics/toc.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/navigate/tools-diagnostics/toc.yml b/docs/navigate/tools-diagnostics/toc.yml index c157c4c78b019..2daf619c73a61 100644 --- a/docs/navigate/tools-diagnostics/toc.yml +++ b/docs/navigate/tools-diagnostics/toc.yml @@ -122,6 +122,8 @@ items: href: ../../core/tools/dotnet-new-list.md - name: dotnet new search href: ../../core/tools/dotnet-new-search.md + - name: dotnet new details + href: ../../core/tools/dotnet-new-details.md - name: dotnet new install href: ../../core/tools/dotnet-new-install.md - name: dotnet new uninstall