Refactor remaining Project and Build files

- Simplify project files - Add and Update comments - Remove unnecessary lines - Rearrange and Order code blocks - Update Git Ignore to latest - Rename NuGet Icon to `Icon.png` - Normalize casing for `ReadMe.md` - Rename solution file to `CommunityToolkit.sln`
CommunityToolkit · Jun 3, 2022 · 456db4d · 456db4d
1 parent 16e21b6
commit 456db4d
Show file tree

Hide file tree

Showing 21 changed files with 255 additions and 215 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,14 +2,11 @@
 ## files generated by popular Visual Studio add-ons.
 
 # User-specific files
+*.rsuser
 *.suo
 *.user
 *.userosscache
 *.sln.docstates
-*.filters
-
-# User-specific files (MonoDevelop/Xamarin Studio)
-*.userprefs
 
 # Build results
 [Dd]ebug/
@@ -18,39 +15,63 @@
 [Rr]eleases/
 x64/
 x86/
-build/
+[Ww][Ii][Nn]32/
+[Aa][Rr][Mm]/
+[Aa][Rr][Mm]64/
 bld/
 [Bb]in/
 [Oo]bj/
+[Ee]xt/
+[Ll]og/
+[Ll]ogs/
 
-# Visual Studio 2015 cache/options directory
+# Visual Studio 14+ cache/options directory
 .vs/
+# Uncomment if you have tasks that create the project's static files in wwwroot
+#wwwroot/
+
+# Visual Studio 15+ auto generated files
+Generated\ Files/
 
 # MSTest test Results
 [Tt]est[Rr]esult*/
 [Bb]uild[Ll]og.*
 
-# NUNIT
+# NUnit
 *.VisualState.xml
 TestResult.xml
+nunit-*.xml
 
 # Build Results of an ATL Project
 [Dd]ebugPS/
 [Rr]eleasePS/
 dlldata.c
 
-# DNX
+# Benchmark Results
+BenchmarkDotNet.Artifacts/
+
+# .NET Core
 project.lock.json
+project.fragment.lock.json
 artifacts/
 
+# ASP.NET Scaffolding
+ScaffoldingReadMe.txt
+
+# StyleCop
+StyleCopReport.xml
+
+# Files built by Visual Studio
 *_i.c
 *_p.c
-*_i.h
+*_h.h
 *.ilk
 *.meta
 *.obj
+*.iobj
 *.pch
 *.pdb
+*.ipdb
 *.pgc
 *.pgd
 *.rsp
@@ -60,7 +81,9 @@ artifacts/
 *.tlh
 *.tmp
 *.tmp_proj
+*_wpftmp.csproj
 *.log
+*.tlog
 *.vspscc
 *.vssscc
 .builds
@@ -75,17 +98,21 @@ _Chutzpah*
 ipch/
 *.aps
 *.ncb
+*.opendb
 *.opensdf
 *.sdf
 *.cachefile
+*.VC.db
+*.VC.VC.opendb
 
 # Visual Studio profiler
 *.psess
 *.vsp
 *.vspx
+*.sap
 
-# TFS 2012 Local Workspace
-$tf/
+# Visual Studio Trace Files
+*.e2e
 
 # Guidance Automation Toolkit
 *.gpState
@@ -95,84 +122,82 @@ _ReSharper*/
 *.[Rr]e[Ss]harper
 *.DotSettings.user
 
-# JustCode is a .NET coding add-in
-.JustCode
-
 # TeamCity is a build add-in
 _TeamCity*
 
 # DotCover is a Code Coverage Tool
 *.dotCover
 
