refactor(sln): repo-template token replacement, docs, extra files

Kentico · Mar 20, 2024 · 20646ab · 20646ab
1 parent 4cfe1d0
commit 20646ab
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 93 deletions.
diff --git a/.gitignore b/.gitignore
@@ -137,6 +137,3 @@ segments_2i
 **/Client/dist/*
 
 **/CMSModules/WebFarm/*
-
-# Files Generated by this integration
-**/App_Data/RepoTemplate/*
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,7 +1,6 @@
 {
   "recommendations": [
     "ms-dotnettools.csdevkit",
-    "k--kato.docomment",
     "editorconfig.editorconfig",
     "davidanson.vscode-markdownlint",
     "tintoy.msbuild-project-tools",

diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -9,9 +9,9 @@
       "type": "coreclr",
       "request": "launch",
       "preLaunchTask": "build",
-      "program": "${workspaceFolder}/src/Kentico.Xperience.RepoTemplate.Sample/bin/Debug/net6.0/DancingGoat.dll",
+      "program": "${workspaceFolder}/src/Kentico.Xperience.MiniProfiler.Sample/bin/Debug/net8.0/DancingGoat.dll",
       "args": [],
-      "cwd": "${workspaceFolder}/src/Kentico.Xperience.RepoTemplate.Sample",
+      "cwd": "${workspaceFolder}/src/Kentico.Xperience.MiniProfiler.Sample",
       "stopAtEntry": false,
       "serverReadyAction": {
         "action": "openExternally",

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -30,11 +30,8 @@
     "editor.defaultFormatter": "ms-dotnettools.csharp"
   },
 
-  "dotnet.defaultSolution": "Kentico.Xperience.RepoTemplate.sln",
+  "dotnet.defaultSolution": "Kentico.Xperience.MiniProfiler.sln",
 
-  "eslint.workingDirectories": [
-    "./src/Kentico.Xperience.RepoTemplate/Admin/Client"
-  ],
   "[aspnetcorerazor]": {
     "editor.defaultFormatter": "ms-dotnettools.csharp"
   },

diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -1,15 +1,6 @@
 {
   "version": "2.0.0",
   "tasks": [
-    {
-      "type": "npm",
-      "script": "install",
-      "path": "src/Kentico.Xperience.RepoTemplate/Admin/Client",
-      "group": "clean",
-      "problemMatcher": [],
-      "label": "npm: install - src/Kentico.Xperience.RepoTemplate/Admin/Client",
-      "detail": "install dependencies from package"
-    },
     {
       "type": "dotnet",
       "task": "build",
@@ -24,7 +15,7 @@
       "problemMatcher": ["$msCompile"],
       "group": "none",
       "options": {
-        "cwd": "${workspaceFolder}/src/Kentico.Xperience.RepoTemplate/"
+        "cwd": "${workspaceFolder}/src/Kentico.Xperience.MiniProfiler/"
       },
       "label": "dotnet: format"
     },
@@ -35,32 +26,6 @@
       "group": "clean",
       "label": "dotnet: clean"
     },
-    {
-      "type": "npm",
-      "script": "build",
-      "path": "src/Kentico.Xperience.RepoTemplate/Admin/Client",
-      "group": "build",
-      "problemMatcher": [],
-      "label": "npm: build - src/Kentico.Xperience.RepoTemplate/Admin/Client",
-      "detail": "webpack --mode=production"
-    },
-    {
-      "type": "npm",
-      "script": "build:dev",
-      "path": "src/Kentico.Xperience.RepoTemplate/Admin/Client",
-      "group": "build",
-      "problemMatcher": [],
-      "label": "npm: build:dev - src/Kentico.Xperience.RepoTemplate/Admin/Client",
-      "detail": "webpack --mode=development"
-    },
-    {
-      "type": "npm",
-      "script": "start",
-      "path": "src/Kentico.Xperience.RepoTemplate/Admin/Client",
-      "problemMatcher": [],
-      "label": "npm: start - src/Kentico.Xperience.RepoTemplate/Admin/Client",
-      "detail": "webpack serve --mode development"
-    },
     {
       "label": "dotnet: watch DancingGoat",
       "command": "dotnet",
@@ -69,7 +34,7 @@
         "watch",
         "run",
         "--project",
-        "${workspaceFolder}/src/Kentico.Xperience.RepoTemplate.Sample/DancingGoat.csproj"
+        "${workspaceFolder}/examples/DancingGoat/DancingGoat.csproj"
       ],
       "options": {
         "env": {

diff --git a/Directory.Build.props b/Directory.Build.props
@@ -30,7 +30,7 @@
     <CopyDocumentationFilesFromPackages>true</CopyDocumentationFilesFromPackages>
     <CopyDebugSymbolFilesFromPackages>true</CopyDebugSymbolFilesFromPackages>
     <NoWarn>$(NoWarn);1591</NoWarn>
-    <RootNamespace>Kentico.Xperience.RepoTemplate</RootNamespace>
+    <RootNamespace>Kentico.Xperience.MiniProfiler</RootNamespace>
 
     <EnableDefaultEmbeddedResourceItems>false</EnableDefaultEmbeddedResourceItems>
     <TimestampServerUrl>http://timestamp.digicert.com</TimestampServerUrl>

diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -4,14 +4,14 @@
     <CentralPackageVersionOverrideEnabled>false</CentralPackageVersionOverrideEnabled>
     <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
     <DisableImplicitNuGetFallbackFolder>true</DisableImplicitNuGetFallbackFolder>
-	<CentralPackageFloatingVersionsEnabled Condition="'$(LOCAL_NUGET)' == 'true'">true</CentralPackageFloatingVersionsEnabled>
+    <CentralPackageFloatingVersionsEnabled Condition="'$(LOCAL_NUGET)' == 'true'">true</CentralPackageFloatingVersionsEnabled>
   </PropertyGroup>
   <ItemGroup>
     <PackageVersion Include="Kentico.Xperience.Admin" Version="28.3.1" />
     <PackageVersion Include="Kentico.Xperience.WebApp" Version="28.3.1" />
     <PackageVersion Include="kentico.xperience.azurestorage" Version="28.3.1" />
     <PackageVersion Include="kentico.xperience.imageprocessing" Version="28.3.1" />
-	<PackageVersion Include="Kentico.Xperience.MiniProfiler" Version="" Condition="'$(LOCAL_NUGET)' == 'true'" />
+    <PackageVersion Include="Kentico.Xperience.MiniProfiler" Version="" Condition="'$(LOCAL_NUGET)' == 'true'" />
     <PackageVersion Include="MiniProfiler.AspNetCore.Mvc" Version="4.3.8" />
     <PackageVersion Include="SonarAnalyzer.CSharp" Version="9.6.0.74858" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />

diff --git a/Kentico.Xperience.RepoTemplate.sln b/Kentico.Xperience.RepoTemplate.sln
diff --git a/docs/Contributing-Setup.md b/docs/Contributing-Setup.md
@@ -1,15 +1,12 @@
 # Contributing Setup
 
----This documents the steps a maintainer or developer would follow to work on the library in their development environment---
----Update the details for this project, replacing "repotemplate" and anything else that needs changed---
-
 ## Required Software
 
 The requirements to setup, develop, and build this project are listed below.
 
 ### .NET Runtime
 
-.NET SDK 7.0 or newer
+.NET SDK 8.0 or newer
 
 - <https://dotnet.microsoft.com/en-us/download/dotnet/8.0>
 - See `global.json` file for specific SDK requirements
@@ -47,19 +44,6 @@ Running the sample project requires creating a new Xperience by Kentico database
 Change directory in your console to `./examples/DancingGoat` and follow the instructions in the Xperience
 documentation on [creating a new database](https://docs.xperience.io/xp26/developers-and-admins/installation#Installation-CreatetheprojectdatabaseCreateProjectDatabase).
 
-### Admin Customization
-
-To run the Sample app Admin customization in development mode, add the following to your [User Secrets](https://learn.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-7.0&tabs=windows#secret-manager) for the application.
-
-```json
-"CMSAdminClientModuleSettings": {
-  "kentico-xperience-integrations-repotemplate": {
-    "Mode": "Proxy",
-    "Port": 3009
-  }
-}
-```
-
 ## Development Workflow
 
 1. Create a new branch with one of the following prefixes
@@ -68,7 +52,7 @@ To run the Sample app Admin customization in development mode, add the following
    - `refactor/` - for restructuring of existing features
    - `fix/` - for bugfixes
 
-1. Run `dotnet format` against the `src/Kentico.Xperience.RepoTemplate` project
+1. Run `dotnet format` against the `src/Kentico.Xperience.MiniProfiler` project
 
    > use `dotnet: format` VS Code task.
 

diff --git a/examples/DancingGoat/DancingGoat.csproj b/examples/DancingGoat/DancingGoat.csproj
@@ -3,8 +3,8 @@
     <RootNamespace>DancingGoat</RootNamespace>
     <UserSecretsId>79c858af-5444-4954-8d08-6592a961e82a</UserSecretsId>
     <SeparatedAdmin Condition="'$(SeparatedAdmin)' == ''">false</SeparatedAdmin>
-	<Nullable>annotations</Nullable>
-	<RunAnalyzersDuringBuild>false</RunAnalyzersDuringBuild>
+    <Nullable>annotations</Nullable>
+    <RunAnalyzersDuringBuild>false</RunAnalyzersDuringBuild>
   </PropertyGroup>
   <ItemGroup>
     <None Remove="App_Data\CMSModules\WebFarm\webfarm.sync" />
@@ -20,10 +20,10 @@
     <DefineConstants>$(DefineConstants);SEPARATED_ADMIN</DefineConstants>
   </PropertyGroup>
   <ItemGroup>
-	  <PackageReference Include="kentico.xperience.admin" Condition="'$(SeparatedAdmin)' == 'false'" />
-	  <PackageReference Include="kentico.xperience.azurestorage" />
-	  <PackageReference Include="kentico.xperience.imageprocessing" />
-	  <PackageReference Include="kentico.xperience.webapp" />
+    <PackageReference Include="kentico.xperience.admin" Condition="'$(SeparatedAdmin)' == 'false'" />
+    <PackageReference Include="kentico.xperience.azurestorage" />
+    <PackageReference Include="kentico.xperience.imageprocessing" />
+    <PackageReference Include="kentico.xperience.webapp" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\..\src\Kentico.Xperience.MiniProfiler\Kentico.Xperience.MiniProfiler.csproj" />