前端工程化之组织篇

61 阅读2分钟

开启掘金成长之旅!这是我参与「掘金日新计划 · 12 月更文挑战」的第6天,点击查看活动详情

image.png

范围模块

Monorepo模式:是一种仓库管理风格,它把每个项目放到不同仓库中,每个项目对应一个单独仓库分散管理。

Npm也有一种类似Monorepo模式用于管理Npm模块,它就是Scope,被Scope管理的模块称为范围模块。Scope是一种把相关模块组织到一起的模块管理风格,也会在某些地方影响Npm对模块的处理

多包仓库

lerna是一种Monorepo解决方案,用于管理包括多个子包的仓库,可优化使用GitNpm管理多包仓库的工作流程。

image.png

开源输出

项目配置文件

配置文件package.json的构成: image.png

某些字段非常重要,要清楚
1、 version:表示版本编号,格式为主版本.次版本.修订版本
2、 main/module/browser:都表示入口文件,他们是有区别的

image.png

软件许可证书

License指软件许可证书,又称开源协议(是大佬好的项目必备,来约束一些被行业反感的行为)

  • MIT是一份很宽松的开源协议,它允许对源码做任何形式的改动与推广,若不知如何选择就使用该协议
  • GPL是一份很自由的开源协议,它鼓励免费,若不介意的话可用该协议
  • BSD是一份很严格的开源协议,它未经事先书面许可不得使用,若介意的话可用该协议

项目自述文档

Readme指项目自述文件,用于为使用者提供项目详细信息。Github中有一个堪称教科书式的Readme项目standard-readme,它为开发者提供一份标准化的编写规范。
一份基本的readme至少也要包括这些:

  •  Title:标题
  •  Short Description:简短描述
  •  Table of Contents:内容列表
  •  Install:安装
  •  Usage:用法
  •  License:许可证书