Replace legacy package template with RCL

umbraco · Nov 17, 2023 · 45d3f16 · 45d3f16
1 parent f286b11
commit 45d3f16
Show file tree

Hide file tree

Showing 19 changed files with 135 additions and 342 deletions.
diff --git a/templates/.editorconfig b/templates/.editorconfig
@@ -0,0 +1,2 @@
+# Do not inherit customized EditorConfig for template content
+root = true
diff --git a/templates/Directory.Build.props b/templates/Directory.Build.props
@@ -1,4 +1,4 @@
 <Project>
-  <!-- Enable multi-level merging with src -->
-  <Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Build.props', '$(MSBuildThisFileDirectory)..\src\'))" />
+	<!-- Enable multi-level merging with src -->
+	<Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Build.props', '$(MSBuildThisFileDirectory)..\src\'))" />
 </Project>
diff --git a/templates/Umbraco.Templates.csproj b/templates/Umbraco.Templates.csproj
@@ -1,66 +1,65 @@
 <Project Sdk="Microsoft.NET.Sdk">
-  <PropertyGroup>
-    <Title>Umbraco CMS - Templates</Title>
-    <Description>Contains templates for Umbraco CMS, as well as the templates for creating new packages for the Umbraco CMS.</Description>
-    <PackageType>Template</PackageType>
-    <IncludeBuildOutput>false</IncludeBuildOutput>
-    <IncludeSymbols>false</IncludeSymbols>
-    <NoDefaultExcludes>true</NoDefaultExcludes>
-    <IncludeContentInPack>true</IncludeContentInPack>
-    <ContentTargetFolders>.</ContentTargetFolders>
-    <NoWarn>NU5128</NoWarn>
-  </PropertyGroup>
+	<PropertyGroup>
+		<Title>Umbraco CMS - Templates</Title>
+		<Description>Contains templates for Umbraco CMS, as well as the templates for creating new packages for the Umbraco CMS.</Description>
+		<PackageType>Template</PackageType>
+		<IncludeBuildOutput>false</IncludeBuildOutput>
+		<IncludeSymbols>false</IncludeSymbols>
+		<NoDefaultExcludes>true</NoDefaultExcludes>
+		<IncludeContentInPack>true</IncludeContentInPack>
+		<ContentTargetFolders>.</ContentTargetFolders>
+		<NoWarn>NU5128</NoWarn>
+	</PropertyGroup>
 
