Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hairyf/hairylib

This is the Mao scope Utils
https://github.com/hairyf/hairylib

Last synced: 2 months ago
JSON representation

This is the Mao scope Utils

Host: GitHub
URL: https://github.com/hairyf/hairylib
Owner: hairyf
License: mit
Created: 2020-10-10T20:26:00.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-02-01T09:09:05.000Z (11 months ago)
Last Synced: 2024-04-14T02:04:21.269Z (9 months ago)
Language: TypeScript
Homepage: https://hairylib.com/
Size: 11.2 MB
Stars: 12
Watchers: 1
Forks: 4
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Hairylib Monorepo

****

[hairylib](https://hairylib.com/) 是使用 `pnpm` / `turbo` / `changeset` 管理的多个模块包(monorepo)的项目。

Monorepo 的好处是什么？

- **统一管理**。比如微前端项目，多个子应用可以放在同一个`monorepo`中方便管理；后端用`node.js`的项目放在`monorepo`中也可以使用同一套技术栈管理。在`CI/CD`等流水线过程中，方便统一迭代或升级版本，也方便做通用化的配置，适用到多个子项目当中。
- **依赖提升**。如果多个项目都依赖了诸如`react`、`vue`或`TypeScript`等常用库，那可以通过`lerna`或者`yarn workspace`、`pnpm workspace`将依赖提升到最外层，多个子模块/包复用同一个依赖，减小项目体积。

what is pnpm ?

- [pnpm: 关于现代包管理器的深度思考](https://juejin.cn/post/6932046455733485575)

what is turbo and changeset ?

- [changesets: 流行的 monorepo 场景发包工具](https://hairylib.com/docs/study/changesets.html)
- [turbo: Turborepo 的任务编排能力](https://zhuanlan.zhihu.com/p/468382756)

## 运行流程

> 想了想没什么特别的，就不写了。

## 文档系统

基于 `github actions` 工作流(`.github/workflows/docs.yml`)，自动部署 [hairylib.com](https://hairylib.com/)

文档构建使用 `vitepress`，自动收集组合文档，生成 `Type Declarations` 和 `side-bar`。

地址：https://hairylib.com/

```yml
# .github/workflows/docs.yml
name: A TO A:GH_PAGES
on:
push:
paths:
- 'packages/**'
- '.github/workflows/docs.yml'
- 'package.json'
- 'pnpm-lock'
- 'pnpm-workspace.yaml'
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@master

- name: Build and Deploy
uses: jenkey2011/vuepress-deploy@master
env:
ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
# 你要操作的目标仓库
TARGET_REPO: TuiMao233/hairylib
# 构建结果存储的分支
TARGET_BRANCH: gh_pages
# 要使用的构建命令
BUILD_SCRIPT: npm i pnpm -g && pnpm i && pnpm docs:build
# 构建结果存储目录
BUILD_DIR: packages/.vitepress/dist/
```

## 模块与依赖

![dependencies](meta/dependencies.svg)

## 有点意思的小技巧

在 .js 文件中引入 .ts 文件

~~~js
require('esbuild-register')
// 要注意的是，因为 ts 使用 esm 的原因，export default 则需要在获取一层
module.exports = require('./scripts/rollup.config.ts').default
~~~

## License