Doggy 扩展开发手册

文档的这一部分提供了 Doggy 扩展的详细规范。有了这些信息，您就可以创建自己的扩展。

扩展概述

为了让 Doggy 的功能更丰富，各种功能以一个个的扩展存在。一个扩展中会包含一个或者多个指令，这些指令最后会被显示到 Doggy 的指令列表中。

扩展包的组成

一个包含配置文件、指令脚本文件和其他文件(如图标、源文件和自述文件)的文件夹，以 .doggyext 为后缀名。

指令分类

其中指令脚本文件，可能是：

• 一个简单的 zsh 脚本文件，后缀名为 .sh；
• 一个简单的 JXA 脚本文件，后缀名为 .js，具体请参考 JXA 扩展开发介绍；
• 一个基于 React 的前端程序，是一个包含了该前端程序的目录；

一个可能的扩展程序的文件组织如下：

• 文件夹xxx.doggyext

  • package.json
  • README.md
  • 文件夹react-app

    • 文件夹components

      • Header.js
    • index.js
  • script.js

其中只有 package.json 文件是必须的，其他根据需求添加。

package.json

package.json 文件中，与 Doggy 扩展相关的字段都在 ext 字段中。其他字段为一个 NodeJS 常用的字段。

ext 配置字段

字段名	类型	默认值	说明
identifier	String	”ArchiveUtil”	当前扩展的唯一标识符

基本配置示例

{
    // NodeJS 程序属性
    "name": "archive-util",
    "version": "1.0.0",
    "description": "",
    "author": "",
    "dependencies": {
    },
    "scripts": {
        "build": "doggy-extension-script build"
    },
    // Doggy 扩展属性
    "ext": {
        "identifier": "ArchiveUtil",
    }
}

详细说明

identifier

扩展的唯一标识符，使用驼峰命名法。