Merge pull request #13 from BenjaminAbt/feature/nuget-enhancements

add nuget information
BenjaminAbt · Apr 2, 2024 · d61cbee · d61cbee
2 parents 19cf5ec + d943dae
commit d61cbee
Show file tree

Hide file tree

Showing 12 changed files with 27 additions and 43 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -11,31 +11,44 @@
             StrongOf helps to implement primitives as a strong type that represents a domain object (e.g. UserId, EmailAddress, etc.). It is a simple class that wraps a value and provides a few helper methods to make it easier to work with.
             In contrast to other approaches, StrongOf is above all simple and performant - and not over-engineered.
         </Description>
+        <DefaultLanguage>en-US</DefaultLanguage>
+        <NoPackageAnalysis>true</NoPackageAnalysis>
+        <DebugType>embedded</DebugType>
     </PropertyGroup>
 
-    <!-- Assembly -->
-    <PropertyGroup>
+    <PropertyGroup Label="Env">
+        <IsTestProject>$(MSBuildProjectName.Contains('Test'))</IsTestProject>
+        <IsBenchmarkProject>$(MsBuildProjectName.Contains('Benchmark'))</IsBenchmarkProject>
+    </PropertyGroup>
+
+    <PropertyGroup Label="Assembly">
         <GlobalNamespacePrefix>StrongOf</GlobalNamespacePrefix>
         <GlobalAssemblyNamePrefix>BenjaminAbt.StrongOf</GlobalAssemblyNamePrefix>
     </PropertyGroup>
 
-    <!-- Project Defaults -->
-    <PropertyGroup>
+    <PropertyGroup Label="Project Defaults">
         <TargetFrameworks>net7.0;net8.0</TargetFrameworks>
     </PropertyGroup>
 
-    <!-- Package -->
-    <PropertyGroup>
+    <PropertyGroup Label="Package">
         <IsPackable>false</IsPackable>
         <PackageProjectUrl>https://github.com/BenjaminAbt/StrongOf</PackageProjectUrl>
+        <PublishRepositoryUrl>true</PublishRepositoryUrl>
+        <Description>Primitive Obsession with .NET</Description>
+        <MinClientVersion>2.12</MinClientVersion>
         <PackageTags>Strong, StrongOf, DDD, Value Objects, Domain Driven Design</PackageTags>
+        <IsPackable>false</IsPackable>
+        <EmbedUntrackedSources>true</EmbedUntrackedSources>
     </PropertyGroup>
 
-    <!-- C# -->
-    <PropertyGroup>
+    <PropertyGroup Label="C#">
         <LangVersion>12.0</LangVersion>
         <Nullable>enable</Nullable>
         <ImplicitUsings>enable</ImplicitUsings>
         <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     </PropertyGroup>
+
+    <PropertyGroup Condition="'$(IsTestProject)' != 'true' AND '$(IsBenchmarkProject)' != 'true'">
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    </PropertyGroup>
 </Project>
diff --git a/src/StrongOf.AspNetCore/StrongOf.AspNetCore.csproj b/src/StrongOf.AspNetCore/StrongOf.AspNetCore.csproj
@@ -1,7 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
-    <!-- Package -->
-    <PropertyGroup>
+    <PropertyGroup Label="Package">
         <IsPackable>true</IsPackable>
         <PackageReadmeFile>readme.md</PackageReadmeFile>
         <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>

diff --git a/src/StrongOf.FluentValidation/StrongIn64Validators.cs b/src/StrongOf.FluentValidation/StrongIn64Validators.cs
@@ -40,7 +40,7 @@ public static class StrongIn64Validators
     /// <typeparam name="T">The type of the object being validated.</typeparam>
     /// <typeparam name="TStrong">The type of the strong Int64.</typeparam>
     /// <param name="rule">The rule builder.</param>
-    /// <param name="min">The maximum value.</param>
+    /// <param name="max">The maximum value.</param>
     /// <returns>The rule builder options.</returns>
     public static IRuleBuilderOptions<T, TStrong?> HasMaximum<T, TStrong>(this IRuleBuilder<T, TStrong?> rule, long max)
         where TStrong : StrongInt64<TStrong>

