An open API service indexing awesome lists of open source software.

https://github.com/aboutbits/yup-locales


https://github.com/aboutbits/yup-locales

Last synced: 21 days ago
JSON representation

Awesome Lists containing this project

README

          

Custom Yup Locales
====================

[![npm version](https://badge.fury.io/js/%40aboutbits%2Fyup-locales.svg)](https://badge.fury.io/js/%40aboutbits%2Fyup-locales)

This package includes simplified translations for yup error messages. The main difference lies in the exclusion of the field path.

## Table of content

- [Usage](#usage)
- [Build & Publish](#build--publish)
- [Information](#information)

## Usage

First, you have to install the package:

```bash
npm install @aboutbits/yup-locales
```

Second, you add the custom language packages to your project.

```js
import { setLocale } from 'yup'
import it from '@aboutbits/yup-locales/it'

// If you want that your app returns Italian error messages.
setLocale(it)
```

## Build & Publish

To build and publish the package, visit the GitHub Actions page of the repository.

You can choose between two workflows:
- `Release Package` to publish a new version of the package.
- `Pre-Release Package` to publish a new pre-release version of the package.

**Note:** Pre-releases need to be supplied with a pre-id.

**Note:** To increment a pre-release, you have to run the normal release workflow and select "prerelease". For this action you need to already be on a pre-release version.

## Information

About Bits is a company based in South Tyrol, Italy. You can find more information about us on [our website](https://aboutbits.it).

### Support

For support, please contact [info@aboutbits.it](mailto:info@aboutbits.it).

### Credits

- [All Contributors](../../contributors)

### License

The MIT License (MIT). Please see the [license file](LICENSE.md) for more information.