如何编写你的 Alfred Workflow

前言

每当有人问到有什么 macOS 上的提高效率的神器，Alfred 都是我脑海里第一个蹦出来的答案。Alfred with Powerpack 更是强上增强。 几乎 mac 里的一切均可以经过简单的 ⌘ + space（个人 Alfred 快捷键）获取到。

Alfred 的 workflows 是一个使我很是兴奋的功能。它能充分知足程序员自给自足的乐趣。

今天咱们不介绍 Alfred 的那些优秀的功能。只来学习下如何开发本身的 workflow。

这是成品 alfred-gitmoji-workflow。效果以下：

Gitmoji 是一个标准化和解释在GitHub提交消息上使用emojis的计划。能够理解为用来规范 git commit message 中 emoji 的使用的。

经过在 Alfred 中键入 gitmoji 就会列出全部的 gitmoji，能够经过 gitmoji 官网中提供的 emoji 名称和释义来搜索。按下回车就复制到了粘贴板，而且粘贴到你当前 focus 的窗口的输入框。

搭建工做环境

在 Alfred 打开时，键入 ⌘ + , 就会进入到偏好页。在 Alfred偏好页 -> Workflows 左侧 workflow 列表的最下方点击加号新建一个空白的 workflow。

在建立 workflow 的弹窗，填写好基本信息，须要注意的是 Bundle Id 是你这个 workflow 的签名。须要填写的独特一些。

在空白的 workflow 界面，右键。根据咱们此次须要开发的 wolkflow 的特性选择 Inputs 为 Script Filter。

而后填写关键词的一些描述信息，包括输入关键词的标题，副标题，和 Loading 时的占位词等等一些设置。

固然最重要的就是设置获得用户输入以后，对这个输入进行处理而后输出的脚本。

Alfred 提供了几种脚本语言的运行时。

一开始以为这种插件的开发应该是 JS 的天下。没想到在 Github 上用来开发 workflow 的最多的语言竟然是 PHP。我也随大流的选择了 PHP 来进行此次开发。

脚本输入框内就是最关键的两行代码，咱们的脚本入口：

$query = urlencode( "{query}" );
require_once("gitmoji.php");
复制代码

在 Alfred 中。输入gitmoji， 这个关键字后面输入的文字就做为 {query} 做为咱们脚本的输入。也就是上面咱们把这个输入 urlencode 以后赋给了变量 $query。咱们而后引用了 gitmoji.php。咱们作的搜索逻辑就是在这个 php 文件中完成的。

在列表中右键这个 workflow, 选择在 Finder 中打开，咱们就能够看到两个文件。info.plist, icon.png。info.plist 就包含了咱们刚刚填写的全部基本信息和设置选项的 xml 文件。你能够双击打开查看。 因此再建立一个 gitmoji.php 就完成了一个 workflow 的开发了。

刚刚打开的路径是/Users/xxxx/Library/Application\ Support/Alfred\3/Alfred.alfredpreferences/workflows/user.workflow.xxxxx/。

咱们通常不会选择直接在上面这个路径咱们的开发目录，由于这根本不是咱们的开发地盘。

因此在本身经常使用的开发目录下新建一个目录，将上面获得的两个文件拷贝过来。咱们新建一个空白的 workflow 的目的就是先获得这两个文件。

咱们不在 Alfred 存放 workflow 的目录开发，那咱们怎么将咱们源码放置到 workflow 指定的目录呢？

其实 Alfred 的 workflow 的文件扩展是相似 gitmoji.workflow 的一个压缩文件。双击这个压缩文件 Alfred 就会安装这个插件到上面的路径。

因此咱们就须要一个脚本帮咱们完成这个压缩（打包）的工做。

这里借鉴(copy)的是 alfred-github-workflow 的打包脚本。

#!/usr/bin/env php
<?php
// Forked from https://github.com/gharlan/alfred-github-workflow/blob/master/bin/build

$dir = dirname(__DIR__);
$VERSION = "1.0.0";
require $dir.'/workflows.php';

$plist = $dir.'/info.plist';

exec(sprintf('/usr/libexec/PlistBuddy -c "Set :version %s" %s', $VERSION, escapeshellarg($plist)));

// $changelog = file_get_contents($dir.'/CHANGELOG.md');
// $changelog = str_replace("\n", '\n', $changelog);
// exec(sprintf('/usr/libexec/PlistBuddy -c "Set :readme \"%s\"" %s', escapeshellcmd($changelog), escapeshellarg($plist)));

$zipFile = $dir.'/github.zip';
if (file_exists($zipFile)) {
    unlink($zipFile);
}

$zip = new PharData($zipFile);

$files = array(
    'icon.png',
    'info.plist',
    'gitmoji.php',
    'README.md',
    'workflows.php',
);

foreach ($files as $file) {
    $zip->addFile($dir.'/'.$file, $file);
}
foreach (glob($dir.'/icons/*.png') as $path) {
    $zip->addFile($path, 'icons/'.basename($path));
}

$zip->compressFiles(Phar::GZ);

$workflow = $dir.'/gitmoji.alfredworkflow';
if (file_exists($workflow)) {
    unlink($workflow);
}
rename($zipFile, $workflow);
复制代码

它所作的事情就是将源码（workflow 须要的几个文件）经过 php 的 PharData 类将生成一个压缩包。双击就能被 Alfred 安装。安装也就是解压缩以后复制到 workflow 的工做目录。

写脚本

<?php
require_once('workflows.php');
$w = new Workflows();
$query = urldecode(strtolower(trim($query)));

<!-- 一周更新一次 -->
if (filemtime("data.json") <= (time() - 86400 * 7)) {
    $dataUrl = 'https://raw.githubusercontent.com/carloscuesta/gitmoji/master/src/data/gitmojis.json';
    $gitmojis = $w->request($dataUrl);
    if (isset(json_decode($gitmojis)->gitmojis)) {
        file_put_contents("data.json", $gitmojis);
    }
}

<!-- 将 gitmoji 的数据设置成 Alfred 可读的数据结构  -->
function setResult($gitmojis) {
    global $w;
    foreach ($gitmojis as $key => $value) {
        $id = $value->name;
        $arg = $value->code;
        $emoji = $value->emoji;
        $title = $emoji." ".$value->description;
        $subTitle = "Copy ".$arg." to clipboard";
        $w->result($id, $arg, $title, $subTitle, ' ');
    }
}

<!-- 经过搜索词过滤出结果 -->
function filter($var) {
    global $query;
    $description = strtolower($var->description);
    $name = strtolower($var->name);
    return strpos($description,$query) !== false || strpos($name,$query) !== false;
}
$gitmojis = json_decode(file_get_contents('data.json'))->gitmojis;
$data = $gitmojis;

<!-- 没有关键词就显示全部 gitmoji -->
if (strlen($query) != 0) {
    $data = array_filter($gitmojis, "filter");
}

<!-- 获得的搜索，设置到缓冲区 -->
setResult($data);

<!-- 将结果输出成 Alfred 可读的 xml -->
echo $w->toxml();
复制代码

脚本只有短短的42行。能这么短的缘由是社区有已经封装好的很好用的 workflow util。

咱们用到的这个 util 的方法只有result，toxml。

result方法就是把数据推到一个缓冲区，而且设置了 Alfred 最终显示的每一行的数据结构。这个结构包括$uid, $arg, $title, $sub, $icon。依次对应惟一ID、结果（复制到粘贴板的字符串）、标题、副标题、icon。注意这里的 icon 只能是本地资源，不能是服务器资源。

toxml方法就是把缓冲区的数据转成 Alfred 可读的 xml 格式。

我作的事情就是获取 gitmoji 托管在 github 上的 json 数据，缓存到本地。根据关键词经过字符串匹配名字和释义。将过滤以后获得的数据转成 Alfred 须要的数据格式，而后转成 xml。

而后再终端运行 ./bin/build。就获得了一个 Alfred workflow: gitmoji.workflow。:tada::tada:

双击gitmoji.workflow安装，就能够在 Alfred 中和 gitmoji 尽情玩耍了。

TODO

其实能够作到事情还有

• 根据不一样的语言来搜索 gitmoji。惋惜 gitmoji 的维护者说还没有找到好的方法维护多语言翻译。
• 为了保持和 gitmoji 源码数据的同步，没有使用 emoji 图片做为 icon。由于这样每次 gitmoji 数据一更新，这个 workflow 也须要更新。
• 增长 update 命令：当即同步 github 数据。