v1.1

### Features

* Added helper text for classes and methods.

Author: bjorg

.github/workflows/dotnet.yml

@@ -21,7 +21,9 @@ jobs:
       - name: Restore dependencies
         run: dotnet restore Source/ArgumentAssert/ArgumentAssert.csproj
       - name: Build
-        run: dotnet build --no-restore Source/ArgumentAssert/ArgumentAssert.csproj
+        run: dotnet build --no-restore --configuration Release Source/ArgumentAssert/ArgumentAssert.csproj
+      - name: Pack
+        run: dotnet pack --no-build --configuration Release --include-symbols -p:SymbolPackageFormat=snupkg -o . Source/ArgumentAssert/ArgumentAssert.csproj
 
       # Build Samples
       - name: Build Assert Value Is In Range Sample
@@ -32,7 +34,4 @@ jobs:
       # Publish ArgumentAssert
       - name: Publish
         if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-        uses: brandedoutcast/[email protected]
-        with:
-            PROJECT_FILE_PATH: Source/ArgumentAssert/ArgumentAssert.csproj
-            NUGET_KEY: ${{ secrets.NUGET_API_KEY }}
+        run: dotnet nuget push *.nupkg --api-key ${{ secrets.NUGET_API_KEY }} --source "https://api.nuget.org/v3/index.json" --skip-duplicate

ReadMe.md

@@ -39,6 +39,19 @@ When the assertion fails, the exception message shows the failed expression.
 Unhandled exception. System.ArgumentAssertException: value is { Length: > 0 and < 10 }
 ```
 
+## Sample: Streamline calls to Assert()
+
+The following code uses the `using static` statement to expose the `Assert()` method without requiring the class name. This approach streamlines the code when many assertions are being performed throughout the codebase.
+```csharp
+using static System.ArgumentAssertException;
+
+int AssertValueIsInRange(int value) {
+    Assert(value is > 0 and < 10);
+    return value;
+}
+```
+
+
 ## License
 
 Licensed under the Apache License, Version 2.0 (the "License");

ReleaseNotes.md

@@ -1,5 +1,15 @@
 # Release Notes
 
+## v1.1 (2023-08-20)
+
+### Features
+
+* Added helper text for classes and methods.
+
+### Samples
+
+* Added `AssertGlobal` sample to show how to use `using static` to simplify calls to `Assert()` method.
+
 ## v1.0 (2022-02-14)
 
 ### Features

Samples/AssertGlobal/AssertGlobal.csproj

@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net6.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+  <ItemGroup>
+    <ProjectReference Include="../../Source/ArgumentAssert/ArgumentAssert.csproj"/>
+  </ItemGroup>
+</Project>

Samples/AssertGlobal/Program.cs

@@ -0,0 +1,8 @@
+using static System.ArgumentAssertException;
+
+AssertValueIsInRange(10);
+
+int AssertValueIsInRange(int value) {
+    Assert(value is > 0 and < 10);
+    return value;
+}

Source/ArgumentAssert/ArgumentAssert.csproj

@@ -5,10 +5,10 @@
     <Nullable>enable</Nullable>
 
     <PackageId>ArgumentAssert</PackageId>
-    <Version>1.0</Version>
+    <Version>1.1</Version>
     <Title>Argument Assertion Library</Title>
     <Description>Assert argument values and throw descriptive exceptions</Description>
-    <Copyright>Copyright (C) 2022</Copyright>
+    <Copyright>Copyright (C) 2022-2023</Copyright>
     <Authors>Bjorg</Authors>
 
     <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>

Source/ArgumentAssert/ArgumentAssertException.cs

@@ -19,9 +19,21 @@ namespace System;
 using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
 
+/// <summary>
+/// The <see cref="ArgumentAssertException"/> class represents an exception that is
+/// thrown when an assertion fails.
+/// </summary>
 public class ArgumentAssertException : ArgumentException {
 
     //--- Class Methods ---
+
+    /// <summary>
+    /// This method throws a <see cref="ArgumentAssertException"/> exception when the expression evaluates to false.
+    /// The method is annotated to inform code analysis about that the assertions of the expression are true when no
+    /// exception is thrown.
+    /// </summary>
+    /// <param name="expression">Expression to assert on</param>
+    /// <param name="expressionText">(optional) Text for exception message. The string equivalent of the expression is used when omitted.</param>
     public static void Assert(
         [DoesNotReturnIf(false)] bool expression,
         [CallerArgumentExpression("expression")] string? expressionText = default
@@ -38,4 +50,3 @@ public static void Assert(
     public ArgumentAssertException() { }
     public ArgumentAssertException(string? message) : base(message) { }
 }
-