https://github.com/steeltoeoss/netcoretooltemplates

https://github.com/steeltoeoss/netcoretooltemplates

Last synced: 11 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/steeltoeoss/netcoretooltemplates
• Owner: SteeltoeOSS
• License: apache-2.0
• Created: 2021-04-29T14:09:32.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2025-03-17T10:25:01.000Z (12 months ago)
• Last Synced: 2025-03-27T15:01:39.730Z (11 months ago)
• Language: C#
• Size: 430 KB
• Stars: 1
• Watchers: 5
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Steeltoe.NetCoreTool.Templates

[![Build Status](https://dev.azure.com/SteeltoeOSS/Steeltoe/_apis/build/status/Initializr/SteeltoeOSS.NetCoreToolTemplates?branchName=main)](https://dev.azure.com/SteeltoeOSS/Steeltoe/_build/latest?definitionId=46&branchName=main)

 [![NuGet Version](https://img.shields.io/nuget/v/Steeltoe.NetCoreTool.Templates?style=flat)](https://www.nuget.org/packages/Steeltoe.NetCoreTool.Templates)

 [![GitHub License](https://img.shields.io/github/license/SteeltoeOSS/NetCoreToolTemplates)](LICENSE)

This repository contains a collection of [.NET Template Packages](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-new),

which can be used from IDEs such as Visual Studio and from the .NET CLI using `dotnet new`. They are also used by [Initializr](https://start.steeltoe.io/).

Project templates:

- `steeltoe-webapi`: Add Steeltoe components to the default `webapi` C# template.

This document describes template installation and template general usage help.

For learning how to develop additional options for the templates, see [DEVELOPER.md](DEVELOPER.md).

## Install

### From NuGet.org (production)

```

$ dotnet new install Steeltoe.NetCoreTool.Templates

```

### From .NET Foundation (staging)

```

$ dotnet nuget add source https://pkgs.dev.azure.com/dotnet/Steeltoe/_packaging/dev/nuget/v3/index.json -n SteeltoeDev

$ dotnet new install Steeltoe.NetCoreTool.Templates

```

### From Source (development)

```

$ dotnet new install src/Content

```

## Tips when making changes

- When searching for occurrences of options, Visual Studio doesn't show everything by default. Change the **File types** from `!*\bin\*;!*\obj\*;!*\.*\*` to `!*\bin\*;!*\obj\*` to fix this.

- If you've added a new option to `template.json`, `dotnetcli.host.json` and `ide.host.json`, but it doesn't appear, make sure it is listed in one of the `HasAny*` computed options in `template.json`.

- To observe changes in Visual Studio's **File** > **New** > **Project** dialog, close all instances and run `devenv.exe /updateconfiguration`.

- Unit tests are available for all options (CLI only), be sure to update them.

- To verify all relevant options are exposed, temporarily add `"defaultSymbolVisibility": true` to `ide.host.json`.

- Documentation links

  - https://learn.microsoft.com/en-us/dotnet/core/tools/custom-templates

  - https://github.com/dotnet/templating/wiki

  - https://github.com/dotnet/templating?tab=readme-ov-file#template-content-repositories

  - https://github.com/sayedihashimi/template-sample