https://github.com/waitingsong/midway-components
https://github.com/waitingsong/midway-components
alioss cache jwt midwayjs otel
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/waitingsong/midway-components
- Owner: waitingsong
- License: mit
- Created: 2021-05-26T03:12:35.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-24T12:26:49.000Z (9 months ago)
- Last Synced: 2025-01-30T18:51:21.138Z (8 months ago)
- Topics: alioss, cache, jwt, midwayjs, otel
- Language: TypeScript
- Homepage:
- Size: 4.09 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# [Midway.js] Components
[]()
[](https://opensource.org/licenses/MIT)
[]()
[](https://github.com/waitingsong/midway-components/actions)
[](https://codecov.io/gh/waitingsong/midway-components)
[](https://conventionalcommits.org)
[](https://lernajs.io/)
## Note
ESM build only, requires `@midwayjs >= 3.15` and set `"type": "module"` in `packages.json`
## Packages
| Package | Version |
| ----------- | ---------------------------- |
| [`share`] | [![share-svg]][share-ch] |
| [`ali-oss`] | [![ali-oss-svg]][ali-oss-ch] |
| [`cache`] | [![cache-svg]][cache-ch] |
| [`jwt`] | [![jwt-svg]][jwt-ch] |
| [`otel`] | [![otel-svg]][otel-ch] |
## Initialize and install dependencies
## Install global deps for development
```sh
npm i -g c8 lerna madge rollup tsx zx
```
## Update package
```sh
npm i && npm run build
```
## Test
- Use `npm run lint` to check code style.
- Use `npm run test` to run unit test.
## Clan or Purge
```sh
# clean build dist, cache and build
npm run clean
# clean and remove all node_modules
npm run purge
```
## 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`
- Any commands above (such as `npm run build`) running in `Git-Bash` under Windows OS
## License
[MIT](LICENSE)
### Languages
- [English](README.md)
- [中文](README.zh-CN.md)
[Midway.js]: https://midwayjs.org/
[`ali-oss`]: https://github.com/waitingsong/midway-components/tree/main/packages/ali-oss
[ali-oss-svg]: https://img.shields.io/npm/v/@mwcp/ali-oss.svg?maxAge=300
[ali-oss-ch]: https://github.com/waitingsong/midway-components/tree/main/packages/ali-oss/CHANGELOG.md
[`cache`]: https://github.com/waitingsong/midway-components/tree/main/packages/cache
[cache-svg]: https://img.shields.io/npm/v/@mwcp/cache.svg?maxAge=300
[cache-ch]: https://github.com/waitingsong/midway-components/tree/main/packages/cache/CHANGELOG.md
[`jwt`]: https://github.com/waitingsong/midway-components/tree/main/packages/jwt
[jwt-svg]: https://img.shields.io/npm/v/@mwcp/jwt.svg?maxAge=300
[jwt-ch]: https://github.com/waitingsong/midway-components/tree/main/packages/jwt/CHANGELOG.md
[`otel`]: https://github.com/waitingsong/midway-components/tree/main/packages/otel
[otel-svg]: https://img.shields.io/npm/v/@mwcp/otel.svg?maxAge=300
[otel-ch]: https://github.com/waitingsong/midway-components/tree/main/packages/otel/CHANGELOG.md
[`share`]: https://github.com/waitingsong/midway-components/tree/main/packages/share
[share-svg]: https://img.shields.io/npm/v/@mwcp/share.svg?maxAge=300
[share-ch]: https://github.com/waitingsong/midway-components/tree/main/packages/share/CHANGELOG.md