https://github.com/riskers/fe-bootstrap-template
monorepo publish NPM package with changeset Action and PNPM
https://github.com/riskers/fe-bootstrap-template
changesets husky lintstage monorepo pnpm pnpm-workspace
Last synced: 11 months ago
JSON representation
monorepo publish NPM package with changeset Action and PNPM
- Host: GitHub
- URL: https://github.com/riskers/fe-bootstrap-template
- Owner: riskers
- Created: 2022-08-12T09:10:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-29T02:57:22.000Z (over 2 years ago)
- Last Synced: 2025-01-07T06:14:36.467Z (about 1 year ago)
- Topics: changesets, husky, lintstage, monorepo, pnpm, pnpm-workspace
- Language: JavaScript
- Homepage: https://riskers.notion.site/monorepo-pnpm-changeset-CI-d2db019bb2ba438baa0c7e2f20711315
- Size: 564 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mono-bootstrap-template
[NPM VERSION](https://www.npmjs.com/settings/riskers12/packages)
## PNPM workspace
use PNPM workspace monorepo
Limit the types of package management Strictly (default [PNPM](https://pnpm.io/)).
If you want to modify, you can change the `engines` field in [package.json](./package.json).
## RELEASE / CHANGELOG
use [changesets](https://github.com/changesets/changesets)
## Husky + LintStaged
If [husky](https://github.com/typicode/husky) not works:
```bash
chmod ug+x .husky/*
chmod ug+x .git/hooks/*
```
## Lint and Format
* [ESLint](https://eslint.org/): [config](./.eslintrc.js)
* [Prettier](https://prettier.io/): [config](./.prettierrc.js)
> reference [stackoverflow](https://stackoverflow.com/questions/8598639/why-is-my-git-pre-commit-hook-not-executable-by-default)
lint command: `pnpm run -r lint`
## Commitlint
[commitlint](https://github.com/conventional-changelog/commitlint) will check commit message before you commit.
[rules](./.commitlintrc.js)
## Release NPM package on Github Action
1. Change npm's `name` in [package.json](./package.json).
2. Apply `NPM_TOKEN` and fill in your repo's secrets:
3. Auto publish package by Changesets on [Github Action](./.github/workflows/release.yaml).