vest 4.0.0-dev-deabb8 → 4.0.0-dev-8851ff

package/CHANGELOG.md

@@ -4,60 +4,72 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## 4.0.0 - 2021-10-02
+## 4.0.0 - 2021-10-25
 ### Changed or removed
-- 0e3af10  major(context): used named export in context (ealush)
-- 1897164  major(vest, enforce): setup next major version (ealush)
-- bf9265e  breaking(vest, enforce): prepare next major (ealush)
+- f5ba507  major(context): used named export in context (ealush)
+- eaed68f  breaking(vest, enforce): prepare next major (ealush)
 
 ### Added
-- b0cbb32  feat(vest): Add a parser export (ealush)
-- fc75f1d  feat(vest): isValid with field name (ealush)
-- c427e4e  feat(vest): handle execution order state refill with memoized tests (ealush)
-- 443c275  feat(vest): Make the state rely on execution order. Add skipWhen. (undefined)
-- 2988655  added(n4s): partial rule modifier (undefined)
-- f41a444  feat(n4s): context propagation within enforce (undefined)
+- e0f0f91  feat(vest): support custom optional logic (ealush)
+- d4fecee  feat(vest): Add a parser export (ealush)
+- e72498d  feat(vest): isValid with field name (ealush)
+- f60d952  feat(vest): handle execution order state refill with memoized tests (ealush)
+- a2b60c4  feat(vest): Make the state rely on execution order. Make skipWhen set skipped context. (undefined)
+- ae5eb02  added(n4s): partial rule modifier (undefined)
+- 990c68f  feat(n4s): context propagation within enforce (undefined)
 
 ### Fixed and improved
-- deabb8e  patch(vest): add cache invalidation for canceled tests (ealush)
-- fd1e31e  types(vest): add safeguard around shouldUseErrorAsMessage (ealush)
-- 8321a36  patch(vest): some cleanups (ealush)
-- 8320956  patch(vest): remove duplicate code handling perv test registration (ealush)
-- 7e3fffb  vx: use context directly from published package (ealush)
-- ac45a64  patch: run done callbacks via event (ealush)
-- e0f05d6  patch(vest): removed state subscription (ealush)
+- 8851ff5  patch(vest): Add isolate module for containing re-orders (ealush)
+- 0593c0f  patch(vest): refresh tests after cancel (ealush)
+- e915b53  patch: add cursor util (ealush)
+- f54ae8b  patch(vest): move cursor into context (ealush)
+- fc7627e  patch(vest): automatically purge not-found test results (ealush)
+- d68d990  vx: correctly pass cli options to build script (ealush)
+- 7c47b9a  patch(vest): Throw error when tests are called in the wrong order (ealush)
+- 01be84e  vx: add types to exports (ealush)
+- 7201170  organize vest state hooks (ealush)
+- e39bfd8  patch(vest): infer omitted optional fields (ealush)
+- 93014e3  vx: add dev bundle to exports (ealush)
+- 91df42e  fix(vest): prevent changing test status once it was finalized (ealush)
+- 797df3e  patch(vest): add cache invalidation for canceled tests (ealush)
+- 14ba6d9  types(vest): add safeguard around shouldUseErrorAsMessage (ealush)
+- 477ca00  patch(vest): some cleanups (ealush)
+- 58d5ed3  patch(vest): remove duplicate code handling perv test registration (ealush)
+- 6a98443  vx: use context directly from published package (ealush)
+- a79e479  patch: run done callbacks via event (ealush)
+- 01d32b7  patch(vest): removed state subscription (ealush)
 - package.json
 - packages/anyone/package.json
 - packages/anyone/package.json
 - packages/vast/types/vast.d.ts
-- 2515275  patch(vest): remove pending and lagging state (ealush)
-- 4c38835  patch(vest): convert boolean flags to a single status key (ealush)
-- e24f0bd  patch: simplify fieldname comparison (ealush)
-- b927b5c  patch(vest): add useAllIncomplete hook (ealush)
-- a88dd38  patch(vest): invalid accounts for warning tests as well (ealush)
-- eaf9bef  patch(vest): isValid counts all required tests per field (ealush)
-- 7a4ba03  chore: cleanups (ealush)
+- b10b98b  patch(vest): remove pending and lagging state (ealush)
+- dfd2cc3  patch(vest): convert boolean flags to a single status key (ealush)
+- 1c9da6c  patch: simplify fieldname comparison (ealush)
+- 43c75a4  patch(vest): add useAllIncomplete hook (ealush)
+- 2dfdc97  patch(vest): invalid accounts for warning tests as well (ealush)
+- 4033cca  patch(vest): isValid counts all required tests per field (ealush)
+- 02b28a6  chore: cleanups (ealush)
 - .eslintrc.js
