alfy 2.1.0 → 3.1.0

package/index.d.ts

@@ -20,9 +20,32 @@ export type OutputOptions = {
 	The script will only be re-run if the script filter is still active and the user hasn't changed the state of the filter by typing and triggering a re-run. For example, it could be used to update the progress of a particular task:
 	*/
 	readonly rerunInterval?: number;
+
+	/**
+	Variables passed out of the script filter and accessible throughout the current session as environment variables.
+
+	These are session-level variables that persist for the duration of the user action. Individual items can also have their own `variables` which override these when selected.
+
+	@example
+	```
+	import alfy from 'alfy';
+
+	alfy.output(
+		[
+			{
+				title: 'Unicorn',
+				arg: 'unicorn',
+			}
+		],
+		{
+			variables: {animal: 'unicorn'}
+		}
+	);
+	```
+	*/
+	readonly variables?: Record<string, string>;
 };
 
-// eslint-disable-next-line unicorn/prevent-abbreviations
 export type CacheConfGetOptions = {
 	/**
 	Get the item for the key provided without taking the `maxAge` of the item into account.
@@ -30,7 +53,6 @@ export type CacheConfGetOptions = {
 	readonly ignoreMaxAge?: boolean;
 };
 
-// eslint-disable-next-line unicorn/prevent-abbreviations
 export type CacheConfSetOptions = {
 	/**
 	Number of milliseconds the cached value is valid.
@@ -39,7 +61,7 @@ export type CacheConfSetOptions = {
 };
 
 // TODO: Rename this in the next major version.
-// eslint-disable-next-line unicorn/prevent-abbreviations
+
 export type CacheConf<T extends Record<string, any> = Record<string, unknown>> = {
 	isExpired: (key: keyof T) => boolean;
 
@@ -367,9 +389,9 @@ export type Alfy = {
 	/**
 	Log value to the Alfred workflow debugger.
 
-	@param text
+	@param value
 	*/
-	log: (text: string) => void;
+	log: (value: unknown) => void;
 
 	/**
 	Display an error or error message in Alfred.

package/index.js

@@ -3,18 +3,20 @@ import process from 'node:process';
 import {createRequire} from 'node:module';
 import Conf from 'conf';
 import got from 'got';
-import {hookStderr} from 'hook-std';
 import loudRejection from 'loud-rejection';
 import cleanStack from 'clean-stack';
 import {getProperty} from 'dot-prop';
 import AlfredConfig from 'alfred-config';
-import updateNotification from './lib/update-notification.js'; // eslint-disable-line import/order
+import updateNotification from './lib/update-notification.js'; // eslint-disable-line import-x/order
 
 const require = createRequire(import.meta.url);
 const CacheConf = require('cache-conf');
 
 const alfy = {};
 
+// Track if output has been generated to avoid empty JSON
+let hasOutput = false;
+
 updateNotification();
 
 const getIcon = name => `/System/Library/CoreServices/CoreTypes.bundle/Contents/Resources/${name}.icns`;
@@ -41,8 +43,9 @@ alfy.alfred = {
 
 alfy.input = process.argv[2];
 
-alfy.output = (items, {rerunInterval} = {}) => {
-	console.log(JSON.stringify({items, rerun: rerunInterval}, null, '\t'));
+alfy.output = (items, {rerunInterval, variables} = {}) => {
+	hasOutput = true;
+	console.log(JSON.stringify({items, rerun: rerunInterval, variables}, null, '\t'));
 };
 
 alfy.matches = (input, list, item) => {
@@ -73,6 +76,7 @@ alfy.log = text => {
 
 alfy.error = error => {
 	const stack = cleanStack(error.stack || error);
+	const title = error.stack ? `${error.name}: ${error.message}` : String(error);
 
 	const copy = `
 \`\`\`
@@ -86,7 +90,7 @@ ${process.platform} ${os.release()}
 	`.trim();
 
 	alfy.output([{
-		title: error.stack ? `${error.name}: ${error.message}` : error,
+		title,
 		subtitle: 'Press ⌘L to see the full error and ⌘C to copy it.',
 		valid: false,
 		text: {
@@ -97,6 +101,9 @@ ${process.platform} ${os.release()}
 			path: alfy.icon.error,
 		},
 	}]);
+
+	// Also output to stderr for the debugger (as requested in issue #86)
+	console.error(stack);
 };
 
 alfy.config = new Conf({
@@ -133,7 +140,7 @@ alfy.fetch = async (url, options) => {
 	delete options.transform;
 	delete options.maxAge;
 
-	const key = rawKey.replaceAll('.', '\\.');
+	const key = rawKey.replaceAll('.', String.raw`\.`);
 	const cachedResponse = alfy.cache.get(key, {ignoreMaxAge: true});
 
 	if (cachedResponse && !alfy.cache.isExpired(key)) {
@@ -181,6 +188,12 @@ alfy.icon = {
 
 loudRejection(alfy.error);
 process.on('uncaughtException', alfy.error);
-hookStderr(alfy.error);
+
+// Ensure valid JSON output even if user forgets to call alfy.output() (fixes #82)
+process.on('beforeExit', () => {
+	if (!hasOutput) {
+		alfy.output([]);
+	}
+});
 
 export default alfy;

package/lib/update-notification.js

@@ -2,7 +2,7 @@ import {readPackageUp} from 'read-package-up';
 import alfredNotifier from 'alfred-notifier';
 
 export default async function updateNotification() {
-	const {package: package_} = await readPackageUp();
+	const {package: package_} = (await readPackageUp()) ?? {};
 	const alfy = package_?.alfy ?? {};
 
 	if (alfy.updateNotification !== false) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "alfy",
-	"version": "2.1.0",
+	"version": "3.1.0",
 	"description": "Create Alfred workflows with ease",
 	"license": "MIT",
 	"repository": "sindresorhus/alfy",
@@ -17,7 +17,7 @@
 	},
 	"sideEffects": false,
 	"engines": {
-		"node": ">=18"
+		"node": ">=20"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd"
@@ -47,21 +47,21 @@
 		"alfred-notifier": "^0.2.3",
 		"cache-conf": "^0.6.0",
 		"clean-stack": "^5.2.0",
-		"conf": "^13.0.1",
-		"dot-prop": "^9.0.0",
-		"execa": "^9.3.0",
-		"got": "^14.4.2",
-		"hook-std": "^3.0.0",
+		"conf": "^14.0.0",
+		"dot-prop": "^10.0.0",
+		"execa": "^9.6.0",
+		"got": "^14.4.8",
+		"hook-std": "^4.0.0",
 		"loud-rejection": "^2.2.0",
 		"read-package-up": "^11.0.0"
 	},
 	"devDependencies": {
-		"ava": "^6.1.3",
+		"ava": "^6.4.1",
 		"delay": "^6.0.0",
-		"nock": "^13.5.4",
+		"nock": "^14.0.10",
 		"tempfile": "^5.0.0",
-		"tsd": "^0.31.1",
-		"xo": "^0.59.2"
+		"tsd": "^0.33.0",
+		"xo": "^1.2.2"
 	},
 	"tsd": {
 		"compilerOptions": {

package/readme.md

@@ -151,13 +151,16 @@ test('main', async t => {
 
 ## Debugging
 
-When developing your workflow it can be useful to be able to debug it when something is not working. This is when the [workflow debugger](https://www.alfredapp.com/help/workflows/advanced/debugger/) comes in handy. You can find it in your workflow view in Alfred. Press the insect icon to open it. It will show you the plain text output of `alfy.output()` and anything you log with `alfy.log()`:
+When developing your workflow it can be useful to be able to debug it when something is not working. This is when the [workflow debugger](https://www.alfredapp.com/help/workflows/advanced/debugger/) comes in handy. You can find it in your workflow view in Alfred. Press the insect icon to open it. It will show you the plain text output of `alfy.output()` and anything you log with `alfy.log()` or `console.error()`:
 
 ```js
 import alfy from 'alfy';
 
 const unicorn = getUnicorn();
 alfy.log(unicorn);
+
+// You can also use console.error() for debugging
+console.error('Debug info:', {data: someData});
 ```
 
 ## Environment variables
@@ -231,13 +234,35 @@ alfy.output(
 
 <img src="media/screenshot-output.png" width="694">
 
+###### variables
+
+Type: `object`
+
+Variables passed out of the script filter and accessible throughout the current session as environment variables. These are session-level variables that persist for the duration of the user action. Individual items can also have their own `variables` which override these when selected.
+
+```js
+import alfy from 'alfy';
+
+alfy.output(
+	[
+		{
+			title: 'Unicorn',
+			arg: 'unicorn',
+		}
+	],
+	{
+		variables: {animal: 'unicorn'}
+	}
+);
+```
+
 #### log(value)
 
 Log `value` to the [Alfred workflow debugger](https://www.alfredapp.com/help/workflows/advanced/debugger/).
 
 #### matches(input, list, item?)
 
-Returns an `string[]` of items in `list` that case-insensitively contains `input`.
+Returns a `string[]` of items in `list` that case-insensitively contains `input`.
 
 ```js
 import alfy from 'alfy';

package/run-node.sh

@@ -13,7 +13,25 @@ PATH_CACHE="$alfred_workflow_cache"/node_path
 
 get_user_path() {
 	eval $(/usr/libexec/path_helper -s)
-	echo "$($SHELL -i -l -c 'echo -e "\n"PATH=\"$PATH:\$PATH\""\n"' 2>/dev/null | grep "^PATH=")" > "$PATH_CACHE"
+
+	# Use delimiters to reliably extract PATH from shell startup noise (inspired by `shell-env`).
+	# Disable Oh My Zsh plugins that can block the process.
+	local delimiter="_ALFY_ENV_DELIMITER_"
+	local raw_env
+	raw_env="$(DISABLE_AUTO_UPDATE=true ZSH_TMUX_AUTOSTARTED=true ZSH_TMUX_AUTOSTART=false $SHELL -ilc "echo -n $delimiter; command env; echo -n $delimiter; exit" 2>/dev/null)"
+
+	# Extract the env output between the delimiters.
+	local env_output="${raw_env#*"$delimiter"}"
+	env_output="${env_output%%"$delimiter"*}"
+
+	# Extract PATH from the env output.
+	local user_path
+	user_path="$(echo "$env_output" | sed -n 's/^PATH=//p')"
+
+	# Only write cache if we got a non-empty result.
+	if [[ -n "$user_path" ]]; then
+		echo "PATH=\"${user_path}:\$PATH\"" > "$PATH_CACHE"
+	fi
 }
 
 set_path() {