进阶 docs.nodebb.org 2026-10-13 15:07:09 · 33 阅读

第41章 NodeBB 插件开发入门

开始 我们致力于让在 NodeBB 上开发插件的体验尽可能流畅且开放。 NodeBB 使用 Benchpress 作为模板引擎,在后端使用 Express 来提供页面服务,并使用 Webpack 来打包客户端 JavaScript。当然,还有其他依赖项,但上述这几个是与插件开发者最相关的。 最简单的入手方式是参考 Quickstart 插件。这是一个模板仓库,意味着你不应该将它安装到 NodeBB 环境中,而应该 fork 它,以此作为你自己插件的基础。 更多细节请参见我们的 Quickstart 插件解析。

获取页面数据 NodeBB 中的每个页面都使用 JSON 数据渲染。你可以在 URL 前加上 /api 来查看这些数据。例如,如果你正在 /recent 页面,可以导航到 /api/recent 来查看对应的 JSON 数据。当 NodeBB 以生产模式启动时,JSON 输出不会进行格式化,因此较难阅读;你可以在 URL 中添加 ?pretty=1 来美化输出。

构建资源 NodeBB 在运行和向最终用户提供页面之前,需要一个构建步骤。可以通过运行 ./nodebb build 手动触发此构建流程。不过,由于根据具体的计算机配置不同,构建过程本身可能耗时较长,因此存在其他优化开发流程的策略。这些策略同样适用于开发插件和主题的场景。

选择性构建资源 如果你只需要构建 NodeBB 的特定部分,./nodebb build 可以接受以空格分隔的参数来限定其范围。 例如,如果你正在修改插件的管理员页面,可以选择构建: ./nodebb build adminjs admincss tpl

... 这将只构建 ACP JavaScript、ACP 样式表和模板。 可以通过运行以下命令查看完整的列表: ./nodebb build -h

如果你对源码感兴趣,请参阅此链接

Grunt 为了优化开发体验,NodeBB 团队(以及许多插件作者)在其工作流中使用了 Grunt。前置依赖项会在 npm install 步骤中随 NodeBB 一起安装,但你可能需要安装 grunt-cli(或你的发行版中对应 Grunt 的软件包),以便通过命令行调用 Grunt。 安装完成后,只需运行 grunt 即可构建所有资源并启动 NodeBB。Grunt 还会监视文件变化,并选择性地构建 NodeBB 资源的一个子集,因此无需返回控制台去停止 NodeBB、构建、然后重启 NodeBB。 或者,你可以运行 grunt --skip,这会跳过构建步骤,直接以启用文件监视的方式运行 NodeBB。

测试 为了对 NodeBB 运行测试,请向你的 config.json 文件添加以下配置块: "test_database": { "host": "127.0.0.1", "port": "27017", "username": "", "password": "", "database": "test" }

通过 npm test 运行整套测试,或通过 npx mocha test/your_test_file.js 运行单个文件。 如果测试中还需要激活某个特定的插件,请向你的 config.json 文件添加以下配置块: "test_plugins": [ "nodebb-plugin-xyz" ]

评论 (0)