Joplin 插件备份项目教程

Joplin 插件备份项目教程

joplin-plugin-backup A plugin to extend Joplin with a manual and automatic backup function. 项目地址: https://gitcode.com/gh_mirrors/jo/joplin-plugin-backup

项目目录结构及介绍

Joplin 插件备份项目是一个用于扩展 Joplin 笔记应用手动和自动备份功能的开源插件。以下是项目的目录结构及其简要介绍：

• __test__：包含插件的单元测试文件。
• api：包含插件 API 相关的文件。
• img：存放项目相关的图片资源。
• src：插件的主要源代码目录。
• .github/：包含 GitHub Actions 工作流文件。
• .husky/：包含 husky 配置文件，用于在提交代码前执行钩子脚本。
• .vscode/：包含 Visual Studio Code 的配置文件。
• CHANGELOG.md：记录了插件的更新历史和更改。
• FULLRESTORE.md：提供了完整的 Joplin 恢复指南。
• GENERATOR_DOC.md：包含了生成器文档的更新信息。
• LICENSE：插件的 MIT 许可证文件。
• README.md：插件的说明文档。
• package-lock.json：npm 包的锁定文件。
• package.json：插件的 npm 配置文件。
• plugin.config.json：插件的配置文件。
• tsconfig.json：TypeScript 的配置文件。
• webpack.config.js：webpack 的配置文件。

项目的启动文件介绍

项目的启动主要通过 src 目录下的 TypeScript 文件进行。以下是主要的启动文件：

• index.ts：插件的入口文件，负责初始化插件和注册命令。
• backupService.ts：负责备份逻辑的服务类文件。

这些文件在编译后会被打包到插件的发布版本中，并由 Joplin 应用加载执行。

项目的配置文件介绍

项目的配置主要通过 plugin.config.json 文件进行。以下是配置文件的简要介绍：

{
  "id": "io.github.jackgruber.backup",
  "name": "Backup",
  "description": "A plugin to extend Joplin with a manual and automatic backup function.",
  "version": "1.4.2",
  "author": "Jack Gruber",
  "config": {
    "Backups interval in hours": {
      "type": "number",
      "default": 24,
      "min": 1,
      "max": 168
    }
  }
}

这个文件定义了插件的标识信息，包括 ID、名称、描述、版本和作者。同时，它还定义了插件的配置项，例如自动备份的间隔时间（以小时为单位），默认值为24小时，可配置的最小值为1小时，最大值为168小时。这些配置项可以在 Joplin 的插件设置界面中进行调整。

joplin-plugin-backup A plugin to extend Joplin with a manual and automatic backup function. 项目地址: https://gitcode.com/gh_mirrors/jo/joplin-plugin-backup