1. 1
2. 2
3. 3
4. 4
5. 5
6. 6
7. 7
8. 8
9. 9
10. 10
11. 11
12. 12
13. 13
14. 14
15. 15
16. 16
17. 17
18. 18
19. 19
20. 20
21. 21
22. 22
23. 23
24. 24
25. 25
26. 26
27. 27
28. 28
29. 29
30. 30
31. 31
32. 32
33. 33
34. 34
35. 35
36. 36
37. 37
38. 38
39. 39
40. 40
41. 41
42. 42
43. 43
44. 44
45. 45
46. 46
47. 47
48. 48
49. 49

# yup-locale-ja

[![npm](https://img.shields.io/npm/v/yup-locale-ja)](https://www.npmjs.com/package/yup-locale-ja)
[![Automated Tests Status](https://img.shields.io/github/actions/workflow/status/pocka/yup-locale-ja/test.yml?branch=master&label=test&logo=github)](https://github.com/pocka/yup-locale-ja/actions?query=workflow%3ATest)
[![Automated Publish Status](https://img.shields.io/github/actions/workflow/status/pocka/yup-locale-ja/publish.yml?label=publish&logo=github)](https://github.com/pocka/yup-locale-ja/actions?query=workflow%3APublish)

[yup](https://github.com/jquense/yup)のエラーメッセージを日本語化するパッケージです。
スタイルの異なる 2 種類の翻訳が用意されています。

[README (English)](./README.md)

## 利用方法

```sh
$ yarn add yup yup-locale-ja

# もしくは
$ npm i yup yup-locale-ja
```

インストールしたら yup の `setLocale` 関数でメッセージを登録してください。

```js
import { setLocale } from "yup";
import * as ja from "yup-locale-ja";

setLocale(ja.suggestive);
```

yup のローカライゼーションに関しての詳細は [yup の README](https://github.com/jquense/yup#using-a-custom-locale-dictionary) を参照してください。

## 翻訳スタイル

このパッケージでは **descriptive** (記述的) と **suggestive** (提示的) の 2 種類のメッセージセットを提供しています。
**descriptive** は "~です" というように、フィールドのルールをそのまま記述する形です。
対して **suggestive** は "~してください" という形でユーザがエラーを解消するために必要なアクションを提示するようなメッセージになっています。

```js
import * as ja from "yup-locale-ja";

ja.suggestive; // suggestive (提示的)
ja.descriptive; // descriptive (記述的)
```

## ラベルの表示方法

デフォルトではエラーメッセージにフィールド名は含まれません。
含める場合は [`.label`](https://github.com/jquense/yup#mixedlabellabel-string-schema) メソッドを対象のフィールドで呼び、
フィールドにラベルを設定してください。