import { Meta, Typeset } from '@storybook/addon-docs/blocks'

<Meta title='General/Docs/Yalc' />

# Yalc Documentation

To ensure proper TypeScript type checking after updating types in a Library component, it is essential to run `yalc`. Follow the steps below to get started:

#### Publish the Library

Run the following command in `react-ui`:

`yalc publish`

#### Link the Library

In the repository where you will be testing the code (e.g., Shelf, Predict, PXM, etc.), execute:

`yalc link @patterninc/react-ui`

#### Push Updates

To push updates or changes from the Library (react-ui) to the other repositories, use:

`yalc push --scripts`

#### _Important Notes_

- For applications like PXM, you must run the `yalc push --scripts` command whenever you want to test any changes to the Library, not just type changes.

- You can install `yalc` globally, or you may choose to prefix the commands with `npx` like this: `npx yalc publish`