-- 1878ffc  add(n4s): enforce.condition (ealush)
+- afa16e9  add(n4s): enforce.condition (ealush)
 - package.json
 - packages/anyone/package.json
-- a89af46  chore: cleanup residue (undefined)
-- be86496  chore: remove duplicate types (undefined)
+- d452e26  chore: cleanup residue (undefined)
+- 5982183  chore: remove duplicate types (undefined)
 - packages/anyone/package.json
-- 44de93f  patch: add nodejs exports (undefined)
-- abb0efe  patch: remove unused exports (undefined)
+- 52ac8e0  patch: add nodejs exports (undefined)
+- f9c4b3e  patch: remove unused exports (undefined)
 - packages/anyone/package.json
-- a8540de  chore: reduce complexity, remove all lint errors (undefined)
+- db0253b  chore: reduce complexity, remove all lint errors (undefined)
 - packages/anyone/.npmignore
 - .github/PULL_REQUEST_TEMPLATE.md
-- f58327f  chore: cleanup unused code (ealush)
-- 853cee6  lint: handling lint of all packages (ealush)
+- be9c776  chore: cleanup unused code (ealush)
+- c5eb2de  lint: handling lint of all packages (ealush)
 - .gitignore
-- d148f6d  patch(n4s): add ruleReturn default values (ealush)
-- c722fbd  fix(n4s): make enforce compound runners fall back to correct response (ealush)
-- fa65911  fix(n4s): make enforce chaining work (ealush)
-- a2437a3  chore: some lint fixes (ealush)
-- aabb5f4  add cli options support (ealush)
+- d388fdc  patch(n4s): add ruleReturn default values (ealush)
+- be91b7e  fix(n4s): make enforce compound runners fall back to correct response (ealush)
+- 7e8f25c  fix(n4s): make enforce chaining work (ealush)
+- e60ce3b  chore: some lint fixes (ealush)
+- fc8e2d8  add cli options support (ealush)
 
 ## 3.2.7 - 2021-07-17
 

package/README.md

