NodeBB插件编写——MVP

这篇文章主要写如何实现一个小插件的编写。分为三个部分：

• 基础文件
• script文件的引入
• 找合适的hook、

下面开始正文

---

最基本的三部分

• plugin.json
• package.json
• library.js

plugin.json例子：

{
  "id": "nodebb-plugin-post-comments",  
  "name": "Manage Comments for Post",  
  "description": "anage Comments for Post",
  "url": "-",
  "library": "./library.js",
  "hooks": [
    { "hook": "filter:scripts.get", "method": "addScripts" }
  ]

最基本的三部分就是这个样子的。相信id,name,description这些属性都是不需要太多解释的。
url属性：当你将编写好的插件放到github上后，这个就是git地址
library属性：是一个入口文件
hooks属性：就是一个hook数组，存放hook以及所对应的方法。

对于hooks和library这两个属性，谈一下自己的理解。

plugin.json是一个媒人，这里有一个关于她故事。
{ "hook": "filter:scripts.get", "method": "addScripts" }
有一个叫hook的女子在媒人那里注册了，并且hook有间小房子叫addScripts，坐落在小镇library.js里。

有一天，一个男子在合适的时机下赢得（firehook）了hook女子的芳心，并给她送去了聘礼（参数），于是媒人告知女子，女子便在家中接受聘礼。

接下来的日子，女子对聘礼做了一些处理变成回礼，然后给男方发回。至此，成就一段姻缘。

这里的plugin.json是个很厉害的媒人哦！

这里重要的事情就是 时机 和 礼尚往来 。
配置
在/package.json中将新插件添加进去。

"nodebb-plugin-post-comments": "file:./plugins/nodebb-plugin-post-comments"

嗯，所以从这里大家就应该可以看出来这个新插件是创建在项目根目录下面/plugins/nodebb-plugin-post-comments 。
那么这样写是为什么呢？是这样的，我们在上传GIT的时候是不上传node_modules文件夹的。所以我们要将新插件写在外面。当我们从GIT上面克隆下来后，只需要执行

npm i

就好了。

---

script文件的引入

• 首先我们要找到一个钩子，这里我们用的是filter:scripts.get,
  添加js文件main.js nodebb-plugin- 在plugin.json里面添加两句

"staticDirs": { 
 "lib": "public/lib"
},
"scripts": [  
"lib/main.js"
]

注意：第五行的lib是public/lib，有没有很有意思。哈哈！

• 然后在源码中搜索filter:scripts.get，发现

plugins.fireHook('filter:scripts.get', [], next);

这里主要看参数，发现一个空数组，一个回调函数。
所以呢，
library.js中的函数addScripts方法的两个参数就是[], next。

• 接下来，

scripts.push('plugins/nodebb-plugin-post-comments/lib/main.js');
callback(null, scripts);

里面的callback一定要写，否则会报一个警告，说是callback超时什么的。
这样的话，我们就将js脚本加上了。
可以在脚本里面对页面进行操作，做各种你需要的事情。

---

奇葩的错误一把把

• 在一句语句结束的时候，请记得一定要加上；——这非常重要，因为你的某个文件里面没有加这句话，有可能会影响到你的下一个文件没有办法正常编写。
• 当你的新插件可以显示在管理员页面时，记得将它激活！

PLUGIN---->plugin install---->找到插件---->active