以 npm 为例,我们来看一下操作步骤。
一、首先在 npm 官网注册自己的账号
注册地址:https://www.npmjs.com/signup
注意:记住你填写的用户名、邮箱、密码,等下你在本地是需要用这些信息登录的。
二、如何写一个 npm 插件?
1. 项目初始化
新建一个空文件夹,存放你的插件源代码。
然后执行npm init
,初始化项目的一些基本信息。
然后你会发现项目中多了一个package.json的文件。
2. 编写插件内容
我们先写一个简单的测试例子。
在根目录新建一个index.js文件,简单地写一个测试函数,模拟插件内容。
3. 发布插件包
首先,先在本地登录你刚刚注册的账号。
执行 npm login
,输入用户名、密码以及你注册时的邮箱。
如果是npm,最后还会给你的邮箱发个验证码,填上之后再回车,才算真正登录成功。
然后看一下你的package.json
文件:
{
// 这个是你的包名,不能和npm库已有的包重名。
// 如果你的名字已经被被人用了,你要再换一个
"name": "test",
// 这个是你的包版本,每次发布前都要更新一下。
"version": "1.0.0",
"description": "一个测试插件",
// 这个是你的包入口,就是你源代码打包后的入口文件路径地址。
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
按上述描述,修改你的配置后,执行npm publish
,即可将你的插件发布到npm上。
4. 如何使用你发布的包
在npm官网搜索关键词,找到你的包,确认它发布成功。
然后在你的项目中,使用 npm install xxx
(xxx替换成你的包名),即可安装使用。
5. 插件编写注意事项
在刚刚的第2点中,我们只是简单的写了个函数测试发包的流程,正式的插件应该是包含一个完整可用的功能,肯定不止这么简单,也会有很多依赖项,需要打包工具的辅助等等。
那么如果编写一个完善的npm插件呢?需要有哪些注意事项呢?期待下篇~