Skip to content
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.

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

Fix: Clean up project files #5

Merged
merged 3 commits into from
Apr 30, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,3 @@ segments_2i
**/Client/dist/*

**/CMSModules/WebFarm/*

# Files Generated by this integration
**/App_Data/RepoTemplate/*
1 change: 0 additions & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"recommendations": [
"ms-dotnettools.csdevkit",
"k--kato.docomment",
"editorconfig.editorconfig",
"davidanson.vscode-markdownlint",
"tintoy.msbuild-project-tools",
Expand Down
4 changes: 2 additions & 2 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
5 changes: 1 addition & 4 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
39 changes: 2 additions & 37 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -24,7 +15,7 @@
"problemMatcher": ["$msCompile"],
"group": "none",
"options": {
"cwd": "${workspaceFolder}/src/Kentico.Xperience.RepoTemplate/"
"cwd": "${workspaceFolder}/src/Kentico.Xperience.MiniProfiler/"
},
"label": "dotnet: format"
},
Expand All @@ -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",
Expand All @@ -69,7 +34,7 @@
"watch",
"run",
"--project",
"${workspaceFolder}/src/Kentico.Xperience.RepoTemplate.Sample/DancingGoat.csproj"
"${workspaceFolder}/examples/DancingGoat/DancingGoat.csproj"
],
"options": {
"env": {
Expand Down
2 changes: 1 addition & 1 deletion Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions Directory.Packages.props
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down
19 changes: 0 additions & 19 deletions Kentico.Xperience.RepoTemplate.sln

This file was deleted.

20 changes: 2 additions & 18 deletions docs/Contributing-Setup.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.

Expand Down
12 changes: 6 additions & 6 deletions examples/DancingGoat/DancingGoat.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand All @@ -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" />
Expand Down
Loading