Espanso: Fix broken module to be compatible with Espanso version 2.x #4066

liyangau · 2023-06-07T15:22:03Z

Description

Espanso module does not work with 2.x version. In the new version configuration and matches are put into different folders as below.

config/
  default.yml
match/
  base.yml

The updated module supports creating multiple files for both config and matches. Users have the full flexibility to create multiple files for different apps.

Checklist

Change is backwards compatible.
Code formatted with ./format.
Code tested through nix-shell --pure tests -A run.all or nix develop --ignore-environment .#all using Flakes.
Test cases updated/added. See example.
Commit messages are formatted like
```
{component}: {description}

{long description}
```
See CONTRIBUTING for more information and recent commit messages for examples.
If this PR adds a new module
- Added myself as module maintainer. See example.

This module is currently broken. It does not create `config` and `match` folders which are required by espanso 2.x version. This PR fixed this issue and support creating multiple files under `config` and `match` folder.

This module is currently broken. It does not create `config` and `match` folders which are required by espanso 2.x version. This PR fixed this issue and support creating multiple files under `config` and `match` folder. Add descriptions

ncfavier

This needs

a mkRemovedOptionModule for the removed settings option
an assertion that versionAtLeast cfg.package.version "2"

ncfavier · 2023-06-07T15:27:40Z

modules/services/espanso.nix

        type = yaml.type;
-        default = { matches = [ ]; };
+        default = { default = { }; };


Do we need a default?

I am following previous config here. I guess there is no harm to set an empty default when the users do not provide anything.

Oh, sorry, I was unclear. I meant: do we need a default that's not just {}? I.e., why the default inside the default?

I use default = { }; inside default is to create an empty ~/.config/espanso/config/default.yml when it is not set.

Without it, Espanso will throw below error.

[ERROR] unable to load config Caused by: missing config directory

ncfavier · 2023-06-07T15:28:00Z

modules/services/espanso.nix

+
+      matches = mkOption {
+        type = yaml.type;
+        default = { default.matches = [ ]; };


same as above

modules/services/espanso.nix

nixos-discourse · 2023-06-07T15:34:25Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/how-to-override-service-espanso-module-for-home-manager/28551/11

bobvanderlinden

Haven't tried to run this, but code looks good overal 👍 small suggestion.

modules/services/espanso.nix

liyangau · 2023-06-08T15:23:47Z

Looks like pkgs.espanso does not passthru.test version. Shall I remove the checks of versionAtLeast espansoVersion "2"; to move this forward or is there any other methods we can check this?

ncfavier · 2023-06-08T16:11:54Z

The stubs don't have versions by default. I'm working on it.

ncfavier · 2023-06-08T22:59:35Z

Should be fixed now if you rebase on master.

modules/services/espanso.nix

Co-authored-by: Naïm Favier <n@monade.li>

modules/services/espanso.nix

…ix-community#4066) * Fix espanso module to work with 2.x version * espanso: fix espanso module This module is currently broken. It does not create `config` and `match` folders which are required by espanso 2.x version. This PR fixed this issue and support creating multiple files under `config` and `match` folder. * Espanso: fix espanso module This module is currently broken. It does not create `config` and `match` folders which are required by espanso 2.x version. This PR fixed this issue and support creating multiple files under `config` and `match` folder. Add descriptions * Add versionAtLeast and mkRemovedOptionModule * Correct maintainers list * remove config key from example * format basic-configuration.nix * Update modules/services/espanso.nix Co-authored-by: Naïm Favier <n@monade.li> * fix maintainers list --------- Co-authored-by: Naïm Favier <n@monade.li> (cherry picked from commit 1e5d741)

* tests: `--show-trace` in CI (#4070) (cherry picked from commit f889ec0) * tests/stubs: inherit default versions from pkgs (#4069) * tests/stubs: inherit default versions from pkgs * tests/browserpass: temporarily disable on darwin The package currently fails to evaluate on darwin due to a nixpkgs problem: NixOS/nixpkgs#236258 (comment) (cherry picked from commit 69bdd6d) * Espanso: Fix broken module to be compatible with Espanso version 2.x (#4066) * Fix espanso module to work with 2.x version * espanso: fix espanso module This module is currently broken. It does not create `config` and `match` folders which are required by espanso 2.x version. This PR fixed this issue and support creating multiple files under `config` and `match` folder. * Espanso: fix espanso module This module is currently broken. It does not create `config` and `match` folders which are required by espanso 2.x version. This PR fixed this issue and support creating multiple files under `config` and `match` folder. Add descriptions * Add versionAtLeast and mkRemovedOptionModule * Correct maintainers list * remove config key from example * format basic-configuration.nix * Update modules/services/espanso.nix Co-authored-by: Naïm Favier <n@monade.li> * fix maintainers list --------- Co-authored-by: Naïm Favier <n@monade.li> (cherry picked from commit 1e5d741) --------- Co-authored-by: Li Yang <71299093+liyangau@users.noreply.github.com>

liyangau added 3 commits June 7, 2023 23:51

Fix espanso module to work with 2.x version

fda5bc0

espanso: fix espanso module

eecfe8e

This module is currently broken. It does not create `config` and `match` folders which are required by espanso 2.x version. This PR fixed this issue and support creating multiple files under `config` and `match` folder.

Espanso: fix espanso module

aa5af50

This module is currently broken. It does not create `config` and `match` folders which are required by espanso 2.x version. This PR fixed this issue and support creating multiple files under `config` and `match` folder. Add descriptions

ncfavier requested changes Jun 7, 2023

View reviewed changes

Add versionAtLeast and mkRemovedOptionModule

b734ea5

bobvanderlinden reviewed Jun 8, 2023

View reviewed changes

modules/services/espanso.nix Outdated Show resolved Hide resolved

liyangau added 2 commits June 8, 2023 19:17

Correct maintainers list

b5bc32e

remove config key from example

367b5ef

ncfavier approved these changes Jun 8, 2023

View reviewed changes

format basic-configuration.nix

823481b

Merge branch 'nix-community:master' into master

56a0d19

ncfavier reviewed Jun 9, 2023

View reviewed changes

modules/services/espanso.nix Outdated Show resolved Hide resolved

modules/services/espanso.nix Outdated Show resolved Hide resolved

liyangau and others added 2 commits June 9, 2023 19:30

Update modules/services/espanso.nix

785c02d

Co-authored-by: Naïm Favier <n@monade.li>

fix maintainers list

2a448e9

ncfavier reviewed Jun 9, 2023

View reviewed changes

modules/services/espanso.nix Show resolved Hide resolved

ncfavier linked an issue Jun 9, 2023 that may be closed by this pull request

bug: espanso >=2 (now in nixpkgs) requires config update #4052

Closed

2 tasks

ncfavier mentioned this pull request Jun 9, 2023

bug: espanso >=2 (now in nixpkgs) requires config update #4052

Closed

2 tasks

ncfavier approved these changes Jun 9, 2023

View reviewed changes

ncfavier merged commit 1e5d741 into nix-community:master Jun 9, 2023
3 checks passed

ncfavier mentioned this pull request Jun 12, 2023

[23.05] backport #4066 #4083

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Espanso: Fix broken module to be compatible with Espanso version 2.x #4066

Espanso: Fix broken module to be compatible with Espanso version 2.x #4066

liyangau commented Jun 7, 2023 •

edited

ncfavier left a comment

ncfavier Jun 7, 2023

liyangau Jun 8, 2023

ncfavier Jun 8, 2023

liyangau Jun 8, 2023 •

edited

ncfavier Jun 7, 2023

liyangau Jun 8, 2023

nixos-discourse commented Jun 7, 2023

bobvanderlinden left a comment

liyangau commented Jun 8, 2023 •

edited

ncfavier commented Jun 8, 2023

ncfavier commented Jun 8, 2023

Espanso: Fix broken module to be compatible with Espanso version 2.x #4066

Espanso: Fix broken module to be compatible with Espanso version 2.x #4066

Conversation

liyangau commented Jun 7, 2023 • edited

Description

Checklist

ncfavier left a comment

Choose a reason for hiding this comment

ncfavier Jun 7, 2023

Choose a reason for hiding this comment

liyangau Jun 8, 2023

Choose a reason for hiding this comment

ncfavier Jun 8, 2023

Choose a reason for hiding this comment

liyangau Jun 8, 2023 • edited

Choose a reason for hiding this comment

ncfavier Jun 7, 2023

Choose a reason for hiding this comment

liyangau Jun 8, 2023

Choose a reason for hiding this comment

nixos-discourse commented Jun 7, 2023

bobvanderlinden left a comment

Choose a reason for hiding this comment

liyangau commented Jun 8, 2023 • edited

ncfavier commented Jun 8, 2023

ncfavier commented Jun 8, 2023

liyangau commented Jun 7, 2023 •

edited

liyangau Jun 8, 2023 •

edited

liyangau commented Jun 8, 2023 •

edited