首页
/ Remotely Save插件全流程指南:从环境配置到社区发布

Remotely Save插件全流程指南:从环境配置到社区发布

2026-04-09 09:08:52作者:傅爽业Veleda

准备开发环境:搭建基础架构

要开始Remotely Save插件的开发与发布流程,首先需要配置完整的开发环境。确保系统已安装Node.js(建议v14+)和npm包管理器,这是构建过程的基础依赖。通过以下命令克隆项目代码库:

git clone https://gitcode.com/gh_mirrors/re/remotely-save
cd remotely-save
npm install

该项目采用双构建系统架构,Webpack配置(webpack.config.js)适用于生产环境打包,提供代码压缩和浏览器兼容性处理;esbuild配置(esbuild.config.mjs)则专注于开发效率,提供更快的构建速度。两种构建方式生成的核心输出文件相同,均为main.js、manifest.json和styles.css。

配置核心参数:定制插件行为

核心配置环节涉及环境变量与元数据文件两大关键部分。环境变量用于管理云服务API凭证,在构建过程中被注入为全局常量。创建项目根目录下的.env文件,配置必要的服务密钥:

# 云服务API配置示例
DROPBOX_APP_KEY=your_dropbox_application_key
ONEDRIVE_CLIENT_ID=your_onedrive_client_identifier
GOOGLEDRIVE_CLIENT_ID=your_google_api_credentials

manifest.json作为插件元数据文件,需特别关注以下关键字段:

  • id:插件唯一标识符,固定为"remotely-save"
  • version:遵循语义化版本规范,格式为major.minor.patch
  • minAppVersion:指定兼容的Obsidian最低版本
  • isDesktopOnly:控制是否仅限桌面环境运行

每次版本迭代时,必须同步更新manifest.json与package.json中的version字段,确保版本一致性。

执行质量验证:确保发布可靠性

质量验证体系包含自动化测试与手动验证两部分。项目测试套件位于tests目录,通过以下命令执行完整测试:

npm test

关键测试项包括:

  1. 配置持久化测试(configPersist.test.ts):验证用户设置的保存与恢复机制
  2. 加密功能测试(encryptOpenSSL.test.ts):确保数据加密/解密流程的正确性
  3. 元数据管理测试(metadataOnRemote.test.ts):检查云端文件元数据的同步逻辑

预发布检查清单:

  • [ ] 所有自动化测试用例通过验证
  • [ ] 核心功能在Windows、macOS和Linux系统测试正常
  • [ ] 插件体积控制在Obsidian社区要求范围内(通常<5MB)
  • [ ] 文档已更新至最新版本,包括README与各云服务配置指南
  • [ ] 无敏感信息(如API密钥)硬编码在源代码中

实施发布策略:多渠道分发方案

插件发布采用分级推进策略,确保版本稳定性。首先通过Git版本控制管理发布周期:

npm version patch  # 修订版本更新,适用于bug修复
# 或 npm version minor  # 次要版本更新,适用于新功能
# 或 npm version major  # 主要版本更新,适用于不兼容变更
git push --tags

构建生产版本:

npm run build  # 使用Webpack生成优化后的生产版本

发布渠道对比:

  • GitHub Release:作为官方分发渠道,需上传三个核心文件(main.js、manifest.json、styles.css),提供详细的版本变更说明
  • Obsidian社区市场:需提交GitHub Release链接进行审核,优势在于覆盖Obsidian内置插件市场的庞大用户群体
  • 手动安装:适合测试版本分发,用户通过Obsidian的"第三方插件"功能手动安装,需提供明确的安装指引

发布后需监控社区反馈,建立问题响应机制,通常建议在48小时内对关键bug提供修复版本。

登录后查看全文
热门项目推荐
相关项目推荐