Vite
to develop, build.ESLint
to lint,Vitest
to test.- commitizen, commitlint to limit commit messages.
- @changesets/cli to generate changelog, manage versions, and publish.
- use Husky to automatic trigger git hooks.
- Use Docusaurus to write document, and web tests.
- Base on yarn@berry to manage dependencies.
if you need monorepo
, here is single monorepo-template
- Click
Use this template
, and clone your repo. - Search
@n-kit/repo-template
,n-kit/repo-template
, then replace all with your module name.
then it'll be your repository totally.
- Execute
npm run changeset
oryarn changeset
to add a changeset, then executegit commit
, this command will triggerlint-staged
andcommitzen
. - If you create a PR merge to main,
changeset/actions
will create aVersion Packages
PR. confirm mergeVersion Packages
PR will triggerchangeset publish
, it's really publish.
-
.yarnrc.yml
:npmRegistryServer: "https://registry.npm.taobao.org/"
-
commitlint.config.js
:extends: ['@commitlint/config-conventional']
-
peerDependencies
:"peerDependencies": { "react": "^18.0.0", "react-dom": "^18.0.0" },
-
tsconfig.json
:"module": "esnext"
-
vite.config.ts
:target: 'esnext'
This project exists thanks to all the people who contribute.