包规范
CommonJS的包规范由两个部分组成
- 包结构
- 用于组织包中的各种文件
- 包实际上就是一个压缩文件,解压之后规范的目录应该包含如下文件:
- package.json 描述文件
- bin 可执行二进制文件
- 一般用于编译工具的配置
- lib js代码
- doc 文档
- test 单元测试
- 包描述文件
- 描述包的相关信息,以供外部读取分析
package.json
包描述文件 package.json
- 用于表达非代码相关的信息,
- 位于包的 根目录下。
- json文件里不能写注释
package.json中的字段
| key | description |
|---|---|
| name | 名字 |
| description | 描述 |
| version | 版本 |
| keywords | 关键字 |
| maintainers | 主要贡献者 |
| contributors | 贡献者 |
| bugs | 地址 |
| licenses | 协议 |
| repositories | 仓库 |
| dependencies | 依赖 |
| homepage | 主页 |
| os | 系统 |
| cpu | cpu |
| engine | 引擎 |
| builtin | 构建工具 |
| directories | |
| implements | |
| scripts | |
| author | |
| bin | |
| main | |
| devDependencies |