-# NCrunch
-_NCrunch_*
-.*crunch*.local.xml
+# AxoCover is a Code Coverage Tool
+.axoCover/*
+!.axoCover/settings.json
 
-# MightyMoose
-*.mm.*
-AutoTest.Net/
+# Coverlet is a free, cross platform Code Coverage Tool
+coverage*.json
+coverage*.xml
+coverage*.info
 
-# Web workbench (sass)
-.sass-cache/
+# Visual Studio code coverage results
+*.coverage
+*.coveragexml
 
 # Installshield output folder
 [Ee]xpress/
 
-# DocProject is a documentation generator add-in
-DocProject/buildhelp/
-DocProject/Help/*.HxT
-DocProject/Help/*.HxC
-DocProject/Help/*.hhc
-DocProject/Help/*.hhk
-DocProject/Help/*.hhp
-DocProject/Help/Html2
-DocProject/Help/html
-
 # Click-Once directory
 publish/
 
 # Publish Web Output
 *.[Pp]ublish.xml
 *.azurePubxml
-## TODO: Comment the next line if you want to checkin your
-## web deploy settings but do note that will include unencrypted
-## passwords
-#*.pubxml
-
+# Note: Comment the next line if you want to checkin your web deploy settings,
+# but database connection strings (with potential passwords) will be unencrypted
+*.pubxml
 *.publishproj
 
+# Microsoft Azure Web App publish settings. Comment the next line if you want to
+# checkin your Azure Web App publish settings, but sensitive information contained
+# in these scripts will be unencrypted
+PublishScripts/
+
 # NuGet Packages
 *.nupkg
+# NuGet Symbol Packages
+*.snupkg
 # The packages folder can be ignored because of Package Restore
-**/packages/*
+**/[Pp]ackages/*
 # except build/, which is used as an MSBuild target.
-!**/packages/build/
+!**/[Pp]ackages/build/
 # Uncomment if necessary however generally it will be regenerated when needed
-#!**/packages/repositories.config
-
-# Windows Azure Build Output
-csx/
-*.build.csdef
+#!**/[Pp]ackages/repositories.config
+# NuGet v3's project.json files produces more ignorable files
+*.nuget.props
+*.nuget.targets
 
-# Windows Store app package directory
+# Windows Store app package directories and files
 AppPackages/
+BundleArtifacts/
+Package.StoreAssociation.xml
+_pkginfo.txt
+*.appx
+*.appxbundle
+*.appxupload
 
 # Visual Studio cache files
 # files ending in .cache can be ignored
 *.[Cc]ache
 # but keep track of directories ending in .cache
-!*.[Cc]ache/
+!?*.[Cc]ache/
 
 # Others
 ClientBin/
-[Ss]tyle[Cc]op.*
 ~$*
 *~
 *.dbmdl
 *.dbproj.schemaview
+*.jfm
 *.pfx
 *.publishsettings
-node_modules/
 orleans.codegen.cs
 
 # RIA/Silverlight projects
@@ -185,50 +210,54 @@ _UpgradeReport_Files/
 Backup*/
 UpgradeLog*.XML
 UpgradeLog*.htm
-
-# SQL Server files
-*.mdf
-*.ldf
-
-# Business Intelligence projects
-*.rdl.data
-*.bim.layout
-*.bim_*.settings
+ServiceFabricBackup/
+*.rptproj.bak
 
 # Microsoft Fakes
 FakesAssemblies/
 
-# Node.js Tools for Visual Studio
-.ntvs_analysis.dat
+# CodeRush personal settings
+.cr/personal
 
-# Visual Studio 6 build log
-*.plg
+# MSBuild Binary and Structured Log
+*.binlog
 
-# Visual Studio 6 workspace options file
-*.opt
+# MFractors (Xamarin productivity tool) working folder
+.mfractor/
 
-# LightSwitch generated files
-GeneratedArtifacts/
-_Pvt_Extensions/
-ModelManifest.xml
-BundleArtifacts
-!/build
-/build/tools/GitVersion.CommandLine
-AppPackages
+# Local History for Visual Studio
+.localhistory/
 