@@ -0,0 +1,113 @@
+![Vest](https://cdn.jsdelivr.net/gh/ealush/vest@assets/vest-logo.png 'Vest')
+
+# Vest 🦺 Declarative Validation Testing
+
+![Github Stars](https://githubbadges.com/star.svg?user=ealush&repo=vest&style=flat)
+![Npm downloads](https://img.shields.io/npm/dt/vest?label=Downloads&logo=npm)
+
+[![npm version](https://badge.fury.io/js/vest.svg)](https://badge.fury.io/js/vest) [![Build Status](https://travis-ci.org/ealush/vest.svg?branch=latest)](https://travis-ci.org/ealush/vest) [![Known Vulnerabilities](https://snyk.io/test/npm/vest/badge.svg)](https://snyk.io/test/npm/vest)
+![minifiedSize](https://img.shields.io/bundlephobia/min/vest?color=blue&logo=npm)
+
+[![Join discord](https://img.shields.io/discord/757686103292641312?label=Join%20Discord&logo=discord&logoColor=green)](https://discord.gg/WmADZpJnSe)
+
+- [Documentation homepage](https://vestjs.dev)
+- **Try vest live**
+  - [Vanilla JS Example](https://stackblitz.com/edit/vest-vanilla-support-example?file=validation.js)
+  - ReactJS Examples:
+    - [Example 1 (groups)](https://codesandbox.io/s/ecstatic-waterfall-4i2ne?file=/src/validate.js)
+    - [Example 2 (Async)](https://codesandbox.io/s/youthful-williamson-loijb?file=/src/validate.js)
+    - [Example 3](https://stackblitz.com/edit/vest-react-support-example?file=validation.js)
+    - [Example 4](https://stackblitz.com/edit/vest-react-registration?file=validate.js)
+    - [Example 5 (Password validator)](https://codesandbox.io/s/password-validator-example-6puvy?file=/src/validate.js)
+  - [VueJS Example](https://codesandbox.io/s/vest-vue-example-1j6r8?file=/src/validations.js)
+  - [Svelte Example](https://codesandbox.io/s/vestdocssvelteexample-k87t7?file=/validate.js)
+
+## Tutorials
+
+[Step By Step React Tutorial](https://dev.to/ealush/dead-simple-form-validation-with-vest-5gf8)
+
+## [Release Notes](https://github.com/ealush/vest/releases)
+
+## 🦺 What is Vest?
+
+Vest is a validations library for JS apps that derives its syntax from modern JS unit testing frameworks such as Mocha or Jest. It is easy to learn due to its use of already common declarative patterns.
+It works great with user-input validation and with validating upon user interaction to provide the best possible user experience.
+
+The idea behind Vest is that your validations can be described as a 'spec' or a contract that reflects your form or feature structure. Your validations run in production, and they are framework agnostic - meaning Vest works well with React, Angular, Vue, or even without a framework at all.
+
+Using Vest for form validation can reduce bloat, improve feature readability and maintainability.
+
+**Basic Example**
+![full](https://cdn.jsdelivr.net/gh/ealush/vest@assets/demos/full_3.gif 'full')
+
+**Memoized async test**
+![memo](https://cdn.jsdelivr.net/gh/ealush/vest@assets/demos/memo.gif 'memo')
+
+## ✅ Motivation
+
+Writing forms is an integral part of building web apps, and even though it may seem trivial at first - as your feature grows over time, so does your validation logic grows in complexity.
+
+Vest tries to remediate this by separating validation logic from feature logic so it is easier to maintain over time and refactor when needed.
+
+## ✨ Vest's features
+
+- 🎨 Framework agnostic (BYOUI)
+- ⚡️ Rich, extendable, assertions library (enforce) ([doc](http://vestjs.dev/#/enforce))
+- 🚥 Multiple validations for the same field
+- ⚠️ Warning (non failing) tests ([doc](http://vestjs.dev/#/warn))
+- 📝 Validate only the fields the user interacted with ([doc](http://vestjs.dev/#/exclusion))
+- ⏳ Memoize async validations to reduce calls to the server ([doc](http://vestjs.dev/#/test?id=testmemo-for-memoized-tests))
+- 🚦 Test grouping ([doc](http://vestjs.dev/#/group))
+
+## Example code ([Run in sandbox](https://codesandbox.io/s/vest-react-tutorial-finished-ztt8t?file=/src/validate.js))
+
+```js
+import { create, only, test, enforce, warn, skipWhen } from 'vest';
+
+export default create((data = {}, currentField) => {
+  only(currentField);
+
+  test('username', 'Username is required', () => {
+    enforce(data.username).isNotEmpty();
+  });
+
+  test('username', 'Username is too short', () => {
+    enforce(data.username).longerThanOrEquals(3);
+  });
+
+  test('password', 'Password is required', () => {
+    enforce(data.password).isNotEmpty();
+  });
+
+  test('password', 'Password must be at least 6 chars long', () => {
+    enforce(data.password).longerThanOrEquals(6);
+  });
+
+  test('password', 'Password is weak, Maybe add a number?', () => {
+    warn();
+    enforce(data.password).matches(/[0-9]/);
+  });
+
+  skipWhen(!data.password, () => {
+    test('confirm_password', 'Passwords do not match', () => {
+      enforce(data.confirm_password).equals(data.password);
+    });
+  });
+
+  test('email', 'Email Address is not valid', () => {
+    enforce(data.email).isEmail();
+  });
+
+  test('tos', () => {
+    enforce(data.tos).isTruthy();
+  });
+});
+```
+
+## Why Vest?
+
+- 🧠 Vest is really easy to learn. You can take your existing knowledge of unit tests and transfer it to validations.
+- ✏️ Vest takes into account user interaction and warn only validations.
+- 🧱 Your validations are structured, making it very simple to read and write. All validation files look the same.
+- 🖇 Your validation logic is separate from your feature logic, preventing the spaghetti code that's usually involved with writing validations.
+- 🧩 Validation logic is easy to share and reuse across features.