五分钟建立一个本身的NPM包

建立NPM包

  • 介绍

npm 能够很是方便地发布一个包,比 pip、gem、pear 要简单得多。在发布以前,首先 须要让咱们的包符合npm的规范,npm有一套以CommonJS为基础包规范,但与CommonJS 并不彻底一致,其主要差异在于必填字段的不一样。git

  • 步骤

建立一个npm目录:web

mkdir npm && cd npm
复制代码

在目录中运行init:npm

npm init
复制代码

获取一个npm帐号:数组

npm adduser
复制代码

检验帐号建立状况:bash

npm whoami
复制代码

发布你的npm包:测试

npm publish
复制代码

这是一个无心义的测试包,使用命令删除:ui

npm unpublish
复制代码

查看你的npm包:url

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 (相对于仓库的路径,可选)字段。
相关文章
相关标签/搜索