alejandrohdezma / alfred4s   1.0.0

#!/usr/bin/env -S scala-cli shebang

//> using dep "com.alejandrohdezma::alfred4s:1.0.0"

import alfred4s.syntax.*

alfred4s.app(args) {
  case "hello" :: Nil => 
    item("Hello world!")

  case "urls" :: environment :: Nil => 
    items(item("https://example.com/1"), item("https://example.com/2"))
}

import alfred4s.syntax.*

// Changes the title displayed in the result row
item("Original title").title("This is title that will be displayed")

import alfred4s.syntax.*

// A unique identifier for the item. It allows Alfred to learn about the item 
// for subsequent sorting and ordering of the user's actioned results.
//
// It is important that you use the same UID throughout subsequent executions of
// your script to take advantage of Alfred's knowledge and sorting. To show
// results in the order you return them from your script, exclude the UID field.
item("This will be the title").uid("1234")

import alfred4s.syntax.*

// The subtitle displayed in the result row

item("This will be the title").subtitle("This will be the subtitle")

import alfred4s.syntax.*

// Enables you to define what Alfred matches against when the workflow is set to
// 'Alfred Filters Results'.
//
// If match is present, it fully replaces matching on the title property.
//
// The match field is always treated as case insensitive, and intelligently
// treated as diacritic insensitive. If the search query contains a diacritic,
// the match becomes diacritic sensitive.
item("This will be the title").matching("alfred will match user input on this string")

import alfred4s.syntax.*

// The argument which is passed through the workflow to the connected output action.
//
// While optional, it's highly recommended that you populate arg as it's the
// string which is passed to your connected output actions. If excluded, you
// won't know which result item the user has selected.
item("This will be the title").arg("Zelda")

import alfred4s.syntax.*

// The icon displayed in the result row. Workflows are run from their workflow
// folder, so you can reference icons stored in your workflow relatively.
item("This will be the title").icon("icons/kratos.png")

import alfred4s.syntax.*

// Adds a new modifier to this item. Modifiers gives you control over how the
// modifier keys react. It can alter the looks of a result (e.g. subtitle, icon)
// and output a different arg or session variables.
item("This will be the title").mod("cmd")(alfred4s.mod.arg("false"))

import alfred4s.syntax.*

// Adds a new variable to this item. Variables are passed out of the Script
// Filter object and remain accessible throughout the current session as
// environment variables if the associated result item is selected in Alfred's
// results list.
item("This will be the title").variable("item_id", "1234")

import alfred4s.syntax.*

// Whether the item is valid or not. If an item is valid then Alfred will action
// it when the user presses return. If the item is not valid, Alfred will do
// nothing. This allows you to intelligently prevent Alfred from actioning a result
// based on the current `{query}` passed into your script.
//
// By default, Alfred assumes your item is valid.
item("This will be the title").validIf(userId.nonEmpty)

import alfred4s.syntax.*

// Defines the text the user will get when displaying large type with ⌘L
item("This will be the title").largetype(someLargeString)

import alfred4s.syntax.*

// If the item should be hidden from results or not
item("This will be the title").hideWhen(isInvalid)

alfred4s.app(args) {
  case "hello" :: Nil => 
    item("Hello world!")

  case "urls" :: environment :: Nil => 
    items(item("https://example.com/1"), item("https://example.com/2"))
}

alfred4s.appWithNewVersionCheck(args, "my-org", "my-workflow", gitHubToken) {
  case "hello" :: Nil => 
    item("Hello world!")

  case "urls" :: environment :: Nil => 
    items(item("https://example.com/1"), item("https://example.com/2"))
}

import alfred4s.syntax.*
import scala.concurrent.duration.*

items(item("My item")).cache(10.minutes)

def sayHello(name: String): Seq[Item] = ???
def getUrlsFor(environment: String): Seq[Item] = ???

alfred4s.app(args) {
  case "hello" :: name :: Nil => 
    alfred4s.cached(s"hello_$name", 5.days)(sayHello(name))

  case "urls" :: environment :: Nil => 
    items(getUrlsFor(environment)).cache(12.hours).enableLooseReload
}