# Shared types and utils


[![GitHub tag](https://img.shields.io/github/tag/waitingsong/shared.svg)]()
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![](https://img.shields.io/badge/lang-TypeScript-blue.svg)]()
[![ci](https://github.com/waitingsong/shared/workflows/ci/badge.svg)](https://github.com/waitingsong/shared/actions?query=workflow%3A%22ci%22)
[![codecov](https://codecov.io/gh/waitingsong/shared/branch/main/graph/badge.svg?token=VN3Y815SPX)](https://codecov.io/gh/waitingsong/shared)


## Install global deps for development
```sh
npm i -g c8 lerna madge rollup tsx zx
```

## Initialization

```sh
npm i && npm run build
```


## Test

- Use `npm run lint` to check code style.
- Use `npm run test` to run unit test.


## Note

- Run `npm run clean` before `npm run build`, if any file under typescript outDir folder was deleted manually.
- Default publish registry is `NPM`, configurated in file `lerna.json`


## Packages

| Package   | Version                  |
| --------- | ------------------------ |
| [`types`] | [![types-svg]][types-ch] |
| [`core`]  | [![core-svg]][core-ch]   |


[`types`]: https://github.com/waitingsong/shared/tree/master/packages/types
[types-svg]: https://img.shields.io/npm/v/@waiting/shared-types.svg?maxAge=300
[types-ch]: https://github.com/waitingsong/shared/tree/master/packages/types/CHANGELOG.md
[types-d-svg]: https://david-dm.org/waitingsong/shared.svg?path=packages/types
[types-d-link]: https://david-dm.org/waitingsong/shared.svg?path=packages/types
[types-dd-svg]: https://david-dm.org/waitingsong/shared/dev-status.svg?path=packages/types
[types-dd-link]: https://david-dm.org/waitingsong/shared?path=packages/types#info=devDependencies

[`types-dev`]: https://github.com/waitingsong/shared/tree/master/packages/shared-types-dev
[types-dev-svg]: https://img.shields.io/npm/v/@waiting/shared-types-dev.svg?maxAge=300
[types-dev-ch]: https://github.com/waitingsong/shared/tree/master/packages/shared-types-dev/CHANGELOG.md
[types-dev-d-svg]: https://david-dm.org/waitingsong/shared.svg?path=packages/shared-types-dev
[types-dev-d-link]: https://david-dm.org/waitingsong/shared.svg?path=packages/shared-types-dev
[types-dev-dd-svg]: https://david-dm.org/waitingsong/shared/dev-status.svg?path=packages/shared-types-dev
[types-dev-dd-link]: https://david-dm.org/waitingsong/shared?path=packages/shared-types-dev#info=devDependencies

[`core`]: https://github.com/waitingsong/shared/tree/master/packages/core
[core-svg]: https://img.shields.io/npm/v/@waiting/shared-core.svg?maxAge=300
[core-ch]: https://github.com/waitingsong/shared/tree/master/packages/demo/CHANGELOG.md
[core-d-svg]: https://david-dm.org/waitingsong/shared.svg?path=packages/core
[core-d-link]: https://david-dm.org/waitingsong/shared.svg?path=packages/core
[core-dd-svg]: https://david-dm.org/waitingsong/shared/dev-status.svg?path=packages/core
[core-dd-link]: https://david-dm.org/waitingsong/shared?path=packages/core#info=devDependencies