diff --git a/.gitignore b/.gitignore index b512c09..678c1ec 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -node_modules \ No newline at end of file +node_modules +prefs.plist diff --git a/EB659F0C-7997-4F23-AECB-2B470BDA0ECE.png b/EB659F0C-7997-4F23-AECB-2B470BDA0ECE.png deleted file mode 100644 index a79477b..0000000 Binary files a/EB659F0C-7997-4F23-AECB-2B470BDA0ECE.png and /dev/null differ diff --git a/README.MD b/README.MD index c2e28d5..979fcc5 100644 --- a/README.MD +++ b/README.MD @@ -2,11 +2,12 @@ -An [Alfred workflow](https://www.alfredapp.com/) to easily search through [Atlassian Confluence](https://www.atlassian.com/software/confluence) written in [NodeJS](https://nodejs.dev/) using [Alfy](https://github.com/sindresorhus/alfy) +An [Alfred workflow](https://www.alfredapp.com/) to search through [Atlassian Confluence](https://www.atlassian.com/software/confluence) written in [NodeJS](https://nodejs.dev/) using [Alfy](https://github.com/sindresorhus/alfy). -Inspired by [Alfred Confluence written in Python2](https://github.com/skleinei/alfred-confluence) by [skleinei](https://github.com/skleinei) +Inspired by [Alfred Confluence written in Python2](https://github.com/skleinei/alfred-confluence) by [skleinei](https://github.com/skleinei). ## Automatic notification of updates + The workflow informs you when a new version is available ![image](https://user-images.githubusercontent.com/644550/181432647-27ebc1f7-da6f-4816-a96d-2854f30eef30.png) @@ -18,17 +19,18 @@ npm install --global alfred-confluence-search *Requires [Node.js](https://nodejs.org) 14+ and the Alfred [Powerpack](https://www.alfredapp.com/powerpack/).* -## Workflow Environment Variables +## Workflow User Configuration 1. Click on the `[X]` (red arrow) to open the Workflow Environment Variables window -2. Set the value of the 3 Workflow Environment Variables: - - `BASE_URL` - When your Confluence url is https://myawesomecompany.atlassian.net/wiki/spaces/MYK/pages/1323642387/Bootstrapping the `BASE_URL` is `https://myawesomecompany.atlassian.net` - - `USERNAME` - username to login into your Atlassian account - - `API_TOKEN` your Atlassian API token from https://id.atlassian.com/manage-profile/security/api-tokens +2. Set the value of the 3 Workflow User Configuration values: + * Base URL: + * When your Confluence url is `https://myawesomecompany.atlassian.net/wiki/spaces/MYK/pages/1323642387/Bootstrapping` your Base URL is `https://myawesomecompany.atlassian.net` + * Username + * The username you use to log in to your Atlassian account + * API token + * Your Atlassian API token from https://id.atlassian.com/manage-profile/security/api-tokens ## Usage diff --git a/info.plist b/info.plist index 45eed44..8d77f5c 100644 --- a/info.plist +++ b/info.plist @@ -25,7 +25,7 @@ createdby Bas van Dijk description - + Alfred workflow to search through Atlassian Confluence written in NodeJS disabled name @@ -58,9 +58,9 @@ queuemode 1 runningsubtext - Searching + Searching… script - ./node_modules/.bin/run-node index.js "$1" + npx run-node index.js "$1" scriptargtype 1 @@ -87,12 +87,14 @@ browser + skipqueryencode + + skipvarencode + spaces url {query} - utf8 - type alfred.workflow.action.openurl @@ -103,59 +105,108 @@ readme - Confluence Quick Search using NodeJS - -I was using alfred-confluence by skleinei https://github.com/skleinei/alfred-confluence - -Unfortunately this was based on Python2 which is not part of MacOS Monterey anymore. + # Confluence Quick Search using NodeJS -Since I am a NodeJS developer I created my own script which uses NodeJS +I was using [`alfred-confluence` by @skleinei](https://github.com/skleinei/alfred-confluence). -Make sure you've set the following Workflow Environment Variables: +Unfortunately this is based on Python 2 which is not part of macOS Monterey anymore. -BASE_URL -When your Confluence url is https://myawesomecompany.atlassian.net/wiki/spaces/MYK/pages/1323642387/Bootstrapping the BASE_URL is https://myawesomecompany.atlassian.net +Since I am a NodeJS developer I created my own script which uses NodeJS. -USERNAME -Username to login into your Atlassian account +You’ll need to supply the required User Configuration: -API_TOKEN -Your Atlassian API token from https://id.atlassian.com/manage-profile/security/api-tokens +* Base URL: + * When your Confluence url is `https://myawesomecompany.atlassian.net/wiki/spaces/MYK/pages/1323642387/Bootstrapping` your Base URL is `https://myawesomecompany.atlassian.net` +* Username + * The username you use to log in to your Atlassian account +* API token + * Your Atlassian API token from https://id.atlassian.com/manage-profile/security/api-tokens uidata 072D55A5-F67B-47F0-ABEF-1D45225C6EEA xpos - 275 + 275 ypos - 105 + 105 EB659F0C-7997-4F23-AECB-2B470BDA0ECE xpos - 100 + 100 ypos - 105 + 105 - variables - - API_TOKEN - - BASE_URL - - USERNAME - - - variablesdontexport + userconfigurationconfig - BASE_URL - API_TOKEN - USERNAME + + config + + default + + placeholder + + required + + trim + + + description + Your Atlassian API token from https://id.atlassian.com/manage-profile/security/api-tokens + label + API token + type + textfield + variable + API_TOKEN + + + config + + default + + placeholder + + required + + trim + + + description + If your Confluence url is https://myawesomecompany.atlassian.net/wiki/spaces/MYK/pages/1323642387/Bootstrapping your Base URL is https://myawesomecompany.atlassian.net + label + Base URL + type + textfield + variable + BASE_URL + + + config + + default + + placeholder + + required + + trim + + + description + Your username for logging in to your Atlassian account + label + Username + type + textfield + variable + USERNAME + version 0.0.1 webaddress - https://usto.nl + https://github.com/basvdijk/alfred-confluence-search