finder-vim-spotlight-addon.yaml

# yaml-language-server: $schema=../schema/karabiner-mod-schema.json
title: "Finder Vim Controls – Spotlight Addon"
homepage: https://github.com/chrisgrieser/finder-vim-mode
maintainers: [pseudometa (chrisgrieser)]
anchors:
  - conditions:
      - &finder-app
        type: frontmost_application_if
        bundle_identifiers: [^com\.apple\.finder$]
      - &is-spotlight-mode
        type: variable_if
        name: FINDER_SPOTLIGHT_MODE
        value: true
      - &not-spotlight-mode
        type: variable_unless
        name: FINDER_SPOTLIGHT_MODE
        value: true
  - to:
      - &enter-insert-mode
        set_variable:
          name: FINDER_INSERT_MODE
          value: true
      - &leave-insert-mode
        set_variable:
          name: FINDER_INSERT_MODE
          value: false
      - &remove-insert-notice
        set_notification_message:
          id: insert-notice
          text: ""
      - &leave-find-mode
        set_variable:
          name: FINDER_FIND_MODE
          value: false
      - &remove-find-notice
        set_notification_message:
          id: find-notice
          text: ""
      - &end-menu
        set_variable:
          name: FINDER_MENU_ACTIVE
          value: false
      - &remove-menu-notice
        set_notification_message:
          id: menu-notice
          text: ""
      - &enter-spotlight-mode
        set_variable:
          name: FINDER_SPOTLIGHT_MODE
          value: true
      - &leave-spotlight-mode
        set_variable:
          name: FINDER_SPOTLIGHT_MODE
          value: false
      - &remove-spotlight-notice
        set_notification_message:
          id: spotlight-notice
          text: ""
      - &spotlight-notice
        set_notification_message:
          id: spotlight-notice
          text: "🔦 Spotlight Mode"

      #─────────────────────────────────────────────────────────────────────────
      # Opening Alfred/Raycast/Spotlight cancels renaming and context menu,
      # so the respective modes have to be aborter here as well
rules:
  - description: "Finder Vim Controls – Spotlight Addon"
    manipulators:
      - type: basic
        from: { key_code: spacebar, modifiers: { mandatory: [command] } }
        to:
          - { key_code: spacebar, modifiers: [command] }
          - *remove-insert-notice
          - *leave-insert-mode
          - *remove-menu-notice
          - *end-menu
          - *spotlight-notice
          - *leave-find-mode
          - *remove-find-notice
          - *enter-spotlight-mode # enter spotlight
          - *enter-insert-mode
        conditions: [*finder-app, *not-spotlight-mode]
      # leave spotlight mode
      - type: basic
        from: { key_code: spacebar, modifiers: { mandatory: [command] } }
        to:
          - { key_code: spacebar, modifiers: [command] }
          - *remove-spotlight-notice
          - *leave-spotlight-mode
          - *leave-insert-mode
        conditions: [*is-spotlight-mode]
      - type: basic
        from: { key_code: escape }
        to:
          - { key_code: escape }
          - *remove-spotlight-notice
          - *leave-spotlight-mode
          - *leave-insert-mode
        conditions: [*is-spotlight-mode]
      - type: basic
        from: { key_code: caps_lock }
        to:
          - { key_code: escape }
          - *remove-spotlight-notice
          - *leave-spotlight-mode
          - *leave-insert-mode
        conditions: [*is-spotlight-mode]
      - type: basic
        from: { key_code: return_or_enter, modifiers: { optional: [command] } }
        to:
          - { key_code: return_or_enter }
          - *remove-spotlight-notice
          - *leave-spotlight-mode
          - *leave-insert-mode
        conditions: [*is-spotlight-mode]