1.注册一个NPM账号
去官网https://www.npmjs.com/注册。
2.安装nodejs
去官网https://nodejs.org/安装即可,环境配置什么的都调好,开始写项目
3.新建一个项目
在本地创建一个项目文件夹abc,然后通过终端进入文件夹
注意:文件夹名字不要和NPM上已有的包名称重复,可以先去NPM库搜搜要起的名字有没有存在
cd abc
通过命令创建一个包信息管理文件package.json,此时会初始化npm的相关配置
npm init
package.json内容大概如下,里面包括包的基本信息:
名称、版本号、描述、项目主入口、脚本、关键字、作者等等,可以根据包的信息来填写,或者可以一路回车先按照默认的内容提交
{
"name": "abc",
"version": "1.0.0",
"description": "test",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": ""
},
"keywords": [
"sugars",
"demo"
],
"author": {
"name": "wangmmx725",
"email": "Wangmmx0725@163.com"
},
"license": ""
}
创建主逻辑代码,打开项目文件,新建index.js
function getWords() {
return "hahaha";
}
module.exports = getWords
基本的功能就已经完成了
最后可以在包的目录下新建README.md文件,添加对包的描述和介绍,README.md的信息会同步在NPM的介绍页上。
4.发布NPM包
打开终端,第一次发布需要添加NPM账号,按要求输入账号密码和邮箱号
npm adduser
不是第一次发布直接登录即可,也是按要求输入账号密码和邮箱号
npm login
发布包
npm publish
当终端显示成功的信息就可以了,去NPM官网可以看到发布的包了,网络问题有时需要等一下
会遇到报错一般是包的名字重复了,先去搜一下是否有人发布
5.取消发布
npm unpublish [--force] 可以强制取消
6.更新发布的包
先更新,参数有以下
patch:小变动,比如修复bug等,版本号变动 v1.0.0->v1.0.1
minor:增加新功能,不影响现有功能,版本号变动 v1.0.0->v1.1.0
major:破坏模块对向后的兼容性,版本号变动 v1.0.0->v2.0.0
npm version patch
再发布
npm publish
7.应用自己的包
先安装自己的包
npm i abc --save
再在代码中引用
var abc = require('abc');
console.log(abc.getWords());
以上即为发布一个NPM的nodejs包的全过程,欢迎批评指正