npm.md 1.2 KB

造轮子(NPM)篇

注册npm账号,并登陆。

npm login

初始化项目

mkdir xxx-tool
cd xxx-tool
npm init

创建各类配置文件,如果使用ES2015及之后特性,需要用到Babel.js的,需要编译发布。

参考项目: https://github.com/willin/waliyun

package.json:

"scripts": {
  "compile": "./node_modules/.bin/babel src --out-dir dist",
  "prepublish": "npm run compile"
}

发布至NPM

1.检查.gitignore.npmignore文件是否配置好

通常两者内容相近。如:

node_modules/
*.log
.DS_Store

.gitignore中一般忽略生产环境编译输出的目录dist/.npmignore中忽略源码目录src/

2.检查package.json中的版本号

相同版本号不能反复发布。不能降级发布。每次需要更新并累加版本。

3.发布

npm publish

发布测试版本:

npm publish --tag beta

发布私有模块到NPM

初始化项目的时候可以加入参数:

npm init --scope=<your_scope>

或者直接修改package.json中的项目名称为:

@scope/project-name
# 或
@username/project-name

参考文档: https://docs.npmjs.com/private-modules/intro