文档

项目结构

一个结构清晰的项目是可维护和可扩展的基础。Sliprail 扩展项目有一个标准结构,其中 manifest.json 文件是核心。

标准项目结构

一个典型的扩展项目看起来像这样:

my-extension/
├── main.mjs            # 扩展的主入口文件
├── manifest.json       # 扩展清单文件
├── icon.svg            # (可选) 扩展的图标
├── node_modules/       # 项目依赖
├── package.json        # 项目元数据和脚本
└── README.md           # (可选) 扩展的说明文档

manifest.json 清单文件

manifest.json 文件定义了您的扩展如何与 Sliprail 系统集成。它包含了扩展的唯一标识、图标和主入口文件等关键信息。

一个简单的 manifest.json 示例:

{
  "id": "your-extension-id",
  "icon": "icon.svg",
  "main": "main.mjs"
}

依赖管理

Sliprail 不会自动为扩展运行 npm install。这意味着如果您的扩展使用了 npm 包,您必须将所有依赖项与您的代码一起打包。

  • 打包依赖: 您的构建过程(通常在模板中已配置)需要将 node_modules 中的代码捆绑到最终的输出文件中。
  • 包含所有文件: 推送到 GitHub 仓库时,确保包含了所有打包后的文件,以便扩展无需额外安装步骤即可运行。

这种方法确保了扩展在任何用户系统上都能拥有一致和可靠的运行环境。