Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/valit-stack/Valit
Valit is dead simple validation for .NET Core. No more if-statements all around your code. Write nice and clean fluent validators instead!
https://github.com/valit-stack/Valit
core dotnet fluent-api validation
Last synced: 9 days ago
JSON representation
Valit is dead simple validation for .NET Core. No more if-statements all around your code. Write nice and clean fluent validators instead!
- Host: GitHub
- URL: https://github.com/valit-stack/Valit
- Owner: valit-stack
- License: mit
- Created: 2017-09-11T21:27:23.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-12-24T22:34:26.000Z (almost 5 years ago)
- Last Synced: 2024-09-30T06:57:58.813Z (about 1 month ago)
- Topics: core, dotnet, fluent-api, validation
- Language: C#
- Homepage:
- Size: 12.4 MB
- Stars: 320
- Watchers: 17
- Forks: 26
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-dotnet-core - Valit - A dead simple validation for .NET Core. No more if-statements all around your code. Write nice and clean fluent validators instead! (Frameworks, Libraries and Tools / Misc)
- awesome-dotnet-core - Valit - Valit是对.NET Core的简单验证库，减少if的使用。 (框架, 库和工具 / 大杂烩)
- fucking-awesome-dotnet-core - Valit - A dead simple validation for .NET Core. No more if-statements all around your code. Write nice and clean fluent validators instead! (Frameworks, Libraries and Tools / Misc)
- awesome-dotnet-core - Valit - A dead simple validation for .NET Core. No more if-statements all around your code. Write nice and clean fluent validators instead! (Frameworks, Libraries and Tools / Misc)
README
Valit is **dead simple** validation for .NET Core. No more if-statements all around your code. Write nice and clean **fluent validators** instead!
| | master | develop |
|---|--------|----------|
|AppVeyor|[](https://ci.appveyor.com/project/GooRiOn/valit/branch/master)|[](https://ci.appveyor.com/project/GooRiOn/valit/branch/develop)|
|Codecov|[](https://codecov.io/gh/valit-stack/valit/branch/master)|[](https://codecov.io/gh/valit-stack/valit/branch/develop)|
# Installation
Valit is available on [NuGet](https://www.nuget.org/packages/Valit/).
### Package manager
```bash
Install-Package Valit -Version 2.0.0
```
### .NET CLI
```bash
dotnet add package Valit --version 2.0.0
```
# Getting started
In order to create a validator you need to go through few steps. It's worth mentioning that not all of them are mandatory. The steps are:
- creating new instance of validator using ``Create()`` static method.
- choosing [validation strategy](http://valitdocs.readthedocs.io/en/latest/strategies/index.html) using ``WithStrategy()`` method **(not required)**.
- selecting property using ``Ensure()`` method and defining rules for it.
- Extending rules with [custom errors](http://valitdocs.readthedocs.io/en/latest/validation-errors/index.html) (such as messages or error codes), [tags and conditions](http://valitdocs.readthedocs.io/en/latest/validation-rules/index.html). **(not required)**.
- applying created rules to an object using ``For()`` method.
Having the validator created, simply invoke ``Validate()`` method which will produce the result with all the data.
Let's try it out with very practical example. Imagine that your task is to validate model sent from registration page of your app. The example object might look as follows:
```cs
public class RegisterModel
{
public string Email { get; set; }
public string Password { get; set; }
public ushort Age { get; set ;}
}
```
These are the validation criteria:
- ``Email`` is required and needs to be a proper email address
- ``Password`` is required and needs to be at least 10 characters long
- ``Age`` must be greater than 16
This is how you can handle such scenario using Valit:
```cs
void ValidateModel(RegisterModel model)
{
var result = ValitRules
.Create()
.Ensure(m => m.Email, _=>_
.Required()
.Email())
.Ensure(m => m.Password, _=>_
.Required()
.MinLength(10))
.Ensure(m => m.Age, _=>_
.IsGreaterThan(16))
.For(model)
.Validate();
if(result.Succeeded)
{
// do something on success
}
else
{
// do something on failure
}
}
```
Pretty cool, right? Of course, the above example was fairly simple but trust us. From now on, even complicated validation criterias won't scare you anymore ;)
# Documentation
If you're looking for documentation, you can find it [here](http://valitdocs.readthedocs.io/en/latest/index.html).
# Contributing
Want to help us develop Valit? Awesome! Here you can find [contributor guide](https://github.com/valit-stack/Valit/blob/develop/CONTRIBUTING.md) ;)