Skip to content

Commit eb68b7f

Browse files
authored
docs: updating ja documents about deprecation warning (#1617)
Added deprecation warning texts to Japanese version because There are no writtern deprecation warning texts yet
1 parent f4083fa commit eb68b7f

12 files changed

+101
-0
lines changed

Diff for: docs/ja/api/options.md

+17
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,23 @@ expect(wrapper.vm.$route).toBeInstanceOf(Object)
192192
- 型: `boolean`
193193
- デフォルト: `false`
194194

195+
::: warning Deprecation warning
196+
`attachToDocument` は非推奨となり、将来のリリースで削除される予定です。
197+
198+
代わりに [attachTo](#attachto) を使用してください。たとえば、コンポーネントを document.body にアタッチする必要がある場合は:
199+
200+
```js
201+
const elem = document.createElement('div')
202+
if (document.body) {
203+
document.body.appendChild(elem)
204+
}
205+
wrapper = mount(Component, {
206+
attachTo: elem
207+
})
208+
```
209+
210+
:::
211+
195212
`true` に設定されている場合、描画時にコンポーネントは DOM にアタッチされます。
196213

197214
DOM にアタッチされた際に、テストの最後で `wrapper.destroy()` を呼び出さなければなりません。レンダリングされた要素をドキュメントから取り除いて、コンポーネントインスタンスを壊さなければならないからです。

Diff for: docs/ja/api/wrapper-array/isEmpty.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
## isEmpty()
22

3+
::: warning Deprecation warning
4+
`isEmpty` は非推奨となり、将来のリリースで削除される予定です。
5+
6+
[jest-dom](https://github.com/testing-library/jest-dom#custom-matchers) で提供されているようなカスタムマッチャの使用を検討してください。
7+
8+
findComponent で使用する場合は、 `findComponent(Comp).element` で DOM 要素にアクセスします。
9+
:::
10+
311
`WrapperArray` のすべての `Wrapper` に子ノードを含んでいないか検証します。
412

513
- **戻り値:** `{boolean}`

Diff for: docs/ja/api/wrapper-array/isVueInstance.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
## isVueInstance()
22

3+
::: warning Deprecation warning
4+
`isVueInstance` は非推奨となり、将来のリリースで削除される予定です。
5+
6+
`isVueInstance` アサーションに依存するテストは、ほとんどまたは全く価値を提供しません。それらを意図のあるアサーションに置き換えることをお勧めします。
7+
8+
テストを維持するために、`isVueInstance()` を置き換える場合は、 `wrapper.find(...).vm` のアサーションが有効です。
9+
:::
10+
311
`WrapperArray` の全ての `Wrapper` が Vue インスタンスであるか検証します。
412

513
- **戻り値:** `{boolean}`

Diff for: docs/ja/api/wrapper-array/setMethods.md

+10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
## setMethods(methods)
22

3+
::: warning Deprecation warning
4+
`setMethods` は非推奨となり、将来のリリースで削除される予定です。
5+
6+
`setMethods` を置き換える明確な方法はありません。それは、置き換え前の使われ方に非常に依存しているためです。 `setMethods` は実装の詳細に依存する不安定なテストに簡単につながるため、[お勧めしません](https://github.com/vuejs/rfcs/blob/668866fa71d70322f6a7689e88554ab27d349f9c/active-rfcs/0000-vtu-api.md#setmethods)
7+
8+
それらテストを見直すことをお勧めします。
9+
10+
複雑なメソッドをスタブするには、コンポーネントからメソッドを抽出し、単独でテストします。 メソッドが呼び出されたことをアサートするには、テストランナーを使用してそれを探ります。
11+
:::
12+
313
`WrapperArray``Wrapper` ごとに `Wrapper``vm` メソッドをセットし、強制的に更新します。
414

515
**すべての `Wrapper` は Vue インスタンスを含んでいなければならないことに注意してください。**

Diff for: docs/ja/api/wrapper/emittedByOrder.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
## emittedByOrder()
22

3+
::: warning Deprecation warning
4+
`emittedByOrder` は非推奨となり、将来のリリースで削除される予定です。
5+
6+
代わりに `wrapper.emitted` を使用してください。
7+
:::
8+
39
`Wrapper` `vm` によって生成されたカスタムイベントを含む配列を返します。
410

511
- **戻り値:** `Array<{ name: string, args: Array<any> }>`

Diff for: docs/ja/api/wrapper/find.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
## find(selector)
22

3+
::: warning Deprecation warning
4+
コンポーネントの検索に `find` を使用することは非推奨となり、削除される予定です。代わりに `findComponent` を使用してください。
5+
:::
6+
37
最初の DOM ノードの Wrapper、またはセレクタで一致した Vue コンポーネントを返します。
48

59
有効な[セレクタ](../selectors.md)を使用してください。

Diff for: docs/ja/api/wrapper/findAll.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
## findAll(selector)
22

3+
::: warning Deprecation warning
4+
`findAll` を使用してコンポーネントを検索することは非推奨となり、削除される予定です。代わりに `findAllComponents` を使用してください。
5+
:::
6+
37
[`WrapperArray`](../wrapper-array/)を返します。
48

59
有効な[セレクタ](../selectors.md)を使用してください。

Diff for: docs/ja/api/wrapper/is.md

+14
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
## is(selector)
22

3+
::: warning Deprecation warning
4+
`is` を使用して、 DOM ノードまたは `vm` がセレクタに一致することをアサートするのは非推奨となり、削除される予定です。
5+
6+
[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) を使用してください。
7+
8+
テストを維持するためには、以下の置き換えが有効です。
9+
10+
- `is('DOM_SELECTOR')``wrapper.element.tagName` のアサーションです。
11+
- `is('ATTR_NAME')` は真に `wrapper.attributes('ATTR_NAME')` のアサーションです。
12+
- `is('CLASS_NAME')` は真に `wrapper.classes('CLASS_NAME')` のアサーションです。
13+
14+
findComponent で使用する場合は、 `findComponent(Comp).element` で DOM 要素にアクセスします。
15+
:::
16+
317
`Wrapper` DOM ノード、または `vm`[セレクタ](../selectors.md)と一致しているか検証します。
418

519
- **引数:**

Diff for: docs/ja/api/wrapper/isVisible.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
## isVisible()
22

3+
::: warning Deprecation warning
4+
`isVisible` は非推奨となり、将来のリリースで削除される予定です。
5+
6+
[jest-dom](https://github.com/testing-library/jest-dom#custom-matchers) で提供されているようなカスタムマッチャの使用を検討してください。
7+
8+
findComponent で使用する場合は、 `findComponent(Comp).element` で DOM 要素にアクセスします。
9+
:::
10+
311
`Wrapper` が表示されているかアサートします。
412

513
style が `display: none` か  `visibility: hidden` の親要素がある場合、 false を返します。

Diff for: docs/ja/api/wrapper/isVueInstance.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
## isVueInstance()
22

3+
::: warning Deprecation warning
4+
`isVueInstance` は非推奨となり、将来のリリースで削除される予定です。
5+
6+
`isVueInstance` アサーションに依存するテストは、ほとんどまたは全く価値を提供しません。それらを意図のあるアサーションに置き換えることをお勧めします。
7+
8+
テストを維持するために、`isVueInstance()` を置き換える場合は、 `wrapper.find(...).vm` のアサーションが有効です。
9+
:::
10+
311
`Wrapper` が Vue インスタンスか検証します。
412

513
- **戻り値:** `{boolean}`

Diff for: docs/ja/api/wrapper/name.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
## name()
22

3+
::: warning Deprecation warning
4+
`name` は非推奨となり、将来のリリースで削除される予定です。
5+
:::
6+
37
`Wrapper` に Vue インスタンスが含まれている場合はコンポーネント名を返し、そうでない場合は `Wrapper` DOM ノードのタグ名を返します。
48

59
- **戻り値:** `{string}`

Diff for: docs/ja/api/wrapper/setMethods.md

+10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
## setMethods(methods)
22

3+
::: warning Deprecation warning
4+
`setMethods` は非推奨となり、将来のリリースで削除される予定です。
5+
6+
`setMethods` を置き換える明確な方法はありません。それは、置き換え前の使われ方に非常に依存しているためです。 `setMethods` は実装の詳細に依存する不安定なテストに簡単につながるため、[お勧めしません](https://github.com/vuejs/rfcs/blob/668866fa71d70322f6a7689e88554ab27d349f9c/active-rfcs/0000-vtu-api.md#setmethods)
7+
8+
それらテストを見直すことをお勧めします。
9+
10+
複雑なメソッドをスタブするには、コンポーネントからメソッドを抽出し、単独でテストします。 メソッドが呼び出されたことをアサートするには、テストランナーを使用してそれを探ります。
11+
:::
12+
313
`Wrapper` `vm` メソッドを設定し、更新を強制します。
414

515
**Wrapper には Vue インスタンスを含む必要があることに注意してください**

0 commit comments

Comments
 (0)