feat(espanso): support custom path

extensions/espanso/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Espanso Changelog
 
+# [Path Configuration] - {PR_MERGE_DATE}
+
+- Add a preference to configure the path to the Espanso executable
+- Explicitly set the path to the Espanso executable as `/opt/homebrew/bin/espanso` for Apple Silicon macs and `/usr/local/bin/espanso` for Intel macs
+
 ## [Patch] - 2024-07-09
 
 - Remove form items from the list.

extensions/espanso/package.json

@@ -6,14 +6,24 @@
   "icon": "espanso-logo.png",
   "author": "kud",
   "contributors": [
-    "nbbaier"
+    "nbbaier",
+    "erics118"
   ],
   "categories": [
     "Applications",
     "System",
     "Productivity"
   ],
   "license": "MIT",
+  "preferences": [
+    {
+      "name": "espansoPath",
+      "type": "textfield",
+      "required": false,
+      "title": "Espanso CLI Path",
+      "description": "Location to the Espanso CLI (Defaults to `/opt/homebrew/bin/espanso` on Apple Silicon Macs, and `/usr/local/bin/espanso` otherwise)"
+    }
+  ],
   "commands": [
     {
       "name": "index",
@@ -52,25 +62,25 @@
     }
   ],
   "dependencies": {
-    "@raycast/api": "^1.61.1",
-    "@raycast/utils": "^1.10.0",
+    "@raycast/api": "^1.80.0",
+    "@raycast/utils": "^1.16.3",
     "change-case": "5.4.4",
-    "fs-extra": "^11.1.1",
-    "zx": "7.2.3"
+    "yaml": "^2.5.0"
   },
   "devDependencies": {
     "@raycast/eslint-config": "1.0.8",
-    "@types/node": "20.8.10",
-    "@types/react": "18.2.34",
+    "@types/node": "^20.14.12",
+    "@types/react": "^18.3.3",
     "eslint": "^8.53.0",
-    "prettier": "^3.0.3",
-    "typescript": "^5.2.2"
+    "prettier": "^3.3.3",
+    "typescript": "^5.5.4"
   },
   "scripts": {
     "build": "ray build -e dist",
     "dev": "ray develop",
     "fix-lint": "ray lint --fix",
     "lint": "ray lint",
+    "prepublishOnly": "echo \"\\n\\nIt seems like you are trying to publish the Raycast extension to npm.\\n\\nIf you did intend to publish it to npm, remove the \\`prepublishOnly\\` script and rerun \\`npm publish\\` again.\\nIf you wanted to publish it to the Raycast Store instead, use \\`npm run publish\\` instead.\\n\\n\" && exit 1",
     "publish": "npx @raycast/api@latest publish"
   }
 }

extensions/espanso/src/content/messages.ts

@@ -24,8 +24,6 @@ It seems like the Espanso command-line tool is not currently installed on your s
 
 Please follow these steps to install Espanso:
 
-For MacOS:
-
 1. Open Terminal.
 
 2. Install Homebrew by pasting the following command and pressing Enter:
@@ -38,18 +36,7 @@ brew install espanso
 \`\`\`
 4. Verify the installation by typing \`espanso\` in the terminal. If the installation was successful, you'll see information about how to use Espanso.
 
-For Windows:
-1. Download the latest Espanso installer from the official website: https://espanso.org/install/
-2. Run the installer and follow the on-screen instructions.
-3. Verify the installation by opening PowerShell and typing \`espanso\`. If the installation was successful, you'll see information about how to use Espanso.
-
-For Linux:
-1. Open Terminal.
-2. Depending on your distribution, use the appropriate command to install Espanso. For example, on Debian-based distributions (like Ubuntu), you'd use:
-\`\`\`
-sudo apt install espanso
-\`\`\`
-3. Verify the installation by typing \`espanso\` in the terminal. If the installation was successful, you'll see information about how to use Espanso.
+If there are still issues with the installation, try adding the output of \`which espanso\` to the \`Espanso CLI Path\` extension preference.
 
 Remember to restart your computer after the installation process. If you need more detailed instructions, please refer to the official Espanso installation guide at https://espanso.org/install/.
 `;

