创建NPM包
- 介绍
npm 可以非常方便地发布一个包,比 pip、gem、pear 要简单得多。在发布之前,首先 需要让我们的包符合npm的规范,npm有一套以CommonJS为基础包规范,但与CommonJS 并不完全一致,其主要差别在于必填字段的不同。
- 步骤
创建一个npm目录:
mkdir npm && cd npm复制代码
在目录中运行init:
npm init复制代码
获取一个npm账号:
npm adduser复制代码
检验账号创建情况:
npm whoami复制代码
发布你的npm包:
npm publish复制代码
这是一个无意义的测试包,使用命令删除:
npm unpublish复制代码
查看你的npm包:
https://www.npmjs.com/package/xxx复制代码
创建时的参数
- name:包的名称,必须是唯一的,由小写英文字母、数字和下划线组成,不能包含 空格。
- description:包的简要说明。
- version:符合语义化版本识别1规范的版本字符串。
- keywords:关键字数组,通常用于搜索。
- maintainers:维护者数组,每个元素要包含 name、email (可选)、web (可选) 字段。
- contributors:贡献者数组,格式与maintainers相同。包的作者应该是贡献者 数组的第一个元素。
- bugs:提交bug的地址,可以是网址或者电子邮件地址。
- licenses:许可证数组,每个元素要包含 type (许可证的名称)和 url (链接到许可证文本的地址)字段。
- repositories:仓库托管地址数组,每个元素要包含 type(仓库的类型,如 git )、 9 url (仓库的地址)和 path (相对于仓库的路径,可选)字段。