From eb68b7faf9ce0c47d2bc843e893ae4e110a81560 Mon Sep 17 00:00:00 2001 From: t0yohei <30691457+t0yohei@users.noreply.github.com> Date: Tue, 21 Jul 2020 20:10:42 +0900 Subject: [PATCH] docs: updating ja documents about deprecation warning (#1617) Added deprecation warning texts to Japanese version because There are no writtern deprecation warning texts yet --- docs/ja/api/options.md | 17 +++++++++++++++++ docs/ja/api/wrapper-array/isEmpty.md | 8 ++++++++ docs/ja/api/wrapper-array/isVueInstance.md | 8 ++++++++ docs/ja/api/wrapper-array/setMethods.md | 10 ++++++++++ docs/ja/api/wrapper/emittedByOrder.md | 6 ++++++ docs/ja/api/wrapper/find.md | 4 ++++ docs/ja/api/wrapper/findAll.md | 4 ++++ docs/ja/api/wrapper/is.md | 14 ++++++++++++++ docs/ja/api/wrapper/isVisible.md | 8 ++++++++ docs/ja/api/wrapper/isVueInstance.md | 8 ++++++++ docs/ja/api/wrapper/name.md | 4 ++++ docs/ja/api/wrapper/setMethods.md | 10 ++++++++++ 12 files changed, 101 insertions(+) diff --git a/docs/ja/api/options.md b/docs/ja/api/options.md index ab6384044..7f6a550bd 100644 --- a/docs/ja/api/options.md +++ b/docs/ja/api/options.md @@ -192,6 +192,23 @@ expect(wrapper.vm.$route).toBeInstanceOf(Object) - 型: `boolean` - デフォルト: `false` +::: warning Deprecation warning +`attachToDocument` は非推奨となり、将来のリリースで削除される予定です。 + +代わりに [attachTo](#attachto) を使用してください。たとえば、コンポーネントを document.body にアタッチする必要がある場合は： + +```js +const elem = document.createElement('div') +if (document.body) { + document.body.appendChild(elem) +} +wrapper = mount(Component, { + attachTo: elem +}) +``` + +::: + `true` に設定されている場合、描画時にコンポーネントは DOM にアタッチされます。 DOM にアタッチされた際に、テストの最後で `wrapper.destroy()` を呼び出さなければなりません。レンダリングされた要素をドキュメントから取り除いて、コンポーネントインスタンスを壊さなければならないからです。 diff --git a/docs/ja/api/wrapper-array/isEmpty.md b/docs/ja/api/wrapper-array/isEmpty.md index d795b8d79..3871b6d34 100644 --- a/docs/ja/api/wrapper-array/isEmpty.md +++ b/docs/ja/api/wrapper-array/isEmpty.md @@ -1,5 +1,13 @@ ## isEmpty() +::: warning Deprecation warning +`isEmpty` は非推奨となり、将来のリリースで削除される予定です。 + +[jest-dom](https://github.com/testing-library/jest-dom#custom-matchers) で提供されているようなカスタムマッチャの使用を検討してください。 + +findComponent で使用する場合は、 `findComponent(Comp).element` で DOM 要素にアクセスします。 +::: + `WrapperArray` のすべての `Wrapper` に子ノードを含んでいないか検証します。 - **戻り値:** `{boolean}` diff --git a/docs/ja/api/wrapper-array/isVueInstance.md b/docs/ja/api/wrapper-array/isVueInstance.md index 1e525429b..1f0a8d86d 100644 --- a/docs/ja/api/wrapper-array/isVueInstance.md +++ b/docs/ja/api/wrapper-array/isVueInstance.md @@ -1,5 +1,13 @@ ## isVueInstance() +::: warning Deprecation warning +`isVueInstance` は非推奨となり、将来のリリースで削除される予定です。 + +`isVueInstance` アサーションに依存するテストは、ほとんどまたは全く価値を提供しません。それらを意図のあるアサーションに置き換えることをお勧めします。 + +テストを維持するために、`isVueInstance()` を置き換える場合は、 `wrapper.find(...).vm` のアサーションが有効です。 +::: + `WrapperArray` の全ての `Wrapper` が Vue インスタンスであるか検証します。 - **戻り値:** `{boolean}` diff --git a/docs/ja/api/wrapper-array/setMethods.md b/docs/ja/api/wrapper-array/setMethods.md index 672d7fdbc..512202259 100644 --- a/docs/ja/api/wrapper-array/setMethods.md +++ b/docs/ja/api/wrapper-array/setMethods.md @@ -1,5 +1,15 @@ ## setMethods(methods) +::: warning Deprecation warning +`setMethods` は非推奨となり、将来のリリースで削除される予定です。 + +`setMethods` を置き換える明確な方法はありません。それは、置き換え前の使われ方に非常に依存しているためです。 `setMethods` は実装の詳細に依存する不安定なテストに簡単につながるため、[お勧めしません](https://github.com/vuejs/rfcs/blob/668866fa71d70322f6a7689e88554ab27d349f9c/active-rfcs/0000-vtu-api.md#setmethods)。 + +それらテストを見直すことをお勧めします。 + +複雑なメソッドをスタブするには、コンポーネントからメソッドを抽出し、単独でテストします。 メソッドが呼び出されたことをアサートするには、テストランナーを使用してそれを探ります。 +::: + `WrapperArray` の `Wrapper` ごとに `Wrapper` に `vm` メソッドをセットし、強制的に更新します。 **すべての `Wrapper` は Vue インスタンスを含んでいなければならないことに注意してください。** diff --git a/docs/ja/api/wrapper/emittedByOrder.md b/docs/ja/api/wrapper/emittedByOrder.md index 89d104ab7..0aad50ace 100644 --- a/docs/ja/api/wrapper/emittedByOrder.md +++ b/docs/ja/api/wrapper/emittedByOrder.md @@ -1,5 +1,11 @@ ## emittedByOrder() +::: warning Deprecation warning +`emittedByOrder` は非推奨となり、将来のリリースで削除される予定です。 + +代わりに `wrapper.emitted` を使用してください。 +::: + `Wrapper` `vm` によって生成されたカスタムイベントを含む配列を返します。 - **戻り値:** `Array<{ name: string, args: Array }>` diff --git a/docs/ja/api/wrapper/find.md b/docs/ja/api/wrapper/find.md index a6ecd3bde..500e638de 100644 --- a/docs/ja/api/wrapper/find.md +++ b/docs/ja/api/wrapper/find.md @@ -1,5 +1,9 @@ ## find(selector) +::: warning Deprecation warning +コンポーネントの検索に `find` を使用することは非推奨となり、削除される予定です。代わりに `findComponent` を使用してください。 +::: + 最初の DOM ノードの Wrapper、またはセレクタで一致した Vue コンポーネントを返します。 有効な[セレクタ](../selectors.md)を使用してください。 diff --git a/docs/ja/api/wrapper/findAll.md b/docs/ja/api/wrapper/findAll.md index 5c5e83c98..8302d7f7d 100644 --- a/docs/ja/api/wrapper/findAll.md +++ b/docs/ja/api/wrapper/findAll.md @@ -1,5 +1,9 @@ ## findAll(selector) +::: warning Deprecation warning +`findAll` を使用してコンポーネントを検索することは非推奨となり、削除される予定です。代わりに `findAllComponents` を使用してください。 +::: + [`WrapperArray`](../wrapper-array/)を返します。 有効な[セレクタ](../selectors.md)を使用してください。 diff --git a/docs/ja/api/wrapper/is.md b/docs/ja/api/wrapper/is.md index 3e953c880..827fceeb8 100644 --- a/docs/ja/api/wrapper/is.md +++ b/docs/ja/api/wrapper/is.md @@ -1,5 +1,19 @@ ## is(selector) +::: warning Deprecation warning +`is` を使用して、 DOM ノードまたは `vm` がセレクタに一致することをアサートするのは非推奨となり、削除される予定です。 + +[jest-dom](https://github.com/testing-library/jest-dom#custom-matchers) で提供されているようなカスタムマッチャの使用を検討してください。または、 DOM 要素などに対するアサーションには、代わりにネイティブの [Element.tagName](https://developer.mozilla.org/en-US/docs/Web/API/Element/tagName) を使用してください。 + +テストを維持するためには、以下の置き換えが有効です。 + +- `is('DOM_SELECTOR')` は `wrapper.element.tagName` のアサーションです。 +- `is('ATTR_NAME')` は真に `wrapper.attributes('ATTR_NAME')` のアサーションです。 +- `is('CLASS_NAME')` は真に `wrapper.classes('CLASS_NAME')` のアサーションです。 + +findComponent で使用する場合は、 `findComponent(Comp).element` で DOM 要素にアクセスします。 +::: + `Wrapper` DOM ノード、または `vm` が[セレクタ](../selectors.md)と一致しているか検証します。 - **引数:** diff --git a/docs/ja/api/wrapper/isVisible.md b/docs/ja/api/wrapper/isVisible.md index 22a15a5ed..2c9577b09 100644 --- a/docs/ja/api/wrapper/isVisible.md +++ b/docs/ja/api/wrapper/isVisible.md @@ -1,5 +1,13 @@ ## isVisible() +::: warning Deprecation warning +`isVisible` は非推奨となり、将来のリリースで削除される予定です。 + +[jest-dom](https://github.com/testing-library/jest-dom#custom-matchers) で提供されているようなカスタムマッチャの使用を検討してください。 + +findComponent で使用する場合は、 `findComponent(Comp).element` で DOM 要素にアクセスします。 +::: + `Wrapper` が表示されているかアサートします。 style が `display: none` か  `visibility: hidden` の親要素がある場合、 false を返します。 diff --git a/docs/ja/api/wrapper/isVueInstance.md b/docs/ja/api/wrapper/isVueInstance.md index bf1490317..64e49c11f 100644 --- a/docs/ja/api/wrapper/isVueInstance.md +++ b/docs/ja/api/wrapper/isVueInstance.md @@ -1,5 +1,13 @@ ## isVueInstance() +::: warning Deprecation warning +`isVueInstance` は非推奨となり、将来のリリースで削除される予定です。 + +`isVueInstance` アサーションに依存するテストは、ほとんどまたは全く価値を提供しません。それらを意図のあるアサーションに置き換えることをお勧めします。 + +テストを維持するために、`isVueInstance()` を置き換える場合は、 `wrapper.find(...).vm` のアサーションが有効です。 +::: + `Wrapper` が Vue インスタンスか検証します。 - **戻り値:** `{boolean}` diff --git a/docs/ja/api/wrapper/name.md b/docs/ja/api/wrapper/name.md index 7977e5086..c30f465e3 100644 --- a/docs/ja/api/wrapper/name.md +++ b/docs/ja/api/wrapper/name.md @@ -1,5 +1,9 @@ ## name() +::: warning Deprecation warning +`name` は非推奨となり、将来のリリースで削除される予定です。 +::: + `Wrapper` に Vue インスタンスが含まれている場合はコンポーネント名を返し、そうでない場合は `Wrapper` DOM ノードのタグ名を返します。 - **戻り値:** `{string}` diff --git a/docs/ja/api/wrapper/setMethods.md b/docs/ja/api/wrapper/setMethods.md index 3334094cc..d24da9e29 100644 --- a/docs/ja/api/wrapper/setMethods.md +++ b/docs/ja/api/wrapper/setMethods.md @@ -1,5 +1,15 @@ ## setMethods(methods) +::: warning Deprecation warning +`setMethods` は非推奨となり、将来のリリースで削除される予定です。 + +`setMethods` を置き換える明確な方法はありません。それは、置き換え前の使われ方に非常に依存しているためです。 `setMethods` は実装の詳細に依存する不安定なテストに簡単につながるため、[お勧めしません](https://github.com/vuejs/rfcs/blob/668866fa71d70322f6a7689e88554ab27d349f9c/active-rfcs/0000-vtu-api.md#setmethods)。 + +それらテストを見直すことをお勧めします。 + +複雑なメソッドをスタブするには、コンポーネントからメソッドを抽出し、単独でテストします。 メソッドが呼び出されたことをアサートするには、テストランナーを使用してそれを探ります。 +::: + `Wrapper` `vm` メソッドを設定し、更新を強制します。 **Wrapper には Vue インスタンスを含む必要があることに注意してください**