strickland

Readme

Strickland is a JavaScript validation framework with a focus on extensibility and composability. It is built with pure, universal JavaScript and while it works well with React, Redux, and other UI libraries, Strickland is not coupled to any other library or application type.

Strickland is a unique and robust approach to building validation into your application.

• It is not a type system and it does not interfere with how you create and manage objects
• Instead, validation rules are defined separately from the data
• While Strickland can be used within the UI layer (including React components or Redux modules), it is not limited to use within UI
• Universal applications can share validators across both client-side and server-side validation
• With its extensibility and composability, Strickland supports complex scenarios in large line-of-business applications

Strickland focuses not on being a bloated collection of validators, but instead on enabling you to create your application's collection of validators and compose them together easily.

Separation of Concerns

In any validation implementation, there are three separate concerns that you must address, regardless of the libraries used.

• Validation Rules are the logic of how data is validated
• Validation Triggers are the events that trigger validation to occur at the field or form level
• Validation Results are presented to the user as the output of your validation rules

The most robust, flexible, and maintainable validation implementations keep these three concerns separated. Validation rules should not be coupled to the validation triggers or how the results will be presented. Validation triggers should not be coupled in any way to the validation rules or how the results will be presented. And the presentation of validation results should not be coupled to how validation was triggered or what the rules were.

With this separation of concerns in mind, Strickland strives to:

• Provide a flexible framework for authoring validation rules so that many different types of validation rules can be authored while remaining decoupled from validation triggers and how validation results are displayed
• Be completely uninvolved in validation triggers so that consuming applications can be built with any UI frameworks and without imposing any opinions on user interactions
• Provide a consistent structure for exposing validation results so that they can be consumed by applications consistently regardless of how many or what types of validation rules are present

Core Concepts

To address the core concepts above, there are three core concepts you need to know with Strickland:

• Validators are implementations of your validation rules
• Validation is the act of executing a validator against a value
• Validation Results are the output of validation for the given validator and value

Creating Validators

Strickland validators are pure functions that accept values and return validation results. Here is an extremely simple validator that validates that the value supplied is the letter 'A', returning the validation result as a boolean.

function letterA(value) {
    return (value === 'A');
}

Performing Validation

Strickland's default export is a validate function that accepts a validator function and the value to validate against the validator; it returns the validation result.

import validate from 'strickland';

function letterA(value) {
    return (value === 'A');
}

const result = validate(letterA, 'B');

Validation Results

Strickland normalizes validation results to always be objects with isValid and value properties.

If the validator returns a falsy value, then isValid will be false. If the validator returns true, then isValid will be true. If the validator returns an object, the truthiness of its isValid property will be used on the result's isValid property.

The value on the validation result will always be the value that was validated.

import validate from 'strickland';

function letterA(value) {
    // We can return a validation result as a boolean
    return (value === 'A');

    // Or as an object
    // return {
    //    isValid: (value === 'A')
    // };
}

const result = validate(letterA, 'B');

// Either way, the result will match:
//
// result = {
//     isValid: false,
//     value: 'B'
// }

Documentation

Detailed documentation is available at strickland.io.

License

MIT

Changelog

2.2.0 (2020-07-12)

Features

• add a formatResult function to wrap sync and async results with a formatter (797ee7e)