legitimate

[![npm][npm-image]][npm-url]
[![docs][docs-image]][docs-url]
[![build][travis-image]][travis-url]
[![codecov][codecov-image]][codecov-url]
[![dependencies][david-image]][david-url]
[![version][tag-image]][tag-url]

Functional, modular and async validation 👌

Works fine on browser and node.js, framework agnostic.

Docs

Demo

Installation

``bash
npm install --save legitimate
`
or
`bash
yarn add legitimate
`

Usage

#### Simply:

`javascript
import { Legitimate, validators } from 'legitimate';

const legitimate = new Legitimate();

legitimate
.setRules('propToValidate', validators.notEmpty)
.update('propToValidate', 'value')
.validate('propToValidate') //validates single prop
.then(response => response.map(console.log))
.catch(response => response.map(console.warn));
`

#### Some customization:

`javascript
import { Legitimate, validators, locales } from 'legitimate';

const legitimate = new Legitimate({
...locales,
TOO_SHORT : (value, min) => Custom message : ${min};
}, {
password : null
});

const passwordRules = [
password : [
validators.isText,
validators.notEmpty,
(...params) => validators.min(...params, 8),
(...params) => validators.max(...params, 16),
(...params) => validators.minLowerCaseChars(...params, 1),
(...params) => validators.minUpperCaseChars(...params, 1)
]
];

legitimate
.setRules('username', validations.notEmpty, validations.alphanumeric)
.setRules('password', ...passwordRules)
.update('username', 'jacopkane')
.update('password', 'secretPass')
.isLegit() //validates all the state at once
.then(response => response.map(console.log)) //will return results for all the rules
.catch(response => response.map(console.warn));
`

#### ES5 & CommonJS

If you are old-school, it's fine with ES5 as well.

`javascript
var Legitimate = require('legitimate').Legitimate;
var legitimate = new Legitimate();
`




Development

$3


`bash
npm start
`
or
`bash
yarn start
`

$3

`bash
npm run build
`
or
`bash
yarn build
`

$3

`bash
npm test
`
or
`bash
npm test -- --coverage
`
or
`bash
yarn test
`

$3

For versioning you can use npm version command with semver

It will also
- test
- build
- generate docs
- stage
- commit
- push the tags to tracked remote repository
- push the demo
- if CI will pass also get deployed to NPM

`bash
npm version patch -f -m "Backwards-compatible bug fixes";
`
or
`bash
npm version minor -f -m "Backwards-compatible new functionality";
`
or
`bash
yarn version major -f -m "Made incompatible API changes";
``

TODO

- Implement / experiment observable approach
- Simplify demo
- Add more built-in validators maybe by using other proven libraries

[docs-image]: https://doc.esdoc.org/github.com/JacopKane/legitimate/badge.svg
[docs-url]: https://jacopkane.github.io/legitimate/docs/
[npm-image]: https://img.shields.io/npm/v/legitimate.svg
[npm-url]:https://www.npmjs.org/package/legitimate
[codecov-image]: https://codecov.io/gh/jacopkane/legitimate/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/jacopkane/legitimate
[travis-url]: https://travis-ci.org/JacopKane/legitimate
[travis-image]: https://travis-ci.org/JacopKane/legitimate.svg?branch=master
[david-url]: https://david-dm.org/jacopkane/legitimate?type=dev
[david-image]: https://david-dm.org/jacopkane/legitimate/dev-status.svg
[tag-image]: https://img.shields.io/github/tag/jacopkane/legitimate.svg
[tag-url]: https://github.com/jacopkane/legitimate/tags