├── gradle.properties ├── settings.gradle.kts ├── .github └── FUNDING.yml ├── illustrations ├── awesome.png ├── workflow_directory.png └── workflow_settings.png ├── workflow_resources ├── icon.png ├── 0C50E033-DAE4-4512-9073-379D41B1A11C.png └── info.plist ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── src └── main │ └── kotlin │ └── org │ └── stvad │ ├── alfred │ └── package.kt │ ├── extlib │ └── alfy.kt │ └── example_workflow.kt ├── .gitignore ├── LICENSE ├── README.md ├── gradlew.bat └── gradlew /gradle.properties: -------------------------------------------------------------------------------- 1 | kotlin.code.style=official -------------------------------------------------------------------------------- /settings.gradle.kts: -------------------------------------------------------------------------------- 1 | rootProject.name = "kotlin-alfred-workflow-template" -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: Stvad 4 | patreon: stvad 5 | -------------------------------------------------------------------------------- /illustrations/awesome.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Stvad/kotlin-alfred-workflow-template/master/illustrations/awesome.png -------------------------------------------------------------------------------- /workflow_resources/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Stvad/kotlin-alfred-workflow-template/master/workflow_resources/icon.png -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Stvad/kotlin-alfred-workflow-template/master/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /illustrations/workflow_directory.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Stvad/kotlin-alfred-workflow-template/master/illustrations/workflow_directory.png -------------------------------------------------------------------------------- /illustrations/workflow_settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Stvad/kotlin-alfred-workflow-template/master/illustrations/workflow_settings.png -------------------------------------------------------------------------------- /workflow_resources/0C50E033-DAE4-4512-9073-379D41B1A11C.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Stvad/kotlin-alfred-workflow-template/master/workflow_resources/0C50E033-DAE4-4512-9073-379D41B1A11C.png -------------------------------------------------------------------------------- /src/main/kotlin/org/stvad/alfred/package.kt: -------------------------------------------------------------------------------- 1 | package org.stvad.alfred 2 | 3 | data class AlfredResult(val title: String, val subtitle: String = "", val arg: String = "", val uuid: String = "") 4 | -------------------------------------------------------------------------------- /src/main/kotlin/org/stvad/extlib/alfy.kt: -------------------------------------------------------------------------------- 1 | package org.stvad.extlib 2 | 3 | import org.stvad.alfred.AlfredResult 4 | 5 | @JsModule("alfy") 6 | external object alfy { 7 | val input: String 8 | fun output(items: List) 9 | } -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /src/main/kotlin/org/stvad/example_workflow.kt: -------------------------------------------------------------------------------- 1 | package org.stvad 2 | 3 | import org.stvad.alfred.AlfredResult 4 | import org.stvad.extlib.alfy 5 | 6 | fun main() { 7 | val isAwesome = "${alfy.input} Is Awesome" 8 | alfy.output(listOf( 9 | AlfredResult( 10 | isAwesome, 11 | arg = isAwesome 12 | ) 13 | )) 14 | } 15 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled class file 2 | *.class 3 | 4 | # Log file 5 | *.log 6 | 7 | # BlueJ files 8 | *.ctxt 9 | 10 | # Mobile Tools for Java (J2ME) 11 | .mtj.tmp/ 12 | 13 | # Package Files # 14 | *.jar 15 | *.war 16 | *.nar 17 | *.ear 18 | *.zip 19 | *.tar.gz 20 | *.rar 21 | 22 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 23 | hs_err_pid* 24 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 Vladyslav Sitalo 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # kotlin-alfred-workflow-template 2 | A template for creating [Alfred](https://www.alfredapp.com/) workflows with KotlinJS 3 | 4 | Actually useful workflow I've built using this: https://github.com/Stvad/FuzzyDate 5 | 6 | ## How to use the template: 7 | 1. Clone this repository 8 | 1. Build it via `./gradlew build` 9 | 1. Add symlink from Alfred workflow directory to the `workflow_resources` directory 10 | * You can find out the Alfred workflow directory by righ-clicking any of the workflows you have and choosing `Open in Finder/Terminal` 11 | 12 | ![](illustrations/workflow_directory.png) 13 | 14 | 1. At this point you should have a fully functional workflow that you can invoke via `this` keyword. It'd append `Is Awesome` to your input and would allow you to copy the result to clipboard or paste it into the frontmost application 15 | 16 | ![](illustrations/awesome.png) 17 | 18 | 1. Now you can edit the workflow settings/details directly in Alfred 19 | 20 | ![](illustrations/workflow_settings.png) 21 | 22 | 1. The core workflow logic is located in the [example_workflow.kt](src/main/kotlin/org/stvad/example_workflow.kt) file. Change it to build your own workflow. 23 | 24 | **Other points of interest**: 25 | * `AlfredResult` data class that represents an one item of results to be returned to Alfred 26 | * This template is using [alfy](https://github.com/sindresorhus/alfy) library to abstract the details of communicating with Alfred. And to simplify publishing resulting workflow to NPM. 27 | 28 | ### Publishing workflow to NPM 29 | 1. [Create and log into npm account](https://docs.npmjs.com/creating-a-new-npm-user-account) 30 | 1. Give the workflow a different name 😉 31 | 1. Build it 32 | 1. Go to the `build/js/packages/` and run `npm publish` 33 | 34 | ## This workflow in NPM 35 | 36 | `npm install -g kotlin-alfred-workflow-template` 37 | 38 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS="-Xmx64m" 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS='"-Xmx64m"' 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /workflow_resources/info.plist: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | bundleid 6 | org.stvad.example 7 | category 8 | Tools 9 | connections 10 | 11 | 0C50E033-DAE4-4512-9073-379D41B1A11C 12 | 13 | 14 | destinationuid 15 | 459E7D46-309D-4B35-A7F3-B8BCFE295918 16 | modifiers 17 | 1048576 18 | modifiersubtext 19 | Copy without pasting the frontmost application 20 | vitoclose 21 | 22 | 23 | 24 | destinationuid 25 | E875006D-D5CE-4BA8-8DB1-309E01B4339E 26 | modifiers 27 | 0 28 | modifiersubtext 29 | 30 | vitoclose 31 | 32 | 33 | 34 | 26312337-87B9-4E36-B72B-C7F659E81E54 35 | 36 | 37 | destinationuid 38 | 0C50E033-DAE4-4512-9073-379D41B1A11C 39 | modifiers 40 | 0 41 | modifiersubtext 42 | 43 | vitoclose 44 | 45 | 46 | 47 | 48 | createdby 49 | Vladyslav Sitalo 50 | description 51 | An Example Alfred Workflow built with Kotlin 52 | disabled 53 | 54 | name 55 | Kotlin Example Workflow 56 | objects 57 | 58 | 59 | config 60 | 61 | autopaste 62 | 63 | clipboardtext 64 | {query} 65 | transient 66 | 67 | 68 | type 69 | alfred.workflow.output.clipboard 70 | uid 71 | 459E7D46-309D-4B35-A7F3-B8BCFE295918 72 | version 73 | 3 74 | 75 | 76 | config 77 | 78 | alfredfiltersresults 79 | 80 | alfredfiltersresultsmatchmode 81 | 0 82 | argumenttreatemptyqueryasnil 83 | 84 | argumenttrimmode 85 | 0 86 | argumenttype 87 | 0 88 | escaping 89 | 102 90 | keyword 91 | this 92 | queuedelaycustom 93 | 3 94 | queuedelayimmediatelyinitially 95 | 96 | queuedelaymode 97 | 0 98 | queuemode 99 | 1 100 | runningsubtext 101 | 102 | script 103 | package_name=kotlin-alfred-workflow-template 104 | cd ../build/js/packages/$package_name 105 | ./node_modules/.bin/run-node kotlin/$package_name.js "$1" 106 | scriptargtype 107 | 1 108 | scriptfile 109 | 110 | subtext 111 | 112 | title 113 | Kotlin Example Workflow 114 | type 115 | 0 116 | withspace 117 | 118 | 119 | type 120 | alfred.workflow.input.scriptfilter 121 | uid 122 | 0C50E033-DAE4-4512-9073-379D41B1A11C 123 | version 124 | 3 125 | 126 | 127 | config 128 | 129 | autopaste 130 | 131 | clipboardtext 132 | {query} 133 | transient 134 | 135 | 136 | type 137 | alfred.workflow.output.clipboard 138 | uid 139 | E875006D-D5CE-4BA8-8DB1-309E01B4339E 140 | version 141 | 3 142 | 143 | 144 | config 145 | 146 | action 147 | 0 148 | argument 149 | 1 150 | focusedappvariable 151 | 152 | focusedappvariablename 153 | 154 | hotkey 155 | 0 156 | hotmod 157 | 0 158 | hotstring 159 | 160 | leftcursor 161 | 162 | modsmode 163 | 0 164 | relatedAppsMode 165 | 0 166 | 167 | type 168 | alfred.workflow.trigger.hotkey 169 | uid 170 | 26312337-87B9-4E36-B72B-C7F659E81E54 171 | version 172 | 2 173 | 174 | 175 | readme 176 | Convert human date to machine date. 177 | 178 | Configure date format string according to the options described here: https://www.npmjs.com/package/dateformat 179 | uidata 180 | 181 | 0C50E033-DAE4-4512-9073-379D41B1A11C 182 | 183 | xpos 184 | 205 185 | ypos 186 | 175 187 | 188 | 26312337-87B9-4E36-B72B-C7F659E81E54 189 | 190 | xpos 191 | 125 192 | ypos 193 | 450 194 | 195 | 459E7D46-309D-4B35-A7F3-B8BCFE295918 196 | 197 | xpos 198 | 540 199 | ypos 200 | 110 201 | 202 | E875006D-D5CE-4BA8-8DB1-309E01B4339E 203 | 204 | xpos 205 | 540 206 | ypos 207 | 260 208 | 209 | 210 | variables 211 | 212 | dateFormat 213 | '[['mmmm dS, yyyy']]' 214 | repeatedSeparator 215 | 216 | 217 | 218 | version 219 | 220 | webaddress 221 | https://github.com/Stvad/kotlin-alfred-workflow-template 222 | 223 | 224 | --------------------------------------------------------------------------------