https://github.com/qinsong77/sysuke
Mine monorepo, powered by pnpm workspace and turboprop.
https://github.com/qinsong77/sysuke
changesets monorepo pnpm-monorepo pnpm-workspace tsup turborepo
Last synced: 7 months ago
JSON representation
Mine monorepo, powered by pnpm workspace and turboprop.
- Host: GitHub
- URL: https://github.com/qinsong77/sysuke
- Owner: qinsong77
- Created: 2022-07-31T18:59:16.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-16T11:06:54.000Z (11 months ago)
- Last Synced: 2025-01-26T06:13:29.221Z (8 months ago)
- Topics: changesets, monorepo, pnpm-monorepo, pnpm-workspace, tsup, turborepo
- Language: TypeScript
- Homepage:
- Size: 4.03 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sysuke
Mine monorepo, powered by `pnpm workspace` and [turboprop](https://turbo.build/repo/docs).
Refer this: [MonoRepo by pnpm workspace + TurboRepo](https://www.sysuke.com/blog/architecture/monorepoPnpmTurboRepo.html)
## rules
common package install root, including shared internal config packages, including:
- `@sysuke/typescript-config`
- `@sysuke/eslint-config`
## todo
- lint-staged tsc
- Adjust sort list for [prettier-plugin-sort-imports](https://github.com/trivago/prettier-plugin-sort-imports)
- ~~eslint or Biome~~, currently using eslint, but DX is not so good. but Biome doesn’t support monorepos very well due to some limitations in resolving nested configuration files
- ~~turborepo~~
- ui library
- ~~web~~
- RN/Expo, reference: [expo-monorepo-example](https://github.com/byCedric/expo-monorepo-example#pnpm-workarounds)
- the process to publish package by changesets
1. changesets + github action to publish npm packages
2. ui package
3. trpc: hono + vite react example
4. refactor eslint
5. check docker
## Changeset process
1. run `pnpm changeset`: select packages and version(major, minor, patch), will generate `.md` files.
2. run `pnpm version-packages` = `pnpm changeset version`: use files generated by last step, update or generate `CHANGELOG.md`, update version on `package.json`
3. run `pnpm release`
Above steps are the process to publish package on Local.
For CI with github action: [`changesets/action@v1`](https://github.com/changesets/action), only need to run `pnpm changeset` and push code. Action will create PR and publish package to npm.
~~`.changeset/config.json` 中的 `commit: true` is for local, for CI, because `changeset version` is executed in github action. so `changesets/action@v1` config will override it.~~
So for the repo itself, just need run `changeset` and push code.
### Prereleases
Refer: [Changeset Prereleases doc](https://github.com/changesets/changesets/blob/main/docs/prereleases.md)
Do it on local, eg: beta
```shell
changeset pre enter beta
changeset
changeset version
turbo build --filter=@sysuke
pnpm changeset publish
```
we can run many times for above 2-4 steps, after done, run:
`pnpm changeset pre exit`
## Common scripts
- install package in root
```shell
pnpm install typescript -w
# install to root devDependencies
pnpm install typescript -w -D
# or
pnpm add prettier-plugin-tailwindcss -Dw
```
- install a npm `package` for one package/app individually: `--filter=pkg`
```shell
pnpm add axios --filter=@apps/web
```
- install `pkg1` into `pkg2`, internal refer
```shell
pnpm install @sysuke/pkg1 --filter=@sysuke/pkg2
```
## Might use
- [syncpack](https://jamiemason.github.io/syncpack/guide/getting-started/) a command-line tool to manage multiple package.json files;
- [oxc](https://oxc-project.github.io/) oxlint => [Biome](https://biomejs.dev/): Format, lint, and more in a fraction of
a second. - TBD
- [Sherif](https://github.com/QuiiBz/sherif) - Opinionated, zero-config linter for JavaScript monorepos
## Notes
- no need to add `tsconfig.json` in the root, [refer](https://turbo.build/repo/docs/guides/tools/typescript#you-likely-dont-need-a-tsconfigjson-file-in-the-root-of-your-project)
## Trivial
### commit
follow commitlint [rule](https://commitlint.js.org/reference/rules.html)
### npm registry
```shell
npm install nrm -g
## check all registry
nrm ls
## switch
npx nrm use npm
## confirm
npm config ls
```
### manage npm package
- unpublish/remove package
```shell
npm unpublish @sysuke/eslint-config-react --force
```
## Refer
- [turbo](https://turbo.build/repo/docs)
- [turborepo-example](https://github.com/vercel/turborepo/tree/main/examples)
- [arno-packages](https://github.com/SurfaceW/arno-packages)
- [nextui](https://github.com/nextui-org/nextui)