Hammerspoon/hammerspoon

windowHints hotkey modal clashes with user defined modals

Open

#606 opened on Oct 14, 2015

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Objective-C (15,415 stars) (688 forks)batch import
bughelp wanted

Description

It seems like windowHints implementation is based on modal hotkeys, and it defines a global variable named "k" for the modal. That global variable was clashing with my own modal variable (also named "k") causing weird behavior. Changing my modal variable name fixed it.

I'm not experienced enough with hammerspoon or lua to fix this myself. Is it possible to use a local variable in the windowHints module? Maybe the windowHints variable should have a less common name?

I believe this is the line causing trouble.

Thanks!

Contributor guide

Tech stack
None
Domain
desktop
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Lua basicsHammerspoon setup
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine the windowHints module at extensions/hints/init.lua. The global variable 'k' on line 175 should be changed to a local variable or renamed to avoid clashes with user defined modals. Check if there are other global variables in the same module that could cause similar issues. Also verify that the change does not break any other functionality that depends on the global 'k'.