Releases: ealush/vest
[email protected]
Brings a major performance boost to Suites with many (100+) fields.
[email protected]
[email protected]
Major version of Vest 5.0.0
Upgrading from V4 to V5
Migration guide
Vest 5 is mostly compatible with Vest 4, but some changes were made. In most cases, if you do not change anything, vest will keep working as it did before. However, to take advantage of the new features, you'll need to make some changes.
Eager execution mode is now the default
In previous versions of Vest, Vest continued validating fields even after one of their tests had failed. V5 changes that to improve the runtime performance, and instead, Vest will halt further validations of a given field if it failed. This was an opt-in feature, and it can now be removed.
- import {create, test, eager} from 'vest';
+ import {create, test} from 'vest';
const suite = create(() => {
- eager();
test(/*...*/);
});To bring back the previous behavior, use the mode function that alters the execution mode:
- import {create, test} from 'vest';
+ import {create, test, mode, Modes} from 'vest';
const suite = create(() => {
+ eager(Modes.ALL);
test(/*...*/);
});This also means that if you've used skipWhen to avoid running of failing fields, you can now remove it:
- import {create, test, skipWhen} from 'vest';
+ import {create, test} from 'vest';
const suite = create(() => {
- skipWhen(res => res.hasErrors('username'), () => {
test('username', 'username already taken', () => {
// ...
});
- });
});All result methods are now available directly on the suite object
In previous versions, you had to call suite.get() to access the different methods, such as getErrors and isValid. In V5, these methods are available directly on the suite object.
- suite.get().getErrors('username');
+ suite.getErrors('username')
- suite.get().isValid();
+ suite.isValid()Added hasError and hasWarning methods
The result object has two new methods: hasError and hasWarning. They return a boolean value indicating whether a given field has an error or a warning. With these new methods, you can display the first error of a field.
- res.getErrors('username')[0]
+ res.hasError('username')Removed skip.group and only.group
Vest 5 removes the dedicated group interface for skip and only, and instead allows you to call skip and only directly within the groups.
const suite = create(() => {
- skip.group('group1', 'username');
group('group1', () => {
+ skip('username');
test('username', 'message', () => {
// ...
});
});
});const suite = create(() => {
- skip.group('group1');
group('group1', () => {
+ skip(true);
test('field1', 'message', () => {
// ...
});
});
});Optional fields now take into account the suite params
In previous versions, optional fields only took into consideration whether the tests ran or not. In V5 optional fields also search the data object passed to the suite. If it has an object with the optional field in it, and the optional field is blank - the test will be considered valid even if it is not passing.
Server side validations are built-in
In previous versions, as a user of Vest you had to set up your own state-reset mechanism. Vest now has a staticSuite export that does that for you.
- import {create} from 'vest';
+ import {staticSuite} from 'vest';
- const suite = create(() => {/*...*/});
+ const suite = staticSuite(() => /*...*/});
- function ServerValidation() {
- suite.reset();
- suite();
- }First-Class-Citizen typescript support
All of Vest's methods are now typed and make use of generics to enforce correct usage throughout your suite.
Dropped support for <ES2015
Vest 5 uses Javascript Proxies, which were introduced in ES2015. Therefore, Vest 5 no longer supports pre-ES2015 versions of Javascript. If you need to support older browsers, you can still use Vest 4.
[email protected]
[email protected]
7a17ef0 patch(context): simplify context by removing the ancestry registration (ealush)
[email protected]
9b46fb6 types(vest): add suiteName type to SuiteResult (ealush)
b94b568 patch(vest): use suiteSelectors from vest top level api in parser module (ealush)
24e4cea added(vest): expose suiteSelectors as a top level API (ealush)
1812e68 patch(vest): remove unneeded base object in context assignment (ealush)
590ad76 patch(vest): Remove suiteSummary from context (ealush)
e8dbbc9 patch(vest): move suite selectors out into their own module for easier consumption by external sources (#906) (Evyatar)
8597af2 patch(vest): Call done callback immediately when field does not exist (ealush)
17c39f6 types(vest): improve getFailures overload (ealush)
d4d4cb1 patch(vest): Remove unneeded empty check in hasRemainigTests (ealush)
[email protected]
[email protected]
[email protected]
b11c779 patch(context): use internally(ealush)