diff --git a/src/StrongOf.FluentValidation/StrongOf.FluentValidation.csproj b/src/StrongOf.FluentValidation/StrongOf.FluentValidation.csproj
@@ -1,7 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
-    <!-- Package -->
-    <PropertyGroup>
+    <PropertyGroup Label="Package">
         <IsPackable>true</IsPackable>
         <PackageReadmeFile>readme.md</PackageReadmeFile>
         <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>

diff --git a/src/StrongOf.Json/StrongOf.Json.csproj b/src/StrongOf.Json/StrongOf.Json.csproj
@@ -1,7 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
-    <!-- Package -->
-    <PropertyGroup>
+    <PropertyGroup Label="Package">
         <IsPackable>true</IsPackable>
         <PackageReadmeFile>readme.md</PackageReadmeFile>
         <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
@@ -17,6 +16,6 @@
     </ItemGroup>
 
     <ItemGroup>
-      <ProjectReference Include="..\StrongOf\StrongOf.csproj" />
+        <ProjectReference Include="..\StrongOf\StrongOf.csproj" />
     </ItemGroup>
 </Project>
diff --git a/src/StrongOf/StrongDateTime.Operators.cs b/src/StrongOf/StrongDateTime.Operators.cs
@@ -1,10 +1,5 @@
 namespace StrongOf;
 
-/// <summary>
-/// Represents a strongly typed DateTime value.
-/// </summary>
-/// <typeparam name="TStrong">The type of the strong DateTime.</typeparam>
-/// <remarks>"The DateTime type has some design flaws. Please migrate to DateTimeOffset."</remarks>
 public abstract partial class StrongDateTime<TStrong>
 {
     /// <summary>

diff --git a/src/StrongOf/StrongDateTimeOffset.Operators.cs b/src/StrongOf/StrongDateTimeOffset.Operators.cs
@@ -1,9 +1,5 @@
 namespace StrongOf;
 
-/// <summary>
-/// Represents a strongly typed DateTimeOffset.
-/// </summary>
-/// <typeparam name="TStrong">The type of the strong DateTimeOffset.</typeparam>
 public abstract partial class StrongDateTimeOffset<TStrong>
 {
     /// <summary>

diff --git a/src/StrongOf/StrongInt32.Operators.cs b/src/StrongOf/StrongInt32.Operators.cs
@@ -1,9 +1,5 @@
 namespace StrongOf;
 
-/// <summary>
-/// Represents a strong type of Int32.
-/// </summary>
-/// <typeparam name="TStrong">The type of the strong Int32.</typeparam>
 public abstract partial class StrongInt32<TStrong>
 {
     /// <summary>

diff --git a/src/StrongOf/StrongInt64.Operators.cs b/src/StrongOf/StrongInt64.Operators.cs
@@ -1,9 +1,5 @@
 namespace StrongOf;
 
-/// <summary>
-/// Represents a strong type of Int64.
-/// </summary>
-/// <typeparam name="TStrong">The type of the strong Int64.</typeparam>
 public abstract partial class StrongInt64<TStrong>
 {
     /// <summary>

diff --git a/src/StrongOf/StrongOf.csproj b/src/StrongOf/StrongOf.csproj
@@ -1,7 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
-    <!-- Package -->
-    <PropertyGroup>
+    <PropertyGroup Label="Package">
         <IsPackable>true</IsPackable>
         <PackageReadmeFile>readme.md</PackageReadmeFile>
         <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>

diff --git a/src/StrongOf/StrongString.Methods.cs b/src/StrongOf/StrongString.Methods.cs
@@ -2,10 +2,6 @@
 
 namespace StrongOf;
 
-/// <summary>
-/// Represents a strong string of a specific type.
-/// </summary>
-/// <typeparam name="TStrong">The type of the strong string.</typeparam>
 public abstract partial class StrongString<TStrong>
 {
     /// <summary>

diff --git a/src/StrongOf/StrongString.Properties.cs b/src/StrongOf/StrongString.Properties.cs
@@ -1,9 +1,5 @@
 namespace StrongOf;
 
-/// <summary>
-/// Represents a strong string of a specific type.
-/// </summary>
-/// <typeparam name="TStrong">The type of the strong string.</typeparam>
 public abstract partial class StrongString<TStrong>
 {
     /// <summary>