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

第49章 NodeBB 插件配置:详解 plugin.json 文件结构与核心属性

plugin.json 每个插件包都包含一个名为 plugin.json 的配置文件。 以下是一个示例,请注意并非所有选项都是必需的: { "id": "nodebb-plugin-myplugin", "url": "指向你的插件或 Github 仓库的绝对 URL", "library": "./my-plugin.js", "staticDirs": { "images": "public/images" }, "scss": [ "assets/style.scss" ], "hooks": [ { "hook": "filter:post.save", "method": "filter" }, { "hook": "action:post.save", "method": "emailme" } ], "scripts": [ "public/src/client.js" ], "acpScripts": [ "public/src/admin.js" ], "modules": { "../client/myplugin.js": "./public/src/myplugin.js", "../admin/plugins/myplugin.js": "./public/src/admin.js" }, "upgrades": [ "upgrades/your_upgrade_script.js" ], "languages": "path/to/languages", "templates": "path/to/templates" }

id 是插件的唯一标识符。NodeBB 将通过此 id 来引用你的插件,如果发布到 npm,NodeBB 会尝试下载与此 id 同名的包。 library 属性是指向你包中库的相对路径。如果插件已激活,NodeBB 会自动加载该库。 staticDirs 属性是一个对象哈希,它将路径(相对于插件根目录)映射到一个目录,NodeBB 会在 /plugins/{YOUR-PLUGIN-ID} 路由下公开该目录。

例如,示例配置中的 staticDirs 哈希将 /path/to/your/plugin/public/images 映射到 /plugins/my-plugin/images

有关静态目录的更多信息请参见此处。 scss 属性包含一个路径数组(相对于你的插件目录),这些路径将被预编译为 NodeBB 提供的 CSS。 hooks 属性是一个数组,其中包含告诉 NodeBB 哪些钩子被你的插件使用,以及当该钩子被调用时在你的库中调用的方法。每个对象包含以下属性(带 * 的为必需项):

hook,NodeBB 钩子的名称 method,在你的插件中被调用的方法 priority,该方法最终被调用时的相对优先级(默认值:10)

scripts 属性是一个包含文件的数组,这些文件将被编译并打包到提供给用户的压缩 JavaScript 载荷中。 acpScripts 属性与 scripts 类似,不同之处在于这些文件被编译并打包到管理控制面板 (ACP) 中提供的压缩载荷中。 modules 属性允许你将第三方 AMD 风格的脚本嵌入到你的插件中。有关更多信息,请参见 使用第三方库。 upgrades 数组是可选的,对于通过 NodeBB 的升级系统无缝更新插件的数据库架构很有用。有关更多细节,请查看 NodeBB 的 dbsearch 插件中的此示例。 languages 属性是可选的,允许你为插件(或主题)设置自己的国际化配置。请设置类似核心的目录结构,例如: language/en-GB/myplugin.json。 templates 属性是可选的,允许你定义一个包含要加载到 NodeBB 中的模板文件的文件夹。请设置类似核心的目录结构,例如:partials/topic/post.tpl。

评论 (0)