80 lines
1.7 KiB
Markdown
80 lines
1.7 KiB
Markdown
## Mono repo scripts
|
|
|
|
This repository contains a few helpful scripts for working with this mono repo.
|
|
|
|
## Usage
|
|
|
|
#### Dependency versions
|
|
|
|
In order to reduce the size of this repo, we try and use the same versions of dependencies between packages. To make it easier to discover version discrepancies between packages, you can run:
|
|
|
|
```bash
|
|
yarn scripts:deps_versions
|
|
```
|
|
|
|
This will list out any dependencies that differ in versions between packages.
|
|
|
|
## Contributing
|
|
|
|
We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.
|
|
|
|
Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
|
|
|
|
### Install dependencies
|
|
|
|
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
|
|
|
|
```bash
|
|
yarn config set workspaces-experimental true
|
|
```
|
|
|
|
Then install dependencies
|
|
|
|
```bash
|
|
yarn install
|
|
```
|
|
|
|
### Build
|
|
|
|
If this is your **first** time building this package, you must first build **all** packages within the monorepo. This is because packages that depend on other packages located inside this monorepo are symlinked when run from **within** the monorepo. This allows you to make changes across multiple packages without first publishing dependent packages to NPM. To build all packages, run the following from the monorepo root directory:
|
|
|
|
```bash
|
|
yarn lerna:rebuild
|
|
```
|
|
|
|
Or continuously rebuild on change:
|
|
|
|
```bash
|
|
yarn dev
|
|
```
|
|
|
|
You can also build this specific package by running the following from within its directory:
|
|
|
|
```bash
|
|
yarn build
|
|
```
|
|
|
|
or continuously rebuild on change:
|
|
|
|
```bash
|
|
yarn build:watch
|
|
```
|
|
|
|
### Clean
|
|
|
|
```bash
|
|
yarn clean
|
|
```
|
|
|
|
### Lint
|
|
|
|
```bash
|
|
yarn lint
|
|
```
|
|
|
|
### Run Tests
|
|
|
|
```bash
|
|
yarn test
|
|
```
|