Skip to content

[release/7.0.2xx] Templates for template authoring #5946

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

Closed
vlada-shubina wants to merge 13 commits into from
Closed

[release/7.0.2xx] Templates for template authoring #5946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
31ccf84
templates for template authoring: first draft
vlada-shubina Dec 7, 2022
2a31069
renamed comment properties
vlada-shubina Dec 8, 2022
ccd97ea
removed extra readme
vlada-shubina Dec 8, 2022
fafa9dc
added tests
vlada-shubina Dec 16, 2022
3af10bd
added TODO instructions using post action
vlada-shubina Dec 19, 2022
cbcc042
replaced the links, polishing
vlada-shubina Dec 19, 2022
d67734a
updated the target framework in the template
vlada-shubina Jan 18, 2023
5b7338c
added link to classification in the reference, improved description i…
vlada-shubina Jan 18, 2023
6086fb9
excluded authoring templates from source-build
vlada-shubina Jan 18, 2023
4a56d54
updated target framework back to net7.0
vlada-shubina Jan 18, 2023
34b9c92
corrected link in template description
vlada-shubina Jan 18, 2023
c737034
updated dotnetcli.host.file for template package template
vlada-shubina Jan 18, 2023
2203522
renamed template.json inside package as it caused warning in dotnet CLI
vlada-shubina Jan 18, 2023
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
3 changes: 1 addition & 2 deletions Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@
<ToolsDir>$(RepoRoot)tools\</ToolsDir>
<ToolsTempDir>$(RepoRoot).tools\</ToolsTempDir>
<LocalizeDir>$(RepoRoot)localize\</LocalizeDir>
<TemplatesDir>$(ArtifactsDir)templates\</TemplatesDir>
<TemplatesNoTimestampDir>$(ArtifactsDir)templates-notimestamp\</TemplatesNoTimestampDir>
<TemplatesDir>$(RepoRoot)template_feed\</TemplatesDir>
<SrcDir>$(RepoRoot)src\</SrcDir>
<TestDir>$(RepoRoot)test\</TestDir>
<StrongNameKeyId>MicrosoftAspNetCore</StrongNameKeyId>
Expand Down
32 changes: 32 additions & 0 deletions Microsoft.TemplateEngine.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,12 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Microsoft.TemplateEngine.Co
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.TemplateEngine.Authoring.TemplateApiVerifier", "tools\Microsoft.TemplateEngine.Authoring.TemplateApiVerifier\Microsoft.TemplateEngine.Authoring.TemplateApiVerifier.csproj", "{449B9DDA-F18C-411E-9A74-3930652BB78A}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "template-feed", "template-feed", "{FF433F83-22C2-46E0-99B3-4FFCA5190A94}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.TemplateEngine.Authoring.Templates", "template_feed\Microsoft.TemplateEngine.Authoring.Templates\Microsoft.TemplateEngine.Authoring.Templates.csproj", "{1F74F8F5-99E4-47AE-8608-6D470325E81C}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.TemplateEngine.Authoring.Templates.IntegrationTests", "test\Microsoft.TemplateEngine.Authoring.Templates.IntegrationTests\Microsoft.TemplateEngine.Authoring.Templates.IntegrationTests.csproj", "{8651DEEB-0291-4E49-92AA-3B097DAF9D37}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -484,6 +490,30 @@ Global
{449B9DDA-F18C-411E-9A74-3930652BB78A}.Release|x64.Build.0 = Release|Any CPU
{449B9DDA-F18C-411E-9A74-3930652BB78A}.Release|x86.ActiveCfg = Release|Any CPU
{449B9DDA-F18C-411E-9A74-3930652BB78A}.Release|x86.Build.0 = Release|Any CPU
{1F74F8F5-99E4-47AE-8608-6D470325E81C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{1F74F8F5-99E4-47AE-8608-6D470325E81C}.Debug|Any CPU.Build.0 = Debug|Any CPU
{1F74F8F5-99E4-47AE-8608-6D470325E81C}.Debug|x64.ActiveCfg = Debug|Any CPU
{1F74F8F5-99E4-47AE-8608-6D470325E81C}.Debug|x64.Build.0 = Debug|Any CPU
{1F74F8F5-99E4-47AE-8608-6D470325E81C}.Debug|x86.ActiveCfg = Debug|Any CPU
{1F74F8F5-99E4-47AE-8608-6D470325E81C}.Debug|x86.Build.0 = Debug|Any CPU
{1F74F8F5-99E4-47AE-8608-6D470325E81C}.Release|Any CPU.ActiveCfg = Release|Any CPU
{1F74F8F5-99E4-47AE-8608-6D470325E81C}.Release|Any CPU.Build.0 = Release|Any CPU
{1F74F8F5-99E4-47AE-8608-6D470325E81C}.Release|x64.ActiveCfg = Release|Any CPU
{1F74F8F5-99E4-47AE-8608-6D470325E81C}.Release|x64.Build.0 = Release|Any CPU
{1F74F8F5-99E4-47AE-8608-6D470325E81C}.Release|x86.ActiveCfg = Release|Any CPU
{1F74F8F5-99E4-47AE-8608-6D470325E81C}.Release|x86.Build.0 = Release|Any CPU
{8651DEEB-0291-4E49-92AA-3B097DAF9D37}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{8651DEEB-0291-4E49-92AA-3B097DAF9D37}.Debug|Any CPU.Build.0 = Debug|Any CPU
{8651DEEB-0291-4E49-92AA-3B097DAF9D37}.Debug|x64.ActiveCfg = Debug|Any CPU
{8651DEEB-0291-4E49-92AA-3B097DAF9D37}.Debug|x64.Build.0 = Debug|Any CPU
{8651DEEB-0291-4E49-92AA-3B097DAF9D37}.Debug|x86.ActiveCfg = Debug|Any CPU
{8651DEEB-0291-4E49-92AA-3B097DAF9D37}.Debug|x86.Build.0 = Debug|Any CPU
{8651DEEB-0291-4E49-92AA-3B097DAF9D37}.Release|Any CPU.ActiveCfg = Release|Any CPU
{8651DEEB-0291-4E49-92AA-3B097DAF9D37}.Release|Any CPU.Build.0 = Release|Any CPU
{8651DEEB-0291-4E49-92AA-3B097DAF9D37}.Release|x64.ActiveCfg = Release|Any CPU
{8651DEEB-0291-4E49-92AA-3B097DAF9D37}.Release|x64.Build.0 = Release|Any CPU
{8651DEEB-0291-4E49-92AA-3B097DAF9D37}.Release|x86.ActiveCfg = Release|Any CPU
{8651DEEB-0291-4E49-92AA-3B097DAF9D37}.Release|x86.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down Expand Up @@ -523,6 +553,8 @@ Global
{43053BC4-32B4-4404-B62D-410F367CE0CE} = {B794BF86-4185-4DCE-AC86-C27D5D966B9B}
{EE8CD472-D8C4-4CD0-BC84-6C305F5971AE} = {43053BC4-32B4-4404-B62D-410F367CE0CE}
{449B9DDA-F18C-411E-9A74-3930652BB78A} = {B794BF86-4185-4DCE-AC86-C27D5D966B9B}
{1F74F8F5-99E4-47AE-8608-6D470325E81C} = {FF433F83-22C2-46E0-99B3-4FFCA5190A94}
{8651DEEB-0291-4E49-92AA-3B097DAF9D37} = {8B498D0C-F488-4B38-8A7D-B20BF9DB6F60}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {6EA1A508-6033-4538-BF98-7F71B4E297AD}
Expand Down
30 changes: 30 additions & 0 deletions ...ft.TemplateEngine.Authoring.Templates/Microsoft.TemplateEngine.Authoring.Templates.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>$(NETCoreTargetFramework)</TargetFramework>
<IncludeBuildOutput>False</IncludeBuildOutput>
<IncludeSource>False</IncludeSource>
<GenerateAssemblyInfo>False</GenerateAssemblyInfo>
<OutputPath>$(ArtifactsTmpDir)</OutputPath>
<EnableDefaultItems>False</EnableDefaultItems>
<UsingToolTemplateLocalizer>true</UsingToolTemplateLocalizer>
<IsPackable>true</IsPackable>
<IsShipping>true</IsShipping>
<IsShippingPackage>true</IsShippingPackage>
<NoWarn>2008;NU5105</NoWarn>
<NoPackageAnalysis>true</NoPackageAnalysis>
<PackageId>Microsoft.TemplateEngine.Authoring.Templates</PackageId>
<Authors>Microsoft</Authors>
<Description>The templates for useful items and projects for template authoring.</Description>
<language>en-US</language>
<PackageProjectUrl>https://github.com/dotnet/templating</PackageProjectUrl>
<PackageType>Template</PackageType>
<SuppressDependenciesWhenPacking>True</SuppressDependenciesWhenPacking>
<ExcludeFromSourceBuild>true</ExcludeFromSourceBuild>
</PropertyGroup>
<ItemGroup>
<PackageReference Remove="Microsoft.NETCore.App" />
<Content Include="content\**">
<PackagePath>content</PackagePath>
</Content>
</ItemGroup>
</Project>
10 changes: 10 additions & 0 deletions template_feed/Microsoft.TemplateEngine.Authoring.Templates/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## The templates for template authoring

The package contains the templates useful for the template authoring:
| Template name | Short name | Description|
|---|---|---|
|`template.json` configuration file|`template.json`|A template for template.json configuration file for .NET template.|
|Template Package|`template-package`|A project for creating template package containing .NET templates.|

The package is available for download from nuget.org.
Please feel to contribute or provide the feedback in discussions or via opening the issue in dotnet/templating repo.
21 changes: 21 additions & 0 deletions ...plateEngine.Authoring.Templates/content/TemplateJson/.template.config/dotnetcli.host.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"$schema": "http://json.schemastore.org/dotnetcli.host",
"symbolInfo": {
"CreateTemplateConfigFolder": {
"longName": "create-template-config-folder",
"shortName": ""
},
"TemplateName": {
"longName": "template-name",
"shortName": "tn"
},
"TemplateShortName": {
"longName": "short-name",
"shortName": "sn"
},
"TemplateIdentity": {
"longName": "template-identity",
"shortName": "ti"
}
}
}
15 changes: 15 additions & 0 deletions ...uthoring.Templates/content/TemplateJson/.template.config/localize/templatestrings.cs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"author": "Microsoft",
"name": "template.json configuration file",
"description": "A template for template.json configuration file for .NET template. See https://aka.ms/template-json-reference for complete configuration description.",
"symbols/CreateTemplateConfigFolder/description": "True when template.json should be created in .template.config folder.",
"symbols/CreateTemplateConfigFolder/displayName": "Create .template.config folder",
"symbols/TemplateName/description": "The template name.",
"symbols/TemplateName/displayName": "Template name",
"symbols/TemplateShortName/description": "The template short name.",
"symbols/TemplateShortName/displayName": "Template short name",
"symbols/TemplateIdentity/description": "The template identity (should be unique).",
"symbols/TemplateIdentity/displayName": "Template identity",
"postActions/instructions/description": "Manual actions required",
"postActions/instructions/manualInstructions/default/text": "Open template.json in the editor and complete the configuration."
}
15 changes: 15 additions & 0 deletions ...uthoring.Templates/content/TemplateJson/.template.config/localize/templatestrings.de.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"author": "Microsoft",
"name": "template.json configuration file",
"description": "A template for template.json configuration file for .NET template. See https://aka.ms/template-json-reference for complete configuration description.",
"symbols/CreateTemplateConfigFolder/description": "True when template.json should be created in .template.config folder.",
"symbols/CreateTemplateConfigFolder/displayName": "Create .template.config folder",
"symbols/TemplateName/description": "The template name.",
"symbols/TemplateName/displayName": "Template name",
"symbols/TemplateShortName/description": "The template short name.",
"symbols/TemplateShortName/displayName": "Template short name",
"symbols/TemplateIdentity/description": "The template identity (should be unique).",
"symbols/TemplateIdentity/displayName": "Template identity",
"postActions/instructions/description": "Manual actions required",
"postActions/instructions/manualInstructions/default/text": "Open template.json in the editor and complete the configuration."
}
15 changes: 15 additions & 0 deletions ...uthoring.Templates/content/TemplateJson/.template.config/localize/templatestrings.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"author": "Microsoft",
"name": "template.json configuration file",
"description": "A template for template.json configuration file for .NET template. See https://aka.ms/template-json-reference for complete configuration description.",
"symbols/CreateTemplateConfigFolder/description": "True when template.json should be created in .template.config folder.",
"symbols/CreateTemplateConfigFolder/displayName": "Create .template.config folder",
"symbols/TemplateName/description": "The template name.",
"symbols/TemplateName/displayName": "Template name",
"symbols/TemplateShortName/description": "The template short name.",
"symbols/TemplateShortName/displayName": "Template short name",
"symbols/TemplateIdentity/description": "The template identity (should be unique).",
"symbols/TemplateIdentity/displayName": "Template identity",
"postActions/instructions/description": "Manual actions required",
"postActions/instructions/manualInstructions/default/text": "Open template.json in the editor and complete the configuration."
}
15 changes: 15 additions & 0 deletions ...uthoring.Templates/content/TemplateJson/.template.config/localize/templatestrings.es.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"author": "Microsoft",
"name": "template.json configuration file",
"description": "A template for template.json configuration file for .NET template. See https://aka.ms/template-json-reference for complete configuration description.",
"symbols/CreateTemplateConfigFolder/description": "True when template.json should be created in .template.config folder.",
"symbols/CreateTemplateConfigFolder/displayName": "Create .template.config folder",
"symbols/TemplateName/description": "The template name.",
"symbols/TemplateName/displayName": "Template name",
"symbols/TemplateShortName/description": "The template short name.",
"symbols/TemplateShortName/displayName": "Template short name",
"symbols/TemplateIdentity/description": "The template identity (should be unique).",
"symbols/TemplateIdentity/displayName": "Template identity",
"postActions/instructions/description": "Manual actions required",
"postActions/instructions/manualInstructions/default/text": "Open template.json in the editor and complete the configuration."
}
15 changes: 15 additions & 0 deletions ...uthoring.Templates/content/TemplateJson/.template.config/localize/templatestrings.fr.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"author": "Microsoft",
"name": "template.json configuration file",
"description": "A template for template.json configuration file for .NET template. See https://aka.ms/template-json-reference for complete configuration description.",
"symbols/CreateTemplateConfigFolder/description": "True when template.json should be created in .template.config folder.",
"symbols/CreateTemplateConfigFolder/displayName": "Create .template.config folder",
"symbols/TemplateName/description": "The template name.",
"symbols/TemplateName/displayName": "Template name",
"symbols/TemplateShortName/description": "The template short name.",
"symbols/TemplateShortName/displayName": "Template short name",
"symbols/TemplateIdentity/description": "The template identity (should be unique).",
"symbols/TemplateIdentity/displayName": "Template identity",
"postActions/instructions/description": "Manual actions required",
"postActions/instructions/manualInstructions/default/text": "Open template.json in the editor and complete the configuration."
}
15 changes: 15 additions & 0 deletions ...uthoring.Templates/content/TemplateJson/.template.config/localize/templatestrings.it.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"author": "Microsoft",
"name": "template.json configuration file",
"description": "A template for template.json configuration file for .NET template. See https://aka.ms/template-json-reference for complete configuration description.",
"symbols/CreateTemplateConfigFolder/description": "True when template.json should be created in .template.config folder.",
"symbols/CreateTemplateConfigFolder/displayName": "Create .template.config folder",
"symbols/TemplateName/description": "The template name.",
"symbols/TemplateName/displayName": "Template name",
"symbols/TemplateShortName/description": "The template short name.",
"symbols/TemplateShortName/displayName": "Template short name",
"symbols/TemplateIdentity/description": "The template identity (should be unique).",
"symbols/TemplateIdentity/displayName": "Template identity",
"postActions/instructions/description": "Manual actions required",
"postActions/instructions/manualInstructions/default/text": "Open template.json in the editor and complete the configuration."
}
15 changes: 15 additions & 0 deletions ...uthoring.Templates/content/TemplateJson/.template.config/localize/templatestrings.ja.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"author": "Microsoft",
"name": "template.json configuration file",
"description": "A template for template.json configuration file for .NET template. See https://aka.ms/template-json-reference for complete configuration description.",
"symbols/CreateTemplateConfigFolder/description": "True when template.json should be created in .template.config folder.",
"symbols/CreateTemplateConfigFolder/displayName": "Create .template.config folder",
"symbols/TemplateName/description": "The template name.",
"symbols/TemplateName/displayName": "Template name",
"symbols/TemplateShortName/description": "The template short name.",
"symbols/TemplateShortName/displayName": "Template short name",
"symbols/TemplateIdentity/description": "The template identity (should be unique).",
"symbols/TemplateIdentity/displayName": "Template identity",
"postActions/instructions/description": "Manual actions required",
"postActions/instructions/manualInstructions/default/text": "Open template.json in the editor and complete the configuration."
}
15 changes: 15 additions & 0 deletions ...uthoring.Templates/content/TemplateJson/.template.config/localize/templatestrings.ko.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"author": "Microsoft",
"name": "template.json configuration file",
"description": "A template for template.json configuration file for .NET template. See https://aka.ms/template-json-reference for complete configuration description.",
"symbols/CreateTemplateConfigFolder/description": "True when template.json should be created in .template.config folder.",
"symbols/CreateTemplateConfigFolder/displayName": "Create .template.config folder",
"symbols/TemplateName/description": "The template name.",
"symbols/TemplateName/displayName": "Template name",
"symbols/TemplateShortName/description": "The template short name.",
"symbols/TemplateShortName/displayName": "Template short name",
"symbols/TemplateIdentity/description": "The template identity (should be unique).",
"symbols/TemplateIdentity/displayName": "Template identity",
"postActions/instructions/description": "Manual actions required",
"postActions/instructions/manualInstructions/default/text": "Open template.json in the editor and complete the configuration."
}
15 changes: 15 additions & 0 deletions ...uthoring.Templates/content/TemplateJson/.template.config/localize/templatestrings.pl.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"author": "Microsoft",
"name": "template.json configuration file",
"description": "A template for template.json configuration file for .NET template. See https://aka.ms/template-json-reference for complete configuration description.",
"symbols/CreateTemplateConfigFolder/description": "True when template.json should be created in .template.config folder.",
"symbols/CreateTemplateConfigFolder/displayName": "Create .template.config folder",
"symbols/TemplateName/description": "The template name.",
"symbols/TemplateName/displayName": "Template name",
"symbols/TemplateShortName/description": "The template short name.",
"symbols/TemplateShortName/displayName": "Template short name",
"symbols/TemplateIdentity/description": "The template identity (should be unique).",
"symbols/TemplateIdentity/displayName": "Template identity",
"postActions/instructions/description": "Manual actions required",
"postActions/instructions/manualInstructions/default/text": "Open template.json in the editor and complete the configuration."
}
15 changes: 15 additions & 0 deletions ...oring.Templates/content/TemplateJson/.template.config/localize/templatestrings.pt-BR.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"author": "Microsoft",
"name": "template.json configuration file",
"description": "A template for template.json configuration file for .NET template. See https://aka.ms/template-json-reference for complete configuration description.",
"symbols/CreateTemplateConfigFolder/description": "True when template.json should be created in .template.config folder.",
"symbols/CreateTemplateConfigFolder/displayName": "Create .template.config folder",
"symbols/TemplateName/description": "The template name.",
"symbols/TemplateName/displayName": "Template name",
"symbols/TemplateShortName/description": "The template short name.",
"symbols/TemplateShortName/displayName": "Template short name",
"symbols/TemplateIdentity/description": "The template identity (should be unique).",
"symbols/TemplateIdentity/displayName": "Template identity",
"postActions/instructions/description": "Manual actions required",
"postActions/instructions/manualInstructions/default/text": "Open template.json in the editor and complete the configuration."
}
15 changes: 15 additions & 0 deletions ...uthoring.Templates/content/TemplateJson/.template.config/localize/templatestrings.ru.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"author": "Microsoft",
"name": "template.json configuration file",
"description": "A template for template.json configuration file for .NET template. See https://aka.ms/template-json-reference for complete configuration description.",
"symbols/CreateTemplateConfigFolder/description": "True when template.json should be created in .template.config folder.",
"symbols/CreateTemplateConfigFolder/displayName": "Create .template.config folder",
"symbols/TemplateName/description": "The template name.",
"symbols/TemplateName/displayName": "Template name",
"symbols/TemplateShortName/description": "The template short name.",
"symbols/TemplateShortName/displayName": "Template short name",
"symbols/TemplateIdentity/description": "The template identity (should be unique).",
"symbols/TemplateIdentity/displayName": "Template identity",
"postActions/instructions/description": "Manual actions required",
"postActions/instructions/manualInstructions/default/text": "Open template.json in the editor and complete the configuration."
}
Loading