Yup-Phone-JS

This is a lightweight package for adding a .phone() validation to Yup. With all due credit to yup-phone for being first in this space, this package was written from scratch with several key differences:

1. Using libphonenumber-js for a much smaller and faster distributed package.
2. Greater control over the strictness of your validation.
3. The ability to validate against "any country" rather than requiring a country be provided.

It is bootstrapped on top of the TSDX framework for making npm packages. Their instructions follow.

Commands

TSDX scaffolds your new library inside /src.

To run TSDX, use:

1npm start # or yarn start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

To do a one-off build, use npm run build or yarn build.

To run tests, use npm test or yarn test.

Configuration

Code quality is set up for you with prettier, husky, and lint-staged. Adjust the respective fields in package.json accordingly.

Jest

Jest tests are set up to run with npm test or yarn test.

Bundle Analysis

size-limit is set up to calculate the real cost of your library with npm run size and visualize the bundle with npm run analyze.

Setup Files

This is the folder structure we set up for you:

1/src
2  index.tsx       # EDIT THIS
3/test
4  blah.test.tsx   # EDIT THIS
5.gitignore
6package.json
7README.md         # EDIT THIS
8tsconfig.json

Rollup

TSDX uses Rollup as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.

TypeScript

tsconfig.json is set up to interpret dom and esnext types, as well as react for jsx. Adjust according to your needs.

Continuous Integration

GitHub Actions

Two actions are added by default:

• main which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
• size which comments cost comparison of your library on every pull request using size-limit

Optimizations

Please see the main tsdx optimizations docs. In particular, know that you can take advantage of development-only optimizations:

1// ./types/index.d.ts
2declare var __DEV__: boolean;
3
4// inside your code...
5if (__DEV__) {
6  console.log('foo');
7}

You can also choose to install and use invariant and warning functions.

Module Formats

CJS, ESModules, and UMD module formats are supported.

The appropriate paths are configured in package.json and dist/index.js accordingly. Please report if any issues are found.

Named Exports

Per Palmer Group guidelines, always use named exports. Code split inside your React app instead of your React library.

Including Styles

There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.

For vanilla CSS, you can include it at the root directory and add it to the files section in your package.json, so that it can be imported separately by your users and run through their bundler's loader.

Publishing to NPM

We recommend using np.