PicGo 插件 PicMigrater 的启动与配置教程

一、项目目录结构及介绍

picgo-plugin-pic-migrater/
├── .github/              # GitHub 工作流和相关文件
│   └── workflows/
├── .vscode/              # Visual Studio Code 的配置文件
├── dist/                 # 编译后的文件
├── src/                  # 源代码目录
│   ├── index.ts          # 插件入口文件
│   └── ...               # 其他源代码文件
├── test/                 # 测试文件目录
├── .eslintrc.js          # ESLint 配置文件
├── .gitignore            # Git 忽略文件
├── .npmignore            # NPM 忽略文件
├── .prettierrc           # Prettier 配置文件
├── license               # 项目许可证
├── package.json          # 项目配置文件
├── README.md             # 项目说明文档
└── ...                   # 其他文件

• .github/: 存放 GitHub Actions 工作流文件，用于自动化测试、发布等。
• .vscode/: 存放 Visual Studio Code 的配置文件。
• dist/: 存放编译后的代码文件。
• src/: 源代码目录，包含插件的主体逻辑。
• test/: 测试文件目录，用于存放单元测试和集成测试代码。
• 其他配置文件：用于项目开发过程中的各种配置。

二、项目启动文件介绍

项目的启动文件位于 src/index.ts。这是 PicGo 插件的入口文件，它负责初始化插件，并暴露出插件的接口供 PicGo 主程序调用。以下是 index.ts 文件的基本内容：

import { Plugin } from 'picgo'

export default function (context: Plugin) {
  const plugin: Plugin = {
    name: 'pic-migrater',
    main: () => {
      // 插件主要逻辑
    },
    // 其他插件方法和配置
  }
  return plugin
}

在 main 方法中，你可以编写插件的主要功能逻辑。

三、项目配置文件介绍

项目的配置文件位于 package.json。这个文件定义了项目的名称、版本、描述、入口文件、依赖关系等信息。以下是 package.json 文件的基本内容：

{
  "name": "picgo-plugin-pic-migrater",
  "version": "1.0.0",
  "description": "PicGo 插件，用于图片迁移",
  "main": "dist/index.js",
  "scripts": {
    "build": "tsc"
  },
  "dependencies": {
    "picgo": "^1.0.0"
  },
  "devDependencies": {
    "@types/node": "^14.0.0",
    "typescript": "^4.0.0"
  }
}

在 scripts 部分，定义了构建项目的命令，这里使用 tsc 命令来编译 TypeScript 代码。在 dependencies 部分列出了项目依赖的库，这里是 picgo 库。在 devDependencies 部分列出了开发时依赖的库。