https://github.com/tutuxxx/public-project-best-practices

基于Lerna管理Monorepo项目的最佳实践
https://github.com/tutuxxx/public-project-best-practices

best-practices jest lerna monorepo rollup typescript vuepress

Last synced: about 2 months ago
JSON representation

基于Lerna管理Monorepo项目的最佳实践

• Host: GitHub
• URL: https://github.com/tutuxxx/public-project-best-practices
• Owner: tutuxxx
• License: mit
• Created: 2019-11-18T07:39:20.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T09:19:18.000Z (about 2 years ago)
• Last Synced: 2024-11-29T11:23:22.379Z (2 months ago)
• Topics: best-practices, jest, lerna, monorepo, rollup, typescript, vuepress
• Language: JavaScript
• Homepage: https://tutuxxx.github.io/public-project-best-practices/
• Size: 680 KB
• Stars: 13
• Watchers: 1
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# public-project-best-practices

[![](https://img.shields.io/node/v/@iworld/hello-cli.svg)](https://www.npmjs.com/package/@iworld/hello-cli)

[![](https://img.shields.io/npm/dt/@iworld/hello-runtime-core.svg)](https://www.npmjs.com/package/@iworld/hello-runtime-core)

[![](https://img.shields.io/npm/l/@iworld/hello-runtime-core.svg)](https://www.npmjs.com/package/@iworld/hello-runtime-core)

[![](https://coveralls.io/repos/github/tutuxxx/public-project-best-practices/badge.svg?branch=master)](https://coveralls.io/github/tutuxxx/public-project-best-practices)

[![](https://img.shields.io/travis/tutuxxx/public-project-best-practices.svg)](https://www.npmjs.com/package/@iworld/hello-cli)

> 良好的开端是成功的一半

## 简介

**public-project-best-practices** 是一套基于 [Lerna](https://lerna.js.org/) 管理 [Monorepo](https://en.wikipedia.org/wiki/Monorepo) 项目的最佳实践，项目整合了一系列第三方开发辅助工具，为您提供一个开箱即用的工作流。

## 特性

✅ 目录结构： [monorepo](https://en.wikipedia.org/wiki/Monorepo)

✅ 包管理：[lerna](https://lerna.js.org/)、[yarn](https://github.com/yarnpkg/yarn)

✅ 分支规范：[git-flow](https://github.com/nvie/gitflow)

✅ Commit规范：[@commitlint/cli](https://github.com/conventional-changelog/commitlint)、[@commitlint/config-conventional](https://www.conventionalcommits.org/zh-cn/v1.0.0-beta.4/#%e7%ba%a6%e5%ae%9a%e5%bc%8f%e6%8f%90%e4%ba%a4%e8%a7%84%e8%8c%83)、 [husky](https://github.com/typicode/husky)、 [commitizen](https://github.com/commitizen/cz-cli)、 [cz-lerna-changelog](https://github.com/atlassian/cz-lerna-changelog)

✅ 版本规范：[semver](https://semver.org/lang/zh-CN/)

✅ CHANGELOG自动生成：[conventional-changelog-cli](https://github.com/conventional-changelog/conventional-changelog)

✅ 自动创建Github Labels：[git-labelmaker](https://github.com/himynameisdave/git-labelmaker)

✅ 创建gitignore：[gitignore.io](https://gitignore.io/)

✅ 代码规范：[husky](https://github.com/typicode/husky)、 [esLint](https://github.com/eslint/eslint)、 [lint-staged ](https://github.com/okonet/lint-staged)、 [prettier](https://github.com/prettier/prettier)

✅ 类型安全：[typescript](https://github.com/microsoft/TypeScript)

✅ 单元测试：[jest](https://github.com/facebook/jest)

✅ 覆盖率：[istanbul](https://github.com/istanbuljs)

✅ 打包编译：[rollup](https://github.com/rollup/rollup)

✅ 持续集成：[travis](https://travis-ci.org/)

✅ 项目徽章：[shields](https://shields.io/)、[coveralls](https://coveralls.io/)

✅ README：[readme-md-generator](https://github.com/kefranabg/readme-md-generator)

✅ LOGO：[brandmark](https://brandmark.io/)、[looka](https://looka.com/)

✅ 文档：[vuepress](https://vuepress.vuejs.org/)

## 更新日志

[CHANGELOG.md](./CHANGELOG.md)

## 贡献

[贡献指南](./CONTRIBUTING.md)

## License

[MIT](https://opensource.org/licenses/MIT)