nod 包的定义和使用

包的定义和使用

什么是包?

1. 英文名叫做 Packages，包是在模块基础上更深一步的抽象；
2. 包的目的：方便分发和推广基于 CommonJS 规范实现的 应用程序 或 类库；
3. 包可以看作是 模块、代码 和 其它资源 组合起来形成的 独立作用域；

规范的包结构

1. 包都要以一个单独的目录而存在；
2. package.json 必须在包的顶层目录下；
3. package.json 文件必须符合 JSON 格式，并且必须包含如下三个属性：name, version, main
   • name: 包的名字
   • version: 包的版本号
   • main: 表示包的入口文件
4. 二进制文件应该在bin目录下;
5. javaScript代码应该在lib目录下;
6. 文档应该在doc目录下;
7. 单元测试应该在test目录下;
8. Node.js对包要求并没有那么严格，只要顶层目录下有package.json，并符合基本规范即可;

包描述文件 package.json【了解】

name：包的名称，必须是唯一
description：包的简要说明
version：符合语义化版本识别规范的版本字符串
keywords：关键字数据，通常用于搜索
maintainers：维护者数组，每个元素要包含name、email、web可选字段
contributors：贡献者数组，格式与maintainers相同。包的坐着应该是贡献者数据的第一个元素
bugs：提交bug的地址，可以是网址或者电子邮件地址
licenses：许可证数组，每个元素要包含type和url字段
repositories：仓库托管地址数组，每个元素要包含type、url和path字段
dependencies：包的依赖，一个关联数组，由包名称和版本号组成。
devDependencies：开发依赖项，表示一个包在开发期间用到的依赖项