extensions/espanso/src/disable.ts

@@ -1,10 +1,10 @@
 import { showHUD } from "@raycast/api";
-import { $ } from "zx";
+import { espansoCli } from "./lib/espanso";
 
 export default async function main() {
   try {
-    await $`espanso cmd disable`;
-    await showHUD("Espanso disable");
+    await espansoCli("cmd disable");
+    await showHUD("Espanso disabled");
   } catch (error) {
     await showHUD(`Error: ${error}`);
   }

extensions/espanso/src/enable.ts

@@ -1,9 +1,9 @@
 import { showHUD } from "@raycast/api";
-import { $ } from "zx";
+import { espansoCli } from "./lib/espanso";
 
 export default async function main() {
   try {
-    await $`espanso cmd enable`;
+    await espansoCli("cmd enable");
     await showHUD("Espanso enabled");
   } catch (error) {
     await showHUD(`Error: ${error}`);

extensions/espanso/src/index.tsx

@@ -1,6 +1,5 @@
 import { Application, Detail, List, getFrontmostApplication } from "@raycast/api";
 import { useEffect, useState } from "react";
-import { ProcessOutput } from "zx";
 import { capitalCase, kebabCase } from "change-case";
 
 import { commandNotFoundMd, noContentMd } from "./content/messages";
@@ -17,7 +16,7 @@ export default function Command() {
   const [filteredItems, setFilteredItems] = useState<FormattedMatch[]>([]);
   const [categories, setCategories] = useState<string[]>([]);
   const [selectedCategory, setSelectedCategory] = useState<string>("all");
-  const [error, setError] = useState<ProcessOutput | null>(null);
+  const [error, setError] = useState<string | null>(null);
   const [application, setApplication] = useState<Application | undefined>(undefined);
 
   useEffect(() => {
@@ -75,8 +74,9 @@ export default function Command() {
         setFilteredItems(formattedMatches);
         setCategories(["all", ...sortedCategories]);
         setIsLoading(false);
-      } catch (err) {
-        setError(err instanceof ProcessOutput ? err : null);
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      } catch (err: any) {
+        setError("message" in err ? (err.message as string) : null);
         setIsLoading(false);
       }
     };
@@ -89,8 +89,8 @@ export default function Command() {
   }, [selectedCategory, items]);
 
   if (error) {
-    const notFound = /command not found/.test(error.stderr);
-    return <Detail markdown={notFound ? commandNotFoundMd : error.stderr} />;
+    const notFound = /No such file or directory/.test(error);
+    return <Detail markdown={notFound ? commandNotFoundMd : error} />;
   }
 
   if (!isLoading && items.length === 0) {

extensions/espanso/src/lib/espanso.ts

@@ -0,0 +1,29 @@
+import { getPreferenceValues } from "@raycast/api";
+import { arch } from "os";
+import { exec } from "child_process";
+
+function execAsync(command: string): Promise<{ stdout: string; stderr: string }> {
+  return new Promise((resolve, reject) => {
+    exec(command, (error, stdout, stderr) => {
+      if (error) {
+        reject(error);
+        return;
+      }
+      resolve({ stdout, stderr });
+    });
+  });
+}
+
+export async function espansoCli(args: string) {
+  const preferences = getPreferenceValues<Preferences>();
+
+  const espansoPath: string = preferences.espansoPath?.length
+    ? preferences.espansoPath
+    : arch() === "arm64"
+      ? "/opt/homebrew/bin/espanso"
+      : "/usr/local/bin/espanso";
+
+  const res = await execAsync(`${espansoPath} ${args}`);
+
+  return res;
+}

extensions/espanso/src/lib/utils.ts

@@ -1,20 +1,19 @@
-import fse from "fs-extra";
+import fs from "node:fs";
 import path from "path";
-import { $ } from "zx";
 import { EspansoMatch, MultiTrigger, Label, Replacement, NormalizedEspansoMatch, EspansoConfig } from "./types";
 import YAML from "yaml";
-$.verbose = false;
+import { espansoCli } from "./espanso";
 
 function lastUpdatedDate(file: string) {
-  const { mtime } = fse.statSync(file);
+  const { mtime } = fs.statSync(file);
 
   return mtime.getTime();
 }
 
 export function getAndSortTargetFiles(espansoMatchDir: string): { file: string; mtime: number }[] {
-  const targetFiles = fse
+  const targetFiles = fs
     .readdirSync(espansoMatchDir, { withFileTypes: true })
-    .filter((dirent: fse.Dirent) => dirent.isFile() && path.extname(dirent.name).toLowerCase() === ".yml");
+    .filter((dirent: fs.Dirent) => dirent.isFile() && path.extname(dirent.name).toLowerCase() === ".yml");
 
   const matchFilesTimes = targetFiles.map((targetFile) => {
     return { file: targetFile.name, mtime: lastUpdatedDate(path.join(espansoMatchDir, targetFile.name)) };
@@ -35,7 +34,7 @@ export function formatMatch(espansoMatch: MultiTrigger & Label & Replacement) {
 
 export function appendMatchToFile(fileContent: string, fileName: string, espansoMatchDir: string) {
   const filePath = path.join(espansoMatchDir, fileName);
-  fse.appendFileSync(filePath, fileContent);
+  fs.appendFileSync(filePath, fileContent);
 
   return { fileName, filePath };
 }
@@ -44,15 +43,15 @@ export function getMatches(espansoMatchDir: string, options?: { packagePath: boo
   const finalMatches: NormalizedEspansoMatch[] = [];
 
   function readDirectory(dir: string) {
-    const items = fse.readdirSync(dir, { withFileTypes: true });
+    const items = fs.readdirSync(dir, { withFileTypes: true });
 
     for (const item of items) {
       const fullPath = path.join(dir, item.name);
 
       if (item.isDirectory()) {
         if (options?.packagePath) {
           const packageFilePath = path.join(fullPath, "package.yml");
-          if (fse.existsSync(packageFilePath) && fse.statSync(packageFilePath).isFile()) {
+          if (fs.existsSync(packageFilePath) && fs.statSync(packageFilePath).isFile()) {
             processFile(packageFilePath);
           }
         } else {
@@ -65,7 +64,7 @@ export function getMatches(espansoMatchDir: string, options?: { packagePath: boo
   }
 
   function processFile(filePath: string) {
-    const content = fse.readFileSync(filePath);
+    const content = fs.readFileSync(filePath);
     const { matches = [] }: { matches?: EspansoMatch[] } = YAML.parse(content.toString()) || {};
 
     finalMatches.push(
@@ -99,7 +98,7 @@ export async function getEspansoConfig(): Promise<EspansoConfig> {
     match: "",
   };
 
-  const { stdout: configString } = await $`espanso path`;
+  const { stdout: configString } = await espansoCli("path");
 
   configString.split("\n").forEach((item) => {
     const [key, value] = item.split(":");

extensions/espanso/src/toggle.ts

@@ -1,9 +1,9 @@
 import { showHUD } from "@raycast/api";
-import { $ } from "zx";
+import { espansoCli } from "./lib/espanso";
 
 export default async function main() {
   try {
-    await $`espanso cmd toggle`;
+    await espansoCli("cmd toggle");
     await showHUD("Espanso toggled");
   } catch (error) {
     await showHUD(`Error: ${error}`);

extensions/espanso/tsconfig.json

@@ -1,16 +1,10 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
-  "display": "Node 16",
-  "include": [
-    "src/**/*",
-    "raycast-env.d.ts"
-  ],
+  "include": ["src/**/*", "raycast-env.d.ts"],
   "compilerOptions": {
-    "lib": [
-      "es2021"
-    ],
+    "lib": ["ES2023"],
     "module": "commonjs",
-    "target": "es2021",
+    "target": "ES2022",
     "strict": true,
     "isolatedModules": true,
     "esModuleInterop": true,
@@ -19,4 +13,4 @@
     "jsx": "react-jsx",
     "resolveJsonModule": true
   }
-}
+}