Merge pull request #15 from luboshl/feature/validation-settings

Opt-out validation of non-nullable reference types

README.md

@@ -43,6 +43,58 @@ class Widget
 }
 ```
 
+### Skip validation
+
+You can set property to be skipped when validation is performed by setting `SkipValidationAttribute`
+on it. If you want to perform validation on the property, but not to validate it recursively
+(validate properties of the property), you can set `SkipRecursionAttribute` on it.
+
+When you use `SkipValidationAttribute` on a property, recursion is also skipped for that property.
+
+```csharp
+class Model
+{
+    [SkipValidation]
+    public string Name => throw new InvalidOperationException();
+
+    public ValidChild ValidChild { get; set; }
+
+    public ValidChildWithInvalidSkippedProperty ValidChildWithInvalidSkippedProperty { get; set; }
+
+    [SkipRecursion]
+    public InvalidChild InvalidChild { get; set; }
+}
+
+class ValidChild
+{
+    [Range(10, 100)]
+    public int TenOrMore { get; set; } = 10;
+}
+
+class ValidChildWithInvalidSkippedProperty
+{
+    // Property is invalid but is skipped
+    [SkipValidation]
+    public string Name { get; set; } = null!;
+}
+
+class InvalidChild
+{
+    // Property is invalid
+    [Range(10, 100)]
+    public int TenOrMore { get; set; } = 3;
+}
+```
+
+### Opt-out validation of non-nullable reference types
+
+You can disable validation of properties that are non-nullable reference types by configuring `ValidationSettings`:
+
+```csharp
+var validationSettings = ValidationSettings.Default with { ValidateNonNullableReferenceTypes = false };
+var isValid = MiniValidatorPlus.TryValidate(objectToValidate, validationSettings, out var errors);
+```
+
 ### Use services from validators
 
 ```csharp
@@ -217,48 +269,3 @@ class WidgetWithCustomValidation : Widget, IValidatableObject
     }
 }
 ```
-
-## Skip validation
-
-You can set property to be skipped when validation is performed by setting `SkipValidationAttribute`
-on it. If you want to perform validation on the property, but not to validate it recursively
-(validate properties of the property), you can set `SkipRecursionAttribute` on it.
-
-When you use `SkipValidationAttribute` on a property, recursion is also skipped for that property.
-
-### Examples
-
-```csharp
-class Model
-{
-    [SkipValidation]
-    public string Name => throw new InvalidOperationException();
-
-    public ValidChild ValidChild { get; set; }
-
-    public ValidChildWithInvalidSkippedProperty ValidChildWithInvalidSkippedProperty { get; set; }
-
-    [SkipRecursion]
-    public InvalidChild InvalidChild { get; set; }
-}
-
-class ValidChild
-{
-    [Range(10, 100)]
-    public int TenOrMore { get; set; } = 10;
-}
-
-class ValidChildWithInvalidSkippedProperty
-{
-    // Property is invalid but is skipped
-    [SkipValidation]
-    public string Name { get; set; } = null!;
-}
-
-class InvalidChild
-{
-    // Property is invalid
-    [Range(10, 100)]
-    public int TenOrMore { get; set; } = 3;
-}
-```

src/Directory.Build.props

@@ -1,7 +1,7 @@
 <Project>
 
   <PropertyGroup>
-    <VersionPrefix>1.1.0</VersionPrefix>
+    <VersionPrefix>1.2.0</VersionPrefix>
     <!-- VersionSuffix used for local builds -->
     <VersionSuffix>dev</VersionSuffix>
     <!-- VersionSuffix to be used for CI builds -->