-  <ItemGroup>
-    <Content Include="UmbracoPackage\**" Exclude="bin;obj" />
-    <Content Include="UmbracoPackageRcl\**" Exclude="bin;obj" />
-    <Content Include="UmbracoProject\**" Exclude="bin;obj" />
-    <Content Include="..\src\Umbraco.Web.UI\Program.cs">
-      <Link>UmbracoProject\Program.cs</Link>
-      <PackagePath>UmbracoProject</PackagePath>
-    </Content>
-    <Content Include="..\src\Umbraco.Web.UI\Views\Partials\blocklist\**">
-      <Link>UmbracoProject\Views\Partials\blocklist\%(RecursiveDir)%(Filename)%(Extension)</Link>
-      <PackagePath>UmbracoProject\Views\Partials\blocklist</PackagePath>
-    </Content>
-    <Content Include="..\src\Umbraco.Web.UI\Views\Partials\grid\**">
-      <Link>UmbracoProject\Views\Partials\grid\%(RecursiveDir)%(Filename)%(Extension)</Link>
-      <PackagePath>UmbracoProject\Views\Partials\grid</PackagePath>
-    </Content>
-    <Content Include="..\src\Umbraco.Web.UI\Views\Partials\blockgrid\**">
-      <Link>UmbracoProject\Views\Partials\blockgrid\%(RecursiveDir)%(Filename)%(Extension)</Link>
-      <PackagePath>UmbracoProject\Views\Partials\blockgrid</PackagePath>
-    </Content>
-    <Content Include="..\src\Umbraco.Web.UI\Views\_ViewImports.cshtml">
-      <Link>UmbracoProject\Views\_ViewImports.cshtml</Link>
-      <PackagePath>UmbracoProject\Views</PackagePath>
-    </Content>
-    <Content Include="..\src\Umbraco.Web.UI\wwwroot\favicon.ico">
-      <Link>UmbracoProject\wwwroot\favicon.ico</Link>
-      <PackagePath>UmbracoProject\wwwroot</PackagePath>
-    </Content>
-  </ItemGroup>
+	<ItemGroup>
+		<Content Include="UmbracoPackage\**" Exclude="bin;obj" />
+		<Content Include="UmbracoProject\**" Exclude="bin;obj" />
+		<Content Include="..\src\Umbraco.Web.UI\Program.cs">
+			<Link>UmbracoProject\Program.cs</Link>
+			<PackagePath>UmbracoProject</PackagePath>
+		</Content>
+		<Content Include="..\src\Umbraco.Web.UI\Views\Partials\blocklist\**">
+			<Link>UmbracoProject\Views\Partials\blocklist\%(RecursiveDir)%(Filename)%(Extension)</Link>
+			<PackagePath>UmbracoProject\Views\Partials\blocklist</PackagePath>
+		</Content>
+		<Content Include="..\src\Umbraco.Web.UI\Views\Partials\grid\**">
+			<Link>UmbracoProject\Views\Partials\grid\%(RecursiveDir)%(Filename)%(Extension)</Link>
+			<PackagePath>UmbracoProject\Views\Partials\grid</PackagePath>
+		</Content>
+		<Content Include="..\src\Umbraco.Web.UI\Views\Partials\blockgrid\**">
+			<Link>UmbracoProject\Views\Partials\blockgrid\%(RecursiveDir)%(Filename)%(Extension)</Link>
+			<PackagePath>UmbracoProject\Views\Partials\blockgrid</PackagePath>
+		</Content>
+		<Content Include="..\src\Umbraco.Web.UI\Views\_ViewImports.cshtml">
+			<Link>UmbracoProject\Views\_ViewImports.cshtml</Link>
+			<PackagePath>UmbracoProject\Views</PackagePath>
+		</Content>
+		<Content Include="..\src\Umbraco.Web.UI\wwwroot\favicon.ico">
+			<Link>UmbracoProject\wwwroot\favicon.ico</Link>
+			<PackagePath>UmbracoProject\wwwroot</PackagePath>
+		</Content>
+	</ItemGroup>
 
-  <!-- Update template.json files with the default UmbracoVersion value set to the current build version -->
-  <ItemGroup>
-    <PackageReference Include="Umbraco.JsonSchema.Extensions" Version="0.3.0" PrivateAssets="all" />
-  </ItemGroup>
-  <ItemGroup>
-    <Content Update="**\.template.config\template.json" Pack="false" />
-  </ItemGroup>
-  <Target Name="GetUpdatedTemplateJsonPackageFiles" BeforeTargets="GenerateNuspec" AfterTargets="GetUmbracoBuildVersion">
-    <ItemGroup>
-      <_TemplateJsonFiles Include="**\.template.config\template.json" Exclude="bin\**;obj\**" />
-      <_TemplateJsonFiles>
-        <DestinationFile>$(IntermediateOutputPath)%(RelativeDir)%(Filename)%(Extension)</DestinationFile>
-      </_TemplateJsonFiles>
-    </ItemGroup>
-    <Copy SourceFiles="@(_TemplateJsonFiles)" DestinationFiles="%(DestinationFile)" />
-    <JsonPathUpdateValue JsonFile="%(_TemplateJsonFiles.DestinationFile)" Path="$.symbols.UmbracoVersion.defaultValue" Value="&quot;$(PackageVersion)&quot;" />
-    <ItemGroup>
-      <_PackageFiles Include="%(_TemplateJsonFiles.DestinationFile)">
-        <PackagePath>%(_TemplateJsonFiles.RelativeDir)</PackagePath>
-      </_PackageFiles>
-    </ItemGroup>
-  </Target>
+	<!-- Update template.json files with the default UmbracoVersion value set to the current build version -->
+	<ItemGroup>
+		<PackageReference Include="Umbraco.JsonSchema.Extensions" Version="0.3.0" PrivateAssets="all" />
+	</ItemGroup>
+	<ItemGroup>
+		<Content Update="**\.template.config\template.json" Pack="false" />
+	</ItemGroup>
+	<Target Name="GetUpdatedTemplateJsonPackageFiles" BeforeTargets="GenerateNuspec" AfterTargets="GetUmbracoBuildVersion">
+		<ItemGroup>
+			<_TemplateJsonFiles Include="**\.template.config\template.json" Exclude="bin\**;obj\**" />
+			<_TemplateJsonFiles>
+				<DestinationFile>$(IntermediateOutputPath)%(RelativeDir)%(Filename)%(Extension)</DestinationFile>
+			</_TemplateJsonFiles>
+		</ItemGroup>
+		<Copy SourceFiles="@(_TemplateJsonFiles)" DestinationFiles="%(DestinationFile)" />
+		<JsonPathUpdateValue JsonFile="%(_TemplateJsonFiles.DestinationFile)" Path="$.symbols.UmbracoVersion.defaultValue" Value="&quot;$(PackageVersion)&quot;" />
+		<ItemGroup>
+			<_PackageFiles Include="%(_TemplateJsonFiles.DestinationFile)">
+				<PackagePath>%(_TemplateJsonFiles.RelativeDir)</PackagePath>
+			</_PackageFiles>
+		</ItemGroup>
+	</Target>
 </Project>
