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"
]

注意:第五行的libpublic/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
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,937评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,503评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,712评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,668评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,677评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,601评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,975评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,637评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,881评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,621评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,710评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,387评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,971评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,947评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,189评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,805评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,449评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,591评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,729评论 6 342
  • GitChat技术杂谈 前言 本文较长,为了节省你的阅读时间,在文前列写作思路如下: 什么是 webpack,它要...
    萧玄辞阅读 12,669评论 7 110
  • afinalAfinal是一个android的ioc,orm框架 https://github.com/yangf...
    passiontim阅读 15,396评论 2 45
  • 清幽溢画笺,姿致恰当间。 濯影平沙柳,蒸云远岫岚。 芳音归紫燕,皓羽戏明潭。 纵有垂纶意,无心下钓竿。 前一篇:七...
    屾山泉鸣阅读 370评论 0 4