Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drgrib/alfred
A fast, simple way to make Alfred workflow script filters in Go
https://github.com/drgrib/alfred
alfred alfred-workflow alfred3 alfred3-workflow go golang workflow
Last synced: 6 days ago
JSON representation
A fast, simple way to make Alfred workflow script filters in Go
- Host: GitHub
- URL: https://github.com/drgrib/alfred
- Owner: drgrib
- Created: 2018-07-04T21:54:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-23T18:11:05.000Z (10 months ago)
- Last Synced: 2024-10-13T09:06:38.137Z (22 days ago)
- Topics: alfred, alfred-workflow, alfred3, alfred3-workflow, go, golang, workflow
- Language: Go
- Homepage:
- Size: 199 KB
- Stars: 32
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Easy Alfred Workflow Script Filters in Go
[![GoDoc][godoc-icon]][godoc-link]
This is a lean but [comprehensive](full-json.md) implementation of the Alfred Script Filter JSON Format to get Alfred workflows off the ground quickly with blazingly fast script filters in Go that can be seamlessly developed inside or outside Alfred.
It uses standard, familiar Go syntax and conventions as much as possible for rapid use by Go developers and integration with other Go code.
## Installation
```
go get github.com/drgrib/alfred
```
## Full Alfred JSON Support
[full-json.md](full-json.md) has examples of how to produce the full range of JSON output for Alfred's Script Filter JSON Format.
## A Simple Example
Let's say we want to create a simple script filter that converts a given query to title case, lower case, or upper case, for which Go conveniently has built-in support.
Let's start by prototyping our logic in Go with a `case.go` file in our workflow folder. We can do this on the command line or in the editor of our choice and easily run it inside or outside of Alfred:
``` go
package main
import (
"strings"
"github.com/drgrib/alfred"
)
func addCases(arg string) {
titlecase := strings.Title(arg)
alfred.Add(alfred.Item{
Title: titlecase,
Subtitle: "Title",
Arg: titlecase,
UID: "titlecase",
})
lowercase := strings.ToLower(arg)
alfred.Add(alfred.Item{
Title: lowercase,
Subtitle: "Lower",
Arg: lowercase,
UID: "lowercase",
})
uppercase := strings.ToUpper(arg)
alfred.Add(alfred.Item{
Title: uppercase,
Subtitle: "Upper",
Arg: uppercase,
UID: "uppercase",
})
}
func main() {
arg := "just a test"
addCases(arg)
alfred.Run()
}
```
``` json
{
"items": [
{
"uid": "title",
"title": "Just A Test",
"subtitle": "Title",
"arg": "Just A Test"
},
{
"uid": "lower",
"title": "just a test",
"subtitle": "Lower",
"arg": "just a test"
},
{
"uid": "upper",
"title": "JUST A TEST",
"subtitle": "Upper",
"arg": "JUST A TEST"
}
]
}
```
Looks good. Now let's add `os.Args` support and test it on the command line to simulate Alfred input:
``` go
package main
import (
"os"
"strings"
"github.com/drgrib/alfred"
)
// [same stuff in the middle]
func main() {
arg := os.Args[1]
addCases(arg)
alfred.Run()
}
```
``` bash
go build case.go
./case "another test"
```
``` json
{
"items": [
{
"uid": "title",
"title": "Another Test",
"subtitle": "Title",
"arg": "Another Test"
},
{
"uid": "lower",
"title": "another test",
"subtitle": "Lower",
"arg": "another test"
},
{
"uid": "upper",
"title": "ANOTHER TEST",
"subtitle": "Upper",
"arg": "ANOTHER TEST"
}
]
}
```
Right again. Alright. Now let's drop this into our script filter:
And give it a whirl:
Why not copy these to the clipboard so we can actually use them?
With a few simple runs and a glance at the Alfred clipboard history, we can see we are ready for business:
Easy!
[godoc-icon]: https://godoc.org/github.com/drgrib/alfred?status.svg
[godoc-link]: https://godoc.org/github.com/drgrib/alfred