diff --git a/templates/UmbracoPackage/.template.config/dotnetcli.host.json b/templates/UmbracoPackage/.template.config/dotnetcli.host.json
@@ -13,6 +13,10 @@
     "SkipRestore": {
       "longName": "no-restore",
       "shortName": ""
+    },
+    "SupportPagesAndViews": {
+      "longName": "support-pages-and-views",
+      "shortName": "s"
     }
   }
 }
diff --git a/templates/UmbracoPackage/.template.config/ide.host.json b/templates/UmbracoPackage/.template.config/ide.host.json
@@ -4,12 +4,17 @@
   "icon": "../../icon.png",
   "description": {
     "id": "UmbracoPackage",
-    "text": "Umbraco Package - An empty Umbraco CMS package/plugin."
+    "text": "Umbraco Package - An empty Umbraco package/plugin."
   },
   "symbolInfo": [
     {
       "id": "UmbracoVersion",
       "isVisible": true
+    },
+    {
+      "id": "SupportPagesAndViews",
+      "isVisible": true,
+      "persistenceScope": "templateGroup"
     }
   ]
 }
diff --git a/templates/UmbracoPackage/.template.config/template.json b/templates/UmbracoPackage/.template.config/template.json
@@ -9,7 +9,7 @@
     "Plugin"
   ],
   "name": "Umbraco Package",
-  "description": "An empty Umbraco package/plugin project ready to get started.",
+  "description": "An empty Umbraco package/plugin.",
   "groupIdentity": "Umbraco.Templates.UmbracoPackage",
   "identity": "Umbraco.Templates.UmbracoPackage.CSharp",
   "shortName": "umbracopackage",
@@ -51,39 +51,12 @@
       "datatype": "bool",
       "defaultValue": "false"
     },
