UpgradeAll 自定义源开发者文档

对应版本号：0.0.9

Table of Contents

配置结构

自定义源信息简介

Json 格式

以 GitHub 源为例：

{
   "base_version": 3,
   "uuid": "fd9b2602-62c5-4d55-bd1e-0d6537714ca0",
   "info": {
     "hub_name": "GitHub",
     "config_version": 1
   },
   "web_crawler": {
     "tool": "JavaScript",
     "file_path": "./js/GitHub.js"
   }
 }

base_version

配置格式标准版本号

当前最新版本号：3

每次 UpgradeAll 项目进行的配置格式变更、内置的 JS 引擎升级、JS API变动等有关自定义源配置的变动都会使最新版本号+1。有时不同版本并不是兼容的，你必须保证你填写了正确的版本号。

uuid

UUID 用于标记是你的配置（UUID 是随机生成的，几乎不会有重复）

可以这样说，应用只使用UUID判别配置（所以一个配置的UUID不要随便改）

你可以用这个网站随机生成UUID V4

infocustom-source-developer-documentationinfo

用于描述你的配置文件基本信息，之后会支持作者信息

它包括

config_name

你的配置的名字，一般用于概述配置所用于的源（当然，“咕咕咕”“喵喵喵”什么的也是可以的）

config_version

你的配置文件版本，你自己定，用于在线规则加入后，用于判断用户是否应该升级（如果你修改了配置文件且将配置文件分发给了他人，请务必版本号 +1）

web_crawler

爬虫配置相关

tool

用于告诉软件，你需要使用哪个软件内置的爬虫模块（目前只有 JavaScript）

tool

用于告诉软件，你的 JS 脚本文件相对该配置文件的相对位置（例如： ./js/GitHub.js）

(注意，这里可以直接填写文件在本机中的路径，也可以填写网址)

JS 脚本编写规则

参见以下教程

JS 脚本编写指南