isntit v1.0.0

Isntit

Isntit is a simple javascript data validation library. It is inspired by ansman's validate.js.

Example

<script src="dist/isntit.min.js" type="text/javascript"></script>

var options = {
    capitalize: true,                       // capitalize error messages
    devtools: config.env !== 'production',  // activate devtools (! disabled in production files)
    fullMessages: true,                     // prepend messages with the field name
    config: {                               // override config
        silent: false                       // prevent warnings even with devtools
    }
};

var rules = {
    email: {
        required: true,
        email: {
            message: "^'%{value}' is not a valid %{label} ex. : you@mail.com"
        }
    },
    user.firstname: {
        required: true,
        length: {
            min: 3
        }
    },
    user.age: {
        required: false,                    // Isntit warns about and skip a rule with false
        length: {
            min: 3
        }
    }
};

var I = new Isntit(rules, options);

var results = I.validate({
    email: "stoempsaucisse@hotmail.com",
    "user.firstname": "stoempsaucisse"
});

Installation

Standalone

Simply grab isntit.js (for development) or isntit.min.js (for production) and serve it.

NPM (TODO)

npm install isntit

Features

• devtools: get usefull warnings during runtime (only enabled in development files)
• extendable: register your own data checker
• use steps to prioritize some checkers upon others (if a step fails, checkers in following steps are not called)
• helpers: Isntit.printf(string: string, replacements: Array<any>) or Isntit.isEmpty(value: any)

Documentation

Isntit uses JSDoc to automaticaly generate its documentation.

Unit testing

Actually only validation, string helpers and type checking are covered. Sinon.js, Should.js and should-sinon (Sinon.js bindings for Should.js) are needed to run the tests.

npm i should sinon should-sinon --save-dev

Many thanks to:

• ansman for his inspiring validate.js.
• Evan You aka. yyx990803 for his awesome vuejs and inspiration in coding style and utilities.
• Jan Goyvaerts for his email regular expression

License

MIT