-    "Namespace": {
-      "type": "derived",
-      "valueSource": "name",
-      "valueTransform": "safe_namespace",
-      "fileRename": "UmbracoPackage",
-      "replaces": "UmbracoPackage"
-    },
-    "MsBuildName": {
-      "type": "generated",
-      "generator": "regex",
-      "dataType": "string",
-      "parameters": {
-        "source": "name",
-        "steps": [
-          {
-            "regex": "\\s",
-            "replacement": ""
-          },
-          {
-            "regex": "\\.",
-            "replacement": ""
-          },
-          {
-            "regex": "-",
-            "replacement": ""
-          },
-          {
-            "regex": "^[^a-zA-Z_]+",
-            "replacement": ""
-          }
-        ]
-      },
-      "replaces": "UmbracoPackageMsBuild"
+    "SupportPagesAndViews": {
+      "type": "parameter",
+      "datatype": "bool",
+      "defaultValue": "false",
+      "displayName": "Support pages and views",
+      "description": "Whether to support adding traditional Razor pages and Views to this library."
     }
   },
   "primaryOutputs": [

diff --git a/templates/UmbracoPackage/App_Plugins/UmbracoPackage/package.manifest b/templates/UmbracoPackage/App_Plugins/UmbracoPackage/package.manifest
diff --git a/templates/UmbracoPackage/UmbracoPackage.csproj b/templates/UmbracoPackage/UmbracoPackage.csproj
@@ -1,22 +1,27 @@
-<Project Sdk="Microsoft.NET.Sdk">
-  <PropertyGroup>
-    <TargetFramework>net8.0</TargetFramework>
-    <ContentTargetFolders>.</ContentTargetFolders>
-    <Product>UmbracoPackage</Product>
-    <PackageId>UmbracoPackage</PackageId>
-    <Title>UmbracoPackage</Title>
-    <Description>...</Description>
-    <PackageTags>umbraco plugin package</PackageTags>
-    <RootNamespace Condition="'$(name)' != '$(name{-VALUE-FORMS-}safe_namespace)'">UmbracoPackage</RootNamespace>
-  </PropertyGroup>
+<Project Sdk="Microsoft.NET.Sdk.Razor">
+	<PropertyGroup>
+		<TargetFramework>net8.0</TargetFramework>
+		<Nullable>enable</Nullable>
+		<ImplicitUsings>enable</ImplicitUsings>
+		<AddRazorSupportForMvc Condition="'$(SupportPagesAndViews)' == 'True'">true</AddRazorSupportForMvc>
+		<RootNamespace Condition="'$(name)' != '$(name{-VALUE-FORMS-}safe_namespace)'">UmbracoPackage</RootNamespace>
+		<StaticWebAssetBasePath>App_Plugins/UmbracoPackage</StaticWebAssetBasePath>
+	</PropertyGroup>
 
-  <ItemGroup>
-    <PackageReference Include="Umbraco.Cms.Web.Website" Version="UMBRACO_VERSION_FROM_TEMPLATE" />
-    <PackageReference Include="Umbraco.Cms.Web.BackOffice" Version="UMBRACO_VERSION_FROM_TEMPLATE" />
-  </ItemGroup>
+	<PropertyGroup>
+		<PackageId>UmbracoPackage</PackageId>
+		<Product>UmbracoPackage</Product>
+		<Title>UmbracoPackage</Title>
+		<Description>...</Description>
+		<PackageTags>umbraco plugin package</PackageTags>
+	</PropertyGroup>
 
-  <ItemGroup>
-    <Content Include="App_Plugins\UmbracoPackage\**" ExcludeFromSingleFile="true" CopyToPublishDirectory="Always" />
-    <None Include="buildTransitive\**" Pack="true" PackagePath="buildTransitive" />
-  </ItemGroup>
+	<ItemGroup Condition="'$(SupportPagesAndViews)' == 'True'">
+		<FrameworkReference Include="Microsoft.AspNetCore.App" />
+	</ItemGroup>
+
+	<ItemGroup>
+		<PackageReference Include="Umbraco.Cms.Web.Website" Version="UMBRACO_VERSION_FROM_TEMPLATE" />
+		<PackageReference Include="Umbraco.Cms.Web.BackOffice" Version="UMBRACO_VERSION_FROM_TEMPLATE" />
+	</ItemGroup>
 </Project>
diff --git a/templates/UmbracoPackage/buildTransitive/UmbracoPackage.targets b/templates/UmbracoPackage/buildTransitive/UmbracoPackage.targets
diff --git a/templates/UmbracoPackage/wwwroot/package.manifest b/templates/UmbracoPackage/wwwroot/package.manifest
@@ -0,0 +1,5 @@
+{
+  "id": "UmbracoPackage",
+  "name": "UmbracoPackage",
+  "allowPackageTelemetry": true
+}
diff --git a/templates/UmbracoPackageRcl/.template.config/dotnetcli.host.json b/templates/UmbracoPackageRcl/.template.config/dotnetcli.host.json
diff --git a/templates/UmbracoPackageRcl/.template.config/ide.host.json b/templates/UmbracoPackageRcl/.template.config/ide.host.json
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# Do not inherit customized EditorConfig for template content
		root = true