小知识

如何发布自定义的npm包

2021-01-17  本文已影响0人  周星星的学习笔记

一、在https://www.npmjs.com/上注册账号

注册在此就不做赘述了,唯一注意的点是注册之后一定要去邮箱进行验证,否则后面发包的时候会报错

二、创建好自己的包文件

1.创建包目录

mkdir zhouxingxing

2.进入包目录中

cd zhouxingxing

3.执行npm init初始化包信息

npm init


4.创建index.js并编写代码示例如下(index.js文件就是package.json中main参数定义的入口文件)
const app = {
    name: 'zhouxingxing',
    say() {
        console.log('hello');
    }
}
module.exports = app

三、登录并发布

1.设置npm镜像源为npm官网的镜像源

npm config set registry https://registry.npmjs.org/

2.登录npm账号

npm login

3.登录之后可以查看当前登录的用户名,确认登录状态
npm whoami

4.执行publish命令进行发布

#若在当前包里面
npm publish

#若在包外面,publish 后面需要跟上包的路径名
npm publish  {package_path}

5.看到类似界面表明发布成功

promote:zhouxingxing zhoujiafei$ npm publish 
npm notice 
npm notice 📦  zhouxingxing@1.0.0
npm notice === Tarball Contents === 
npm notice 110B index.js    
npm notice 276B package.json
npm notice === Tarball Details === 
npm notice name:          zhouxingxing                            
npm notice version:       1.0.0                                   
npm notice package size:  366 B                                   
npm notice unpacked size: 386 B                                   
npm notice shasum:        b0325789f4bf8b4af8d39b3bdd54f896e60d9a72
npm notice integrity:     sha512-nfCI/eIz0JuNO[...]LJmPxEmObypQg==
npm notice total files:   2                                       
npm notice 
+ zhouxingxing@1.0.0

6.如果需要更新包,需要修改一下package.json里面的版本号,然后再次执行:npm publish

四、使用

1.创建测试目录并初始化

mkdir test
npm init -y

2.安装包

npm install zhouxingxing

3.新建测试文件index.js

const app = require('zhouxingxing');
app.say();
console.log(app.name);

4.最终目录结构如下

├── index.js
├── node_modules
│   └── zhouxingxing
│       ├── index.js
│       └── package.json
├── package-lock.json
└── package.json

5.执行index.js

#使用node来执行
node index.js
#执行结果如下
promote:test zhoujiafei$ node index.js 
hello
zhouxingxing
上一篇下一篇

猜你喜欢

热点阅读