feat(espanso): support custom path #13977

erics118 · 2024-08-12T03:43:18Z

Description

Add a preference option to support custom location to espanso CLI.

Screencast

Checklist

I read the extension guidelines
I read the documentation about publishing
I ran npm run build and tested this distribution build in Raycast
I checked that files in the assets folder are used by the extension itself
I checked that assets used by the README are placed outside of the metadata folder

raycastbot · 2024-08-12T03:43:41Z

Thank you for your contribution! 🎉

🔔 @kud @nbbaier you might want to have a look.

You can use this guide to learn how to check out the Pull Request locally in order to test it.

You can expect an initial review within five business days.

jfkisafk

LGTM, just some minor suggestions

extensions/espanso/package.json

extensions/espanso/CHANGELOG.md

Co-authored-by: stelo <[email protected]>

kud · 2024-08-13T12:13:10Z

Hey folks, I appreciate the help done here. Though, I'm not sure about that.

espanso is a shortcut here and must be in your $PATH. It does not matter if you use an Intel machine or an Apple Silicon one. I'm not sure it's the responsibility of Raycast or this extension to understand where the command exists.

I will look into this PR deeper soon.

erics118 · 2024-08-13T20:01:42Z

This is supposed to fix #13398. The problem there seems to be that for some reason, espanso isn't in the PATH that Raycast has access to. This PR fixes it by instead just using hardcoded defaults

kud · 2024-08-14T13:58:56Z

I will read the code again, to see if it's an optional field, because I don't want that all users have to mention the path of espanso when it already works. If it's a custom field where people can override it, that's alright tho.

kud · 2024-08-20T11:38:56Z

Will try to check this asap.

pernielsentikaer · 2024-08-20T13:25:22Z

Let me know your findings @kud, thanks for checking

kud · 2024-08-23T14:23:37Z

extensions/espanso/package.json

  },
  "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",


❓Does it come from a new version of Raycast?

This is from a newer version of the template that I copied over

kud · 2024-08-23T15:37:18Z

extensions/espanso/src/disable.ts


 export default async function main() {
  try {
-    await $`espanso cmd disable`;
-    await showHUD("Espanso disable");
+    await espanso("cmd disable");


🔧 I think I would like more a helper on espanso like

await $`${espansoCmd} cmd disable`

I was thinking that using a function makes it less likely to have issues with typos, ie missing a space between } and cmd. I also did remove the dependency on zx and instead use the native exec.

The current way allows for only needing to import one function, rather than the path string and a function to execute the command.

I disagree with the typo issue, tho, I'm happy to remove the zx dependency here to make it lighter. Tho, not sure I won't take it back if I need it.

Could you tho change the name of the function like espansoShell or espansoCli , something like that?

extensions/espanso/src/lib/espanso.ts

pernielsentikaer · 2024-08-26T04:18:35Z

@erics118 could you see the comments from @kud

erics118 · 2024-08-26T13:38:07Z

Oops, forgot to push the commit I made three days ago. I've replied to the comments.

pernielsentikaer · 2024-08-26T13:45:25Z

Ah, so everything should be resolved 🙂

@kud can you check again 🙂

extensions/espanso/src/lib/espanso.ts

kud · 2024-08-27T10:25:30Z

extensions/espanso/src/disable.ts


 export default async function main() {
  try {
-    await $`espanso cmd disable`;
-    await showHUD("Espanso disable");
+    await espanso("cmd disable");


I disagree with the typo issue, tho, I'm happy to remove the zx dependency here to make it lighter. Tho, not sure I won't take it back if I need it.

kud · 2024-08-27T10:26:06Z

extensions/espanso/src/disable.ts


 export default async function main() {
  try {
-    await $`espanso cmd disable`;
-    await showHUD("Espanso disable");
+    await espanso("cmd disable");


Could you tho change the name of the function like espansoShell or espansoCli , something like that?

kud · 2024-09-02T16:19:26Z

@erics118 Please check those comments 🙏

erics118 · 2024-09-03T13:40:37Z

I've renamed espanso to espansoCli

kud · 2024-09-05T09:54:46Z

extensions/espanso/src/lib/espanso.ts

+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 });
+    });
+  });
+}


Something like

import { exec } from "child_process"; import { promisify } from "util"; const execAsync = promisify(exec);

could be probably better.

kud · 2024-09-05T09:56:42Z

extensions/espanso/src/lib/espanso.ts

+      ? "/opt/homebrew/bin/espanso"
+      : "/usr/local/bin/espanso";


I wonder if we could test first if it exists because not everyone installs it via homebrew.

Wonder if we could check first if the shortcut command espanso exists and once it does not exist, test first the preference and then the homebrew version.

pernielsentikaer · 2024-09-05T12:33:42Z

Could you check again @kud 🙂

kud · 2024-09-06T11:57:41Z

The last two comments have not been resolved or discuted. @pernielsentikaer @erics118

erics118 · 2024-09-06T11:59:25Z

