Общая информация по работе с пользовательскими шаблонами проектов

Из шаблона можно создать решение целиком, включая WebApi и Worker, либо каждое приложение по отдельности

Для того, чтобы пользовательский шаблон приложения стал доступен для команды dotnet new - его нужно установить локально (см. инструкцию ниже). После успешной установки он будет присутствовать в перечне доступных шаблонов, отображаемых командой dotnet new -l.

При необходимости, установленный пользовательский шаблон можно обновлять, выполняя повторную его установку (т.е. предварительное удаление ранее установленной версии не требуется), или же вовсе удалить его (см. инструкцию ниже).

Локальная установка пользовательского шаблона проекта

Перейдите в подкаталог исходного кода интересующего вас шаблона и запустите команду:

dotnet new -i $(pwd)

Удаление локально установленного пользовательского шаблона проекта

Перейдите в подкаталог исходного кода интересующего вас шаблона и запустите команду:

dotnet new -u $(pwd)

Получение полного списка шаблонов проектов, доступных на локальном компьютере

dotnet new -l

Создать новый проект на основе интересующего вас пользовательского шаблона

Предварительно пользовательский шаблон данного проекта должен быть установлен на локальном компьютере (см. инструкцию выше).

Далее по тексту вместо <TemplateShortName> следует указывать значение, которое записано в поле shortName файла .template.config/template.json интересующего вас шаблона проекта. Это то имя, которое отображается командой dotnet new -l в колонке Короткое имя.

Вариант #1: Создать новый проект в текущем каталоге, а имя проекта сделать таким же, как имя текущего каталога:

dotnet new <TemplateShortName>

Вариант #2: В текущем каталоге автоматически создать новый подкаталог с именем, указанным через параметр -o (в примере ниже - <YourAppName>) и в этом подкаталоге сгенерировать новый проект с таким же именем:

dotnet new <TemplateShortName> -o <YourAppName>

ВАЖНО #1

В компании Softline групповыми политиками запрещены запуски скриптов из консоли. Однако консоль зачастую используется в своей работе различными IDE, например такими как Visual Studio или Visual Studio Code. В свете этой информации запускать IDE необходимо с правами администратора, поскольку в противном случае у вас может возникнуть проблема как со сборкой docker-образов, так и с отладкой вашего приложения в docker-контейнере.

ВАЖНО #2

Команда dotnet new по всем текстовым файлам проекта выполняет поиск значения, которое указано в поле sourceName файла ./<projectName>/template.json. Это значение воспринимается как некий маркер для подстановки. При создании каждого нового проекта все найденные маркеры будут заменены на имя создаваемого проекта, причём с учётом регистра имени проекта.

Однако такой вариант замены не всегда годится. Например, Docker требует, чтобы имена образов и контейнеров не содержали букв верхнего регистра. Для решения этой проблемы в подобных местах маркер, подлежащий замене, следует записывать в нижнем регистре.

Т.е. если в вашем шаблоне проекта в поле sourceName файла ./<projectName>/template.json указано значение ConsoleApp а в файле readme.md вы, помимо прочего, разместили примеры docker-команд построения образа и запуска его контейнера, то в файле readme.md вместо такого варианта:

docker build -t ConsoleApp .
docker run -d --rm --name ConsoleApp ConsoleApp

следует записать следующий:

docker build -t consoleapp .
docker run -d --rm --name consoleapp consoleapp

В таком случае dotnet new при создании нового проекта будет знать, что подставляемое значение для этих мест в тексте следует предварительно приводить к нижнему регистру и в результате будут сгенерированные корректные docker-команды.