Sync docs with v1.0 (#1538)

* docs: add warnings on deprecated methods * docs: remove unused prop * docs: add deprecation warning on attachToDocument * docs: remove beta from readme * chore: remove beta.33 release file
vuejs · May 8, 2020 · 44ac570 · 44ac570
1 parent 6e941b6
commit 44ac570
Show file tree

Hide file tree

Showing 15 changed files with 84 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,10 @@
 # Vue Test Utils [![Build Status](https://circleci.com/gh/vuejs/vue-test-utils/tree/dev.png?style=shield)](https://circleci.com/gh/vuejs/vue-test-utils)
 
+Vue Test Utils is the official testing library for Vue.js.
+
 ## Packages
 
-This repository provides the following two packages.  
-They are currently in beta.
+This repository provides the following two packages:
 
 - [Vue Test Utils](./packages/test-utils)
 - [Vue Server Test Utils](./packages/server-test-utils)

diff --git a/RELEASE_NOTE_1.0.0-beta.33.md b/RELEASE_NOTE_1.0.0-beta.33.md
diff --git a/docs/api/options.md b/docs/api/options.md
@@ -302,8 +302,7 @@ remove the rendered elements from the document and destroy the component instanc
 
 ```js
 const Component = {
-  template: '<div>ABC</div>',
-  props: ['msg']
+  template: '<div>ABC</div>'
 }
 let wrapper = mount(Component, {
   attachTo: '#root'
@@ -323,7 +322,11 @@ wrapper.destroy()
 - type: `boolean`
 - default: `false`
 
-Like [`attachTo`](#attachto), but automatically creates a new `div` element for you and inserts it into the body. This is deprecated in favor of [`attachTo`](#attachto).
+::: warning
+`attachToDocument` is deprecated and will be removed in future releases. Use [`attachTo`](#attachto) instead.
+:::
+
+Like [`attachTo`](#attachto), but automatically creates a new `div` element for you and inserts it into the body.
 
 When attaching to the DOM, you should call `wrapper.destroy()` at the end of your test to
 remove the rendered elements from the document and destroy the component instance.
@@ -432,26 +435,22 @@ When the options for `mount` and `shallowMount` contain the options other than t
 
 ```js
 const Component = {
-  template: '<div>{{ foo() }}{{ bar() }}{{ baz() }}</div>',
-  methods: {
-    foo() {
-      return 'a'
-    },
-    bar() {
-      return 'b'
+  template: '<div>{{ foo }}</div>',
+  data() {
+    return {
+      foo: 'fromComponent'
     }
   }
 }
 const options = {
-  methods: {
-    bar() {
-      return 'B'
-    },
-    baz() {
-      return 'C'
+  data() {
+    return {
+      foo: 'fromOptions'
     }
   }
 }
+
 const wrapper = mount(Component, options)
-expect(wrapper.text()).toBe('aBC')
+
+expect(wrapper.text()).toBe('fromOptions')
 ```
diff --git a/docs/api/wrapper-array/isEmpty.md b/docs/api/wrapper-array/isEmpty.md
@@ -1,5 +1,13 @@
 ## isEmpty
 
+::: warning
+`isEmpty` is deprecated and will be removed in future releases.
+
+Consider a custom matcher such as those provided in [jest-dom](https://github.com/testing-library/jest-dom#tobeempty).
+
+When using with findComponent, access the DOM element with findComponent(Comp).element
+:::
+
 Assert every `Wrapper` in `WrapperArray` does not contain child node.
 
 - **Returns:** `{boolean}`

diff --git a/docs/api/wrapper-array/isVueInstance.md b/docs/api/wrapper-array/isVueInstance.md
@@ -1,5 +1,9 @@
 ## isVueInstance
 
+::: warning
+`isVueInstance` is deprecated and will be removed in future releases.
+:::
+
 Assert every `Wrapper` in `WrapperArray` is Vue instance.
 
 - **Returns:** `{boolean}`

diff --git a/docs/api/wrapper-array/setMethods.md b/docs/api/wrapper-array/setMethods.md
@@ -1,5 +1,9 @@
 ## setMethods
 
+::: warning
+`setMethods` is deprecated and will be removed in future releases.
+:::
+
 Sets `Wrapper` `vm` methods and forces update on each `Wrapper` in `WrapperArray`.
 
 **Note every `Wrapper` must contain a Vue instance.**

diff --git a/docs/api/wrapper/emittedByOrder.md b/docs/api/wrapper/emittedByOrder.md
@@ -1,5 +1,11 @@
 ## emittedByOrder
 
+::: warning
+`emittedByOrder` is deprecated and will be removed in future releases.
+
+Use `wrapper.emitted` instead.
+:::
+
 Return an Array containing custom events emitted by the `Wrapper` `vm`.
 
 - **Returns:** `Array<{ name: string, args: Array<any> }>`

diff --git a/docs/api/wrapper/find.md b/docs/api/wrapper/find.md
@@ -1,5 +1,9 @@
 ## find
 
+::: warning
+Using `find` to search for a Component is deprecated and will be removed. Use `findComponent` instead.
+:::
+
 Returns `Wrapper` of first DOM node or Vue component matching selector.
 
 Use any valid DOM selector (uses `querySelector` syntax).

diff --git a/docs/api/wrapper/findAll.md b/docs/api/wrapper/findAll.md
@@ -1,5 +1,9 @@
 ## findAll
 
+::: warning
+Using `findAll` to search for Components is deprecated and will be removed. Use `findAllComponents` instead.
+:::
+
 Returns a [`WrapperArray`](../wrapper-array/).
 
 Use any valid [selector](../selectors.md).
@@ -18,8 +22,10 @@ import Foo from './Foo.vue'
 import Bar from './Bar.vue'
 
 const wrapper = mount(Foo)
+
 const div = wrapper.findAll('div').at(0)
 expect(div.is('div')).toBe(true)
-const bar = wrapper.findAll(Bar).at(0)
+
+const bar = wrapper.findAll(Bar).at(0) // Deprecated usage
 expect(bar.is(Bar)).toBe(true)
 ```
diff --git a/docs/api/wrapper/isEmpty.md b/docs/api/wrapper/isEmpty.md
@@ -1,5 +1,13 @@
 ## isEmpty
 
+::: warning
+`isEmpty` is deprecated and will be removed in future releases.
+
+Consider a custom matcher such as those provided in [jest-dom](https://github.com/testing-library/jest-dom#tobeempty).
+
+When using with findComponent, access the DOM element with `findComponent(Comp).element`
+:::
+
 Assert `Wrapper` does not contain child node.
 
 - **Returns:** `{boolean}`

diff --git a/docs/api/wrapper/isVisible.md b/docs/api/wrapper/isVisible.md
@@ -1,5 +1,13 @@
 ## isVisible
 
+::: warning
+`isVisible` is deprecated and will be removed in future releases.
+
+Consider a custom matcher such as those provided in [jest-dom](https://github.com/testing-library/jest-dom#tobevisible).
+
+When using with findComponent, access the DOM element with `findComponent(Comp).element`
+:::
+
 Assert `Wrapper` is visible.
 
 Returns `false` if an ancestor element has `display: none` or `visibility: hidden` style.

diff --git a/docs/api/wrapper/isVueInstance.md b/docs/api/wrapper/isVueInstance.md
@@ -1,5 +1,9 @@
 ## isVueInstance
 
+::: warning
+`isVueInstance` is deprecated and will be removed in future releases.
+:::
+
 Assert `Wrapper` is Vue instance.
 
 - **Returns:** `{boolean}`

diff --git a/docs/api/wrapper/name.md b/docs/api/wrapper/name.md
@@ -1,5 +1,9 @@
 ## name
 
+::: warning
+`name` is deprecated and will be removed in future releases.
+:::
+
 Returns component name if `Wrapper` contains a Vue instance, or the tag name of `Wrapper` DOM node if `Wrapper` does not contain a Vue instance.
 
 - **Returns:** `{string}`

diff --git a/docs/api/wrapper/overview.md b/docs/api/wrapper/overview.md
@@ -1,5 +1,9 @@
 ## overview
 
+::: warning
+`overview` is deprecated and will be removed in future releases.
+:::
+
 Prints a simple overview of the `Wrapper`.
 
 - **Example:**

diff --git a/docs/api/wrapper/setMethods.md b/docs/api/wrapper/setMethods.md
@@ -1,5 +1,9 @@
 ## setMethods
 
+::: warning
+`setMethods` is deprecated and will be removed in future releases.
+:::
+
 Sets `Wrapper` `vm` methods and forces update.
 
 **Note the Wrapper must contain a Vue instance.**