-# NuGet V3 artifacts
-*-packages.config
-*.nuget.props
-*.nuget.targets
-project.lock.json
-msbuild.binlog
-*.project.lock.json
-/build/tools/**
-!/build/tools/packages.config
+# Visual Studio History (VSHistory) files
+.vshistory/
 
-# Generated file from .ttinclude
-**/Generated/TypeInfo.g.cs
+# Backup folder for Package Reference Convert tool in Visual Studio 2017
+MigrationBackup/
 
-# TAEF Log output
-WexLogFileOutput
-*.wtl
+# VS Code files for those working on multiple tools
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+# Windows Installer files from build outputs
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# JetBrains Rider
+*.sln.iml
+
+# MSBuild response files
+!MSBuild.rsp
+!Directory.Build.rsp
+
+# Generated file from .ttinclude
+**/Generated/*.g.cs
diff --git a/CommunityToolkit.Common/CommunityToolkit.Common.csproj b/CommunityToolkit.Common/CommunityToolkit.Common.csproj
@@ -14,8 +14,11 @@
     <PackageTags>Incremental;Loading;Collection;IncrementalLoadingCollection;String;Array;Extensions;Helpers</PackageTags>
   </PropertyGroup>
 
-  <!-- .NET Standard 2.1 and .NET 6 already have [NotNullIfNotNull] and [NotNullWhen].
-       Additionally, also enable trimming support on .NET 6. -->
+  <!--
+      Use `NETSTANDARD2_1_OR_GREATER` define to include .NET Standard 2.1 and .NET 6 shared APIs.
+      They already have `[NotNullIfNotNull]` and `[NotNullWhen]` attributes built-in.
+      Additionally, enable assembly trimming on .NET 6+
+  -->
   <PropertyGroup Condition="'$(TargetFramework)' == 'net6.0'">
     <DefineConstants>NETSTANDARD2_1_OR_GREATER</DefineConstants>
     <EnableTrimAnalyzer>true</EnableTrimAnalyzer>

diff --git a/CommunityToolkit.Diagnostics/CommunityToolkit.Diagnostics.csproj b/CommunityToolkit.Diagnostics/CommunityToolkit.Diagnostics.csproj
@@ -24,17 +24,17 @@
     </When>
 
     <When Condition="'$(TargetFramework)' == 'netstandard2.1'">
-      <PropertyGroup>
-        <DefineConstants>NETSTANDARD2_1_OR_GREATER</DefineConstants>
-      </PropertyGroup>
 
       <!-- .NET Standard 2.1 doesn't have the Unsafe type -->
       <ItemGroup>
         <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.0.0" />
       </ItemGroup>
     </When>
 
-    <!-- Enable trimming support on .NET 6 -->
+    <!--
+        Use `NETSTANDARD2_1_OR_GREATER` define to include .NET Standard 2.1 and .NET 6 shared APIs.
+        Additionally, enable assembly trimming on .NET 6+
+    -->
     <When Condition="'$(TargetFramework)' == 'net6.0'">
       <PropertyGroup>
         <DefineConstants>NETSTANDARD2_1_OR_GREATER</DefineConstants>
@@ -44,6 +44,12 @@
     </When>
   </Choose>
 
+  <!-- T4 service used by the Guard APIs -->
+  <ItemGroup>
+    <Service Include="{508349b6-6b84-4df5-91f0-309beebad82d}" />
+  </ItemGroup>
+
+  <!-- Text Templates to generate sources -->
   <ItemGroup>
     <None Update="Generated\Guard.Comparable.Numeric.tt">
       <Generator>TextTemplatingFileGenerator</Generator>
@@ -63,11 +69,7 @@
     </None>
   </ItemGroup>
 
-  <!-- T4 service used by the Guard APIs -->
-  <ItemGroup>
-    <Service Include="{508349b6-6b84-4df5-91f0-309beebad82d}" />
-  </ItemGroup>
-
+  <!-- Sources generated based on the above text templates -->
   <ItemGroup>
     <Compile Update="Generated\Guard.Comparable.Numeric.g.cs">
       <DesignTime>True</DesignTime>