Sorry, I was working on it and had mistakenly resolved them before actually committing the code. I'll update later today

pernielsentikaer · 2024-09-10T05:20:59Z

Let me know if I can help you with anything

kud · 2024-09-10T10:18:32Z

@pernielsentikaer For now, there is only one user who has an issue, and it's not even certain there's a way to fix it, but it's worth trying. If it takes too much time to resolve, I will fix my own suggestions. Thanks for asking!

raycastbot · 2024-09-24T10:42:24Z

This pull request has been automatically marked as stale because it did not have any recent activity.

It will be closed if no further activity occurs in the next 7 days to keep our backlog clean 😊

pernielsentikaer · 2024-09-25T06:27:23Z

So we should just merge this one?

kud · 2024-09-25T13:01:51Z

@pernielsentikaer To be honest, I'm kind of against this PR because of a responsibility concern where this issue should be fixed by the user in their shell. I'm happy to accept it if it can help some users (how many?) to fix the issue by specifying the path of the Espanso CLI, but here we override the path of Espanso by default, which is not great because all the people who installed the app without Homebrew could have an issue now. So yeah, I'm not in the rush to merge it 😬

kud · 2024-09-25T13:03:40Z

My question is why do we need to force it in the code? Is there a way that we could help users to fix their shell issue?

I know raycast uses its own shell or at least not the logged one. I'm happy to add a documentation to fix this path issue in the README.

pernielsentikaer · 2024-09-30T11:55:15Z

Did you resolve your question with the command from George on Slack

kud · 2024-10-01T13:28:13Z

@pernielsentikaer I think I've got an idea yeah. Lemme work on that PR. 😌

pernielsentikaer · 2025-03-11T11:03:10Z

Can we close this one?

kud · 2025-03-11T12:30:53Z

Lemme double check.

@acicovic Do you still have the issue?

acicovic · 2025-03-11T16:51:11Z

I can confirm that I still have the issue. To work around this, I'm using Espanso's search bar outside of Raycast.

erics118 added 4 commits August 11, 2024 23:42

chore: add changelog

e82d954

feat: fix path err

b0b5033

chore: update deps

fce919d

chore: cleanup

d9a376c

raycastbot added extension fix / improvement Label for PRs with extension's fix improvements extension: espanso Issues related to the espanso extension labels Aug 12, 2024

erics118 mentioned this pull request Aug 12, 2024

[Espanso] Espanso Command Not Found #13398

Closed

chore: update changelog

b0f7569

jfkisafk approved these changes Aug 12, 2024

View reviewed changes

extensions/espanso/package.json Show resolved Hide resolved

extensions/espanso/CHANGELOG.md Outdated Show resolved Hide resolved

Update extensions/espanso/CHANGELOG.md

b9b824a

Co-authored-by: stelo <[email protected]>

pernielsentikaer added the status: awaiting response from dev label Aug 20, 2024

pernielsentikaer self-assigned this Aug 20, 2024

kud suggested changes Aug 23, 2024

View reviewed changes

fix: use arch() instead of os() to get apple silicon/intel

ede3227

kud suggested changes Aug 27, 2024

View reviewed changes

rename espanso func to espansoCli

a91bdae

kud suggested changes Sep 5, 2024

View reviewed changes

raycastbot added the status: stalled Stalled due inactivity label Sep 24, 2024

raycastbot removed the status: stalled Stalled due inactivity label Sep 25, 2024

pernielsentikaer added the Dont close Won't be closed by stalebot label Oct 2, 2024

pernielsentikaer removed the Dont close Won't be closed by stalebot label Mar 11, 2025

feat(espanso): support custom path #13977

Are you sure you want to change the base?

feat(espanso): support custom path #13977

Conversation

erics118 commented Aug 12, 2024

Description

Screencast

Checklist

raycastbot commented Aug 12, 2024 • edited Loading

jfkisafk left a comment • edited Loading

Choose a reason for hiding this comment

kud commented Aug 13, 2024

erics118 commented Aug 13, 2024

kud commented Aug 14, 2024

kud commented Aug 20, 2024

pernielsentikaer commented Aug 20, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pernielsentikaer commented Aug 26, 2024

erics118 commented Aug 26, 2024

pernielsentikaer commented Aug 26, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kud commented Sep 2, 2024

erics118 commented Sep 3, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pernielsentikaer commented Sep 5, 2024

kud commented Sep 6, 2024

erics118 commented Sep 6, 2024

pernielsentikaer commented Sep 10, 2024

kud commented Sep 10, 2024

raycastbot commented Sep 24, 2024

pernielsentikaer commented Sep 25, 2024

kud commented Sep 25, 2024

kud commented Sep 25, 2024

pernielsentikaer commented Sep 30, 2024

kud commented Oct 1, 2024

pernielsentikaer commented Mar 11, 2025

kud commented Mar 11, 2025

acicovic commented Mar 11, 2025

raycastbot commented Aug 12, 2024 •

edited

Loading

jfkisafk left a comment •

edited

Loading