godbout/alfred-workflow-workflow

Takes care of all the Alfred glue for you so that you need to code only what is specific to your Workflow.

1.3.0 2022-05-06 16:25 UTC

This package is auto-updated.

Last update: 2022-11-29 17:06:44 UTC


README

Latest Stable Version Build Status Quality Score Code Coverage Total Downloads

Tired of writing the same code over and over just to get your new Workflow up and running? Yeah me too.

DOUBLE WHAMMY WORKFLOW

An Alfred Workflow does only two things:

1. show results  
2. do an action  
2.5. ok send a notification, maybe

which means, why typing over and over those same stuff over and over. I say stop to wasting keyboard keys. (Even more if you work on a MacBook because the keyboard will break soon.)

BUT WTF IS THAT, REALLY

Basically it's a set of base classes and some conventions and an Alfred Workflow Skeleton to get you up in no time. Follow the conventions and all you have to do is create your Menus, and your Actions. All the boring rest is handled by the Skeleton, and this package. The common glue is taken care of. You focus only on the specificity of your Workflow.

Installation

composer require godbout/alfred-workflow-workflow

The Conventions

Well this is where it gets interesting, because i'm still not sure how to express it. Best currently is to go through different use cases together. See the three cases below.

Case 1: Alfred Ploi

This is the most straightforward Workflow. It doesn't override anything so it follows all the conventions, and only defines what it specifically needs.

  1. Your Workflow Class only needs to define the possible actions of the Workflow: https://github.com/godbout/alfred-ploi/blob/0.1.0/src/Workflow.php
  2. Your Entrance Menu Class defines what should be shown to the Alfred user when they start the Workflow: https://github.com/godbout/alfred-ploi/blob/0.1.0/src/Menus/Entrance.php. Entrance is a convention for the first Menu of your Workflow (although you can name it whatever you want, but then you need to override the currentMenu method. See Alfred Time below). All other Menus can be called whatever you want, as they will be defined as args of your Menu Items.
  3. The script called by Alfred only checks whether you're showing a Menu or calling an Action: https://github.com/godbout/alfred-ploi/blob/0.1.0/src/app.php

That's it. Just pass the right args and variables according to the conventions and it just works.

Check the Alfred Ploi Workflow for the Workflow Skeleton: https://github.com/godbout/alfred-ploi/releases/tag/0.1.0

Case 2: Alfred Kat

This Workflow overrides only the do and notify methods.

  1. The do method needs a specific argument, so it is overriden: https://github.com/godbout/alfred-kat/tree/4.1.0/src/Workflow.php#L10
  2. The notify method needs to send different notifications, so it is overriden too: https://github.com/godbout/alfred-kat/tree/4.1.0/src/Workflow.php#L21
  3. The Menus (only one in this case) are not overriden: https://github.com/godbout/alfred-kat/tree/4.1.0/src/Menus/Entrance.php

All the rest of the wiring is handled by this package, and the Alfred Workflow Skeleton: https://github.com/godbout/alfred-kat/releases/tag/4.1.0

Case 3: Alfred Time

This is the hardest one. It overrides:

  1. The do method, passing an argument, sometimes: https://github.com/godbout/alfred-time/blob/3.0.0/src/Workflow.php#L37
  2. The notify method, for custom messages: https://github.com/godbout/alfred-time/blob/3.0.0/src/Workflow.php#L52
  3. The way Menus are loaded, because in this Workflow, Menus are arranged in specific (Timer Services) folders: https://github.com/godbout/alfred-time/blob/3.0.0/src/Workflow.php#L30

And yet, even in this case, most of the code is just specific code for this particular Workflow. Most of the Alfred wiring is handled by this package, and the Workflow Skeleton: https://github.com/godbout/alfred-time/releases/tag/3.0.0

Args and Variables

So, a Workflow does two things:

  1. show a Menu
  2. do an Action

How do you tell Alfred which Menu to show or which Action to run? Through the args and variables.

For example, in your Entrance Menu Class, you show a menu:

class Entrance extends BaseMenu
{
    public static function scriptFilter()
    {
        ScriptFilter::add(
            Item::create()
                ->title('Choose your Project')
                ->arg('choose_project')
        );

        // ...
    }

Alfred will then call your src/Menus/ChooseProject.class Class and its scriptFilter method, where you design what appears in your next Menu.

Any arg that is different than do is taken as a Menu, loaded from the src/Menus folder (with the default convention, as see with Alfred-Time, you can override how/where the Menus are loaded).

To do an Action:

class SelectFile extends BaseMenu
{
    public static function scriptFilter()
    {
        ScriptFilter::add(
            Item::create()
                ->title('Delete File')
                ->arg('do')
                ->variable('action', 'deleteFile'),
            Item::create()
                ->title('Copy File')
                ->arg('do')
                ->variable('action', 'copyFile');
        );

        // ...
    }
}

For the first item, Alfred will call your Workflow Class and its deleteFile method. For the second item, the copyFile method.

For a simple example, see the Alfred Ploi Workflow source again.