ANN: Peer review 0.12.x

[tmpfs]

Prompted by issue #20 raised by @oredi I decided to a do a full review of this package for the following reasons:

• I am now using this package in the browser
• The initial implementation was rushed to fulfill a need
• It had been a while since the code was visited
• I had some ideas for API improvements
• There were outstanding features to be implemented
• Relying on this package in private commercial projects
• It appears other people are using this package

So the past few days have seen a lot of breaking changes as it moved from 0.1.x to 0.7.x:

• Refactored rule function signature to function(cb)
• Refactored to use a plugin system (browser)
• Removed unnecessary standard rules
• Removed obsolete ValidationError class, using Error instead
• Removed keys processing option
• Messages object does not expose clone() use Schema.clone() instead
• Enum values array renamed from enum to list to avoid enum keyword

Other changes:

• Removed async dependency, wrote minimal async iterator (browser)
• Removed call to util.format created and used format-util (browser)
• Added bail option
• Support null type validation
• Support additional field (see #18)
• Support message as function (see messages)
• Support message as object and extract message using error reason id (see #8)
• Refactored iteration to allow validation of root object (see 8037e4a85f4d983c12a4d44e531df98d26eded00)
• The method type (function) supports the range properties len, min and max (arity)
• Support typed array shorthand values (see #2)

The readme has been rewritten to be up to date and reflect the changes, if any of you have time to review this work and feedback it would be much appreciated.

Whilst many aspects of the internal workings have been rewritten and changes will be required to dependent code (custom rule validation functions) and to reflect the new plugin system, I don't think any changes to existing schema rules should be necessary except the enum breaking change noted above.

I am relatively happy with the new API and can't think of any changes at this point, the code also now has 100% coverage and may be tested in the browser (npm run spec and open test/index.html); so now is the time to request new features or find bugs/incompatibilities whilst I consider cutting a v1.

Thanks for any help.

/cc @MarcosRava @oredi @filipedeschamps

[tmpfs]

Also, FYI a build of the core lib without any plugins is currently ~18KB before minification and compression.

[tmpfs]

The 0.7.8 version includes support for transient variables, see the docs:

https://github.com/freeformsystems/async-validate#variables

[ghost]

Looks like a huge refactoring a lot of changes to the API. It might take sometime to get up to speed but I will need to explore the new version.

Might need sometime though with my other open source contributions and main rice bowl word piling up :)

[tmpfs]

Just published 0.8.x with the breaking change that previously you could use a pattern regexp without specifying a type:

{pattern:/[a-z]+/i}

Now you must specify the string type:

{type: 'string', pattern:/[a-z]+/i}

[tmpfs]

The last breaking change I have on my list right now is in 0.9.x.

Renamed the validator field to test for the rule function, see the assigned rule documentation and 18365462223df261000a9033d2552ce131848180.

[tmpfs]

Added support for passing state information between rules, see:

https://github.com/freeformsystems/async-validate#state https://github.com/freeformsystems/async-validate/blob/master/doc/example/state.js

Available in 0.9.2.

[tmpfs]

Added placeholder property support in 0.9.8, see eafae99211fccb406a88fe69bc2606fc789b85cb and:

https://github.com/freeformsystems/async-validate#placeholder

[tmpfs]

Support for multiple types (type as an array) added in 0.9.12, see #46.

[tmpfs]

Latest breaking change in 0.10.1 represented by #47.

I think this is the last one.

[tmpfs]

Nope, not the last breaking change, see #50 yet to be implemented.

[tmpfs]

Latest breaking change mentioned above landed in 0.11.2, see #50.

[tmpfs]

The 0.12.0 version requires that type is specified when not an inline or assigned rule and an error is thrown if it is not a string or function.

This should not affect anyone hopefully as the ability to validate on the source object and the temporary type inference logic that has been removed was only added recently.

[tmpfs]

Replaced by #55.