npm(发布包)
一、准备工作
在开始演示前,我们还需要做两项准备工作:
1、注册npm账户
2、全局安装nrm
npm i nrm -g
nrm是npm仓库管理的软件,可用于npm仓库的快速切换
nrm 常用命令:
nrm //展示nrm可用命令
nrm ls //列出已经配置的所有仓库
nrm test //测试所有仓库的响应时间
nrm add <registry> <url> //新增仓库
nrm use <registry> //切换仓库
二、发布包
npm官方建议规范的包至少包含:
- package.json(包的基本信息)
- README.md(文档)
- index.js (入口文件)
后续的演示都遵循此规范。
1、发布unscoped包
npmtestyang
第一步:创建项目
(1)创建工程文件夹
mkdir npmtestyang && cd yuyy-test-pkg
(2)创建package.json
npm init -y
按照提示一步步完善即可,也可使用npm init -y
使用npm默认设置,稍后再通过编辑package.json修正。
注意:本次演示的包的入口文件是index.js,请务必确保package.json中字段main对应的值是“index.js”。
最终结果:
{
"name": "npmtestyang",
"version": "1.0.0",
"description": "my first npm package",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [
"npm",
"package"
],
"author": "yangyang",
"license": "ISC"
}
(3)创建README.md
内容:
### npmtestyang
This is my first npm package!
It is just for learning.
(4)创建index.js
内容:
module.exports = {
printMsg: function () {
console.log('this message is from yuyy-test-pkg!');
}
}
最终的目录结构:
┢━━npmtestyang
┣━━index.js
┣━━package.json
┗━━README.md
第二步:发布
npm publish
第三步:去npm 官网搜索
有可能有延迟,不能立马看不到。