Sea Nest

Sea Nest，是一款基于 React + Lit Element + TypeScript 开发的个人组件库 🎉。如果你也想学习组件开发，欢迎加入或提供意见，你的 star ⭐，是对我最大的鼓励。

✨ 特性

🌈 提炼组件库设计良好的视觉风格
📦 渐进式探索高质量的前端代码的实现
🛡 使用 TypeScript 开发，提升开发体验
✅ 使用单元测试，为组件稳定性保驾护航
📖 提供开发过程的文档思路，助力你学习组件开发
🔖 欢迎贡献组件代码，探索最佳实践

📦 Setting up the sea-nest monorepo for development

Initialize repo:

$ yarn

Build all packages:

$ npm run build

Test all packages:

$ npm run test

Or Run Doc

# 如果是第一次 必须先build才可以 docs:start
$ npm run build

$ npm run docs:start

🚧 计划

参考TODOLIST

🔨 如何安装依赖

主项目添加依赖

$ yarn add [packageName] -W -D

删除公共依赖

$ yarn remove -W -D [packageName]

给所有子项目增删依赖

$ yarn workspaces run add [packageName]
$ yarn workspaces run remove [packageName]

给某个项目增删依赖

$ yarn workspace [packageNameA] add [packageNameB@version] # packageNameA是指定安装依赖的包名，packageNameB是公共的包名或者项目内的包名
$ yarn workspace [packageNameA] remove [packageNameB]

📦 如何创建子应用

$ npm run create

默认使用根目录的tsconfig.json,如果想为每个包分别定制设置，那么可以创建一个该 package 的tsconfig.json，否则根目录的tsconfig.json就会起作用。

// 各package的tsconfig.json
{
  "extends": "../../tsconfig.json",

  "compilerOptions": {
    "outDir": "./lib"
  },

  "include": ["src/**/*"]
}

🔨 构建

$ npm run build

🚀 发布

$ npm run release

👥 Contributing

如何贡献代码查看 CONTRIBUTING

📦 dependencies

lerna：多包管理
father-build：用于构建 packages
- 支持 lerna 结构，根目录配置 .fatherrc.js，即可运行编译所有 packages
- package 目录配置的 .fatherrc.js 会继承根目录的 .fatherrc.js，因此，可以在单个 package 下新建 .fatherrc.js 去添加独有的配置

MrSeaWave/sea-nest