breaking: remove vest.draft() (#474)

CONTRIBUTING.md

@@ -54,7 +54,6 @@ packages/
 │   │   │   └── suite/          # Contains all the suite modules and methods
 │   │   │       └── createSuite # Initializes the suite and creates a context and state.
 │   │   └── hooks/          # Functions that extend vest's functionality. They all use context.
-│   │   │   └── draft       # Allows access to the intermediate test result.
 │   │   │   └── exclusive   # Allows including or excluding fields in runtime.
 │   │   │   └── warn        # Allows setting warn-only fields.
 │   │   │   └── group       # Adds another nesting level within suites.

jsconfig.json

@@ -197,9 +197,6 @@
       "test": [
         "./packages/vest/src/core/test/test.js"
       ],
-      "draft": [
-        "./packages/vest/src/hooks/draft.js"
-      ],
       "exclusive": [
         "./packages/vest/src/hooks/exclusive.js"
       ],

packages/eslint-plugin-vest/lib/constants/index.js

@@ -1,5 +1,4 @@
 const constants = {
-  VEST_HOOK_DRAFT: 'draft',
   VEST_HOOK_ONLY: 'only',
   VEST_HOOK_SKIP: 'skip',
   VEST_HOOK_WARN: 'warn',
@@ -12,7 +11,6 @@ constants.ALL_VEST_HOOKS = [
   constants.VEST_HOOK_WARN,
   constants.VEST_HOOK_ONLY,
   constants.VEST_HOOK_SKIP,
-  constants.VEST_HOOK_DRAFT,
 ];
 
 constants.VEST_EXCLUSIVE_HOOKS = [

packages/vest/docs/_sidebar.md

@@ -9,5 +9,4 @@
 - Advanced cases
   - [Using with node](./node)
   - [Excluding or including tests](./exclusion)
-  - [Accessing intermediate suite result](./draft)
   - [Utilities](./utilities)

packages/vest/docs/exclusion.md

@@ -101,8 +101,4 @@ If you combine `vest.only.group` with `vest.skip`, if you skip a field inside a
 
 **vest.skip.group()**
 
-If you combine `vest.skip.group` with `vest.only` your included field declared within the skipped tests will be ignored.
-
-**Read next about:**
-
-- [Accessing intermediate suite result](./draft).
+If you combine `vest.skip.group` with `vest.only` your included field declared within the skipped tests will be ignored.

packages/vest/docs/result.md

@@ -41,6 +41,22 @@ const v = vest.create('my_form', () => {
 v.get(); // -> returns the most recent result object for the current suite
 ```
 
+You can also use `.get()` to access the intermediate validation result during your suite's run, this is a replacement of the deprecated `vest.draft()` hook.
+
+```js
+const v = vest.create('my_form', (data) => {
+  test('username', 'Username is too short', () => {
+    enforce(data.username).longerThanOrEquals(3);
+  })
+
+  if (!v.get().hasErrors('username')) {
+    test('username', 'already taken', async () => {
+      // some async test
+    })
+  }
+});
+```
+
 # Result Object Methods:
 
 Along with these values, the result object exposes the following methods:

packages/vest/docs/test.md

@@ -115,4 +115,3 @@ export default vest.create('form-name', data => {
 - [Grouping tests](./group).
 - [Asserting with enforce](./enforce).
 - [Skipping or including tests](./exclusion).
-- [Accessing intermediate suite result](./draft).

packages/vest/src/__tests__/__snapshots__/infra.test.js.snap

@@ -148,7 +148,6 @@ exports[`Vest exports All vest exports exist 1`] = `
 Object {
   "VERSION": Any<String>,
   "create": [Function],
-  "draft": [Function],
   "enforce": [Function],
   "group": [Function],
   "only": [Function],

packages/vest/src/core/produce/__tests__/produce.test.js

@@ -722,13 +722,13 @@ describe('module: produce', () => {
       const control = jest.fn();
       let draft;
       const validate = vest.create('cache', () => {
-        draft = vest.draft();
+        draft = validate.get();
         getStateFromContext();
-        expect(draft).toBe(vest.draft());
+        expect(draft).toBe(validate.get());
         expect(produce(/*isDraft:*/ true)).toBe(validate.get());
         testDummy(vest).failing();
         expect(produce()).not.toBe(validate.get());
-        expect(draft).not.toBe(vest.draft());
+        expect(draft).not.toBe(validate.get());
         testDummy(vest).failing();
         control();
       });

packages/vest/src/hooks/hooks.js

@@ -1,4 +1,3 @@
-export { default as draft } from 'draft';
 export { only, skip } from 'exclusive';
 export { default as warn } from 'warn';
 export { default as group } from 'group';

packages/vest/src/index.js

@@ -1,15 +1,14 @@
 import enforce from 'n4s';
 
 import create from 'createSuite';
-import { draft, only, skip, warn, group } from 'hooks';
+import { only, skip, warn, group } from 'hooks';
 import test from 'test';
 
 const VERSION = __LIB_VERSION__;
 
 export default {
   VERSION,
   create,
-  draft,
   enforce,
   group,
   only,

packages/vest/src/index.mjs

@@ -1,14 +1,14 @@
 import enforce from 'n4s';
+
 import create from 'createSuite';
-import { draft, only, skip, warn, group } from 'hooks';
+import { only, skip, warn, group } from 'hooks';
 import test from 'test';
 
 const VERSION = __LIB_VERSION__;
 
 export default {
   VERSION,
   create,
-  draft,
   enforce,
   group,
   only,
@@ -17,4 +17,4 @@ export default {
   warn,
 };
 
-export { VERSION, create, draft, enforce, group, only, skip, test, warn };
+export { VERSION, create, enforce, group, only, skip, test, warn };

packages/vest/src/typings/vest.d.ts

@@ -381,26 +381,12 @@ declare module 'vest' {
      */
     warn(): void;
 
-    /**
-     * Retrieves an intermediate validation result during the validation runtime.
-     */
-    draft(): DraftResult;
     VERSION: string;
   }
 
-  const {
-    test,
-    create,
-    warn,
-    draft,
-    VERSION,
-    enforce,
-    skip,
-    only,
-    group,
-  }: Vest;
+  const { test, create, warn, VERSION, enforce, skip, only, group }: Vest;
 
-  export { test, create, warn, draft, VERSION, enforce, skip, only, group };
+  export { test, create, warn, VERSION, enforce, skip, only, group };
 
   const vest: Vest;