Git Product home page Git Product logo

valit's Introduction

Valit

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 Build status Build status
Codecov codecov codecov

NuGet

Installation

Valit is available on NuGet.

Package manager

Install-Package Valit -Version 2.0.0

.NET CLI

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 using WithStrategy() method (not required).
  • selecting property using Ensure() method and defining rules for it.
  • Extending rules with custom errors (such as messages or error codes), tags and conditions. (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:

    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:

        void ValidateModel(RegisterModel model)
        {
            var result = ValitRules<RegisterModel>
                .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.

Contributing

Want to help us develop Valit? Awesome! Here you can find contributor guide ;)

valit's People

Contributors

goorion avatar dbarwikowski avatar timdeschryver avatar paw3lx avatar arekbal avatar bovorasr avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.