包结构
一个符合CommonJS规范的包,目录结构应该为:
- package.json: 包的描述文件
- bin:用于存放可执行二进制文件的目录
- lib:用于存放Javascript代码的目录
- doc:用于存放文档的目录
- test:用于存放单元测试用例的代码
描述文件package.json
ConmmonJS为package.json定义了一些必选字段:
字段名 | 描述 |
---|---|
name | 包名 |
desciption | 包简介 |
version | 版本号 |
keywords | 关键词数组,用于NPM的分类搜索 |
maintainers | 包维护者列表 |
contributors | 贡献者列表 |
bugs | 反馈bug的网页地址 |
licenses | 当前包使用的许可证列表 |
repositories | 托管源代码的位置列表 |
dependencies | 使用当前包所需要的包列表 |
NPM常用功能
npm -v
用于查看当前npm的版本
npm install
可以使用npm i简写。主要是用来安装依赖包。
npm init
初始化一个npm包,执行该命令后,会在包生成一个package.json。
npm adduser
在NPM仓库中建立一个账号
npm publish
上传包到NPM仓库
npm owner
管理包权限,正常来讲一个包只有一个人有权限发布。使用该命令可以给其他人添加权限
npm ls
分析包,可以分析当前路径下能够通过模块路径找到的所有包,并生成依赖数。
比如查看某个包都引入了什么其他依赖包,可以使用该功能