npm 包上传文档
2019-05-30 本文已影响1人
行走的巨象
首先去官网注册npm账号
npm包结构
一个完全符合CommonJS规范的包目录应该包含如下这些文件:
-
package.json : 包描述文件。
-
bin: 用于存放可执行二进制文件的目录。
-
lib:用于存放javascript代码的目录。
-
doc:用于存放文档的目录。
-
test: 用于存放单元测试用例的代码。
我们开发npm包模块的时候,就可以按照以上目录结构,进行开发。
npm包发布
1、npm init
首先在本地新建文件目录,然后执行npm init 配置package.json。(注:如果此文件夹包含.git文件,会默认配置上代码的仓库地址)
入口文件默认是index.js,可手动更改。
ckage.json文件示例:
{
"name": "union_fe_tools",
"version": "1.0.0",
"description": "前端常用工具函数集",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "https://coding.jd.com/app/union_FE_Tools.git"
},
"author": "stevenson",
"license": "ISC"
}
2、npm adduser
注册npm仓库账号
输入npm adduser,然后按照提示填写即可
已经注册过的如需要登录可输入npm login
3、npm publish
如果出现错误代码:"ERR! code ENEEDAUTH" , 错误消息: "ERR! need auth auth required for publishing", 那么请使用 jnpm adduser
或者 jnpm login
来为 publish 操作授权.
(注:每次改动代码需要重新发布时,都需要改动package.json中的version)
npm包管理
通常,一个包只有一个拥有权限进行发布。如果需要多人进行发布,可以使用npm owner 命令帮助你管理包的所有者:
npm owner ls <package name>
npm owner add <user> <package name>
npm owner rm <user> <package name>
命令分别时查看、添加、删除包管理者
npm unpublish @jdunion/[name] //删除已发布的包