Seal and Cleanup Classes (#49)

Author: MikeAlhayek

.editorconfig

@@ -310,4 +310,4 @@ dotnet_diagnostic.SA1650.severity = none            # Element documentation shou
 dotnet_diagnostic.SA1651.severity = none            # Do not use placeholder elements.
 
 # IDE0290: Use primary constructor
-dotnet_diagnostic.IDE0290.severity = none
+dotnet_diagnostic.IDE0290.severity = none

.github/copilot-instructions.md

@@ -69,21 +69,37 @@ Keep the docs focused on `CrestApps.Core`. If you need to mention the Orchard Co
 - After the last null-check/argument-validation line in a method, add a blank line before the next statement
 - If a method has only one null-check/argument-validation line, still add a blank line after that final guard line
 - Add a blank line before a `return` statement unless the `return` is the first statement inside a `{ ... }` block
+- Never use more than one consecutive blank line
 - Add a blank line before and after `if` blocks, `switch` statements, and loops unless the block is immediately preceded by `{`
 - Do not add a blank line between an `if`/`else`/`switch`/loop condition and its opening `{`
+- Do not add a blank line immediately after `#pragma warning disable` or immediately before `#pragma warning restore`
+- Do not add a blank line immediately after `#pragma warning restore` when the next line is `{`
+- Add a blank line before a `#pragma warning disable` block when it starts a new member after a closing `}`
+- Add a blank line between a `#pragma warning restore` and the next `#pragma warning disable` when they guard separate members
+- Format conditional operators across multiple lines with the condition on its own line and the `?` and `:` tokens on their own indented lines
 - Use `var` consistently with repository style
 - Do not use `global using` files; add explicit `using` directives at the top of each file instead.
 - Prefer top-of-file `using` directives over fully qualified type names in code.
 - Only use expression-bodied members when the entire member fits on a single short line; use a full block body for anything longer or split across lines
 - Avoid `DateTime.UtcNow`; prefer injected `TimeProvider`.
 - Keep public docs and comments honest to the current code.
-- Always document new interfaces, their methods and arguments along with documenting every property on domain models using `<summary>` block.
+- Always document every method, including constructor overloads, with accurate XML `<summary>` and `<param>` blocks for every argument.
+- Only add XML `<param>` tags for parameters that actually exist on the documented member, and keep them in the exact same order as the signature.
+- Always document publicly accessible properties with accurate XML `<summary>` blocks.
+- Always insert a blank line before XML `<summary>` documentation blocks unless they are immediately preceded by `{`.
+- Never insert a blank line between an XML documentation block and the member it documents.
+- If XML documentation already exists, improve the existing block in place instead of stacking a second `<summary>` block above it.
+- Always document new interfaces and all of their members and arguments.
+- When a constructor has more than one parameter, span its parameter list across multiple lines.
+- Put constructor initializer clauses like `: base(...)` on their own indented line
+- Seal publicly accessible classes by default and only leave them unsealed when inheritance is intentionally required.
 - Always treat warnings are errors in the solutions and ensure every warning is addressed.
 - Always learn from my prompts, preference and styles and update the `copilot-instructions.md` file with any new preferences that I share in the future.
 - Prefer SOLID and DRY refactors that consolidate duplicated provider, transport, or store logic into shared abstractions before adding new one-off implementations.
 - Favor additive shared infrastructure first, then migrate consumers in behavior-safe steps when a full replacement is too risky for a single change.
 - When working in framework code meant for external adoption, optimize for consistency and long-term maintainability across providers and hosts, not just local fixes.
 - For optional provider integrations in sample hosts, do not eagerly read validated options in UI setup paths when an unconfigured provider should simply appear unavailable rather than crash the page.
+- Always keep exactly one trailing newline at the end of each file, no more and no less.
 
 ## Runtime notes
 

.github/pull_request_template.md

@@ -1 +1 @@
-<!--- Please make sure that you're familiar with our contribution guidelines before submitting a pull request: https://docs.orchardcore.net/en/latest/guides/contributing/. -->
+<!--- Please make sure that you're familiar with our contribution guidelines before submitting a pull request: https://docs.orchardcore.net/en/latest/guides/contributing/. -->

.github/workflows/assets_validation.yml

@@ -47,20 +47,20 @@ jobs:
             Write-Output ''
             Write-Output '---------------------------------------'
             Write-Output ''
-        
+
             $changeLines = $changes -split '`n'
             $changedFiles = @()
             $hasNonCrlfChange = $false
-        
+
             foreach ($line in $changeLines)
             {
                 if ($line -match '^\s?(M|A|\?\?)\s+(.*)$')
                 {
                     $changeType = $matches[1]
                     $file = $matches[2]
-        
+
                     Write-Output "Diff for: $file"
-        
+
                     if ($changeType -eq 'M')
                     {
                         # File is modified; use git diff to get the diff of the modified file.
@@ -88,26 +88,26 @@ jobs:
                         Get-Content -Path $file
                         $hasNonCrlfChange = $true
                     }
-        
+
                     $changedFiles += $file
-        
+
                     Write-Output ''
                     Write-Output '---------------------------------------'
                     Write-Output ''
                 }
             }
-        
+
             if (-not $hasNonCrlfChange)
             {
                 Write-Output 'No non-CRLF changes found. Repository is clean.'
                 exit 0
             }
-        
+
             # Convert the array of changed files to a single string with each file on a new line so actions/upload-artifact
             # can consume it.
             $changedFilesString = $changedFiles -join "`n"
             "CHANGED_FILES<<ENDOFSTRING`n$($changedFilesString)`nENDOFSTRING" >> $Env:GITHUB_ENV
-        
+
             exit -1
         }
         else
@@ -121,4 +121,3 @@ jobs:
         name: changed-files
         path: ${{ env.CHANGED_FILES }}
         retention-days: 30
-

.github/workflows/backport.yml

@@ -19,9 +19,8 @@ jobs:
     uses: dotnet/arcade/.github/workflows/backport-base.yml@main
     with:
       repository_owners: 'CrestApps'
-      
+
       pr_description_template: |
         Backport of #%source_pr_number% to %target_branch%
 
         /cc %cc_users%
-

.github/workflows/codeql.yml

@@ -61,4 +61,3 @@ jobs:
         uses: github/codeql-action/analyze@v3
         with:
           category: "/language:javascript-typescript"
-

.github/workflows/copilot-setup-steps.yml

@@ -24,4 +24,3 @@ jobs:
 
       - name: Restore NuGet packages
         run: dotnet restore
-

.github/workflows/deploy_docs.yml

@@ -66,4 +66,3 @@ jobs:
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4
-

.github/workflows/main_ci.yml

@@ -41,4 +41,3 @@ jobs:
     - name: Unit Tests
       run: |
         dotnet test -c Release --no-build ./tests/CrestApps.Core.Tests/CrestApps.Core.Tests.csproj 
-

.github/workflows/pr_ci.yml

@@ -37,4 +37,3 @@ jobs:
     - name: Unit Tests
       run: |
         dotnet test -c Release --no-build ./tests/CrestApps.Core.Tests/CrestApps.Core.Tests.csproj 
-