[WIP] Offer some features à la carte

[jasonrudolph]

Historically, if you wanted to use only a subset of this repository's functionality, you've had to edit the code to apply your customizations (e.g., removing the require statements for features you don't want). This PR explores one option for providing a more à la carte offering.

It's just an exploration for now. It's too soon to say whether this will be something that's worth merging. 🔮

Approach

The recent 0.9.53 release of Hammerspoon introduced an official mechanism for distributing custom Hammerspoon-based plugins known as Spoons. From the Hammerspoon docs:

Spoons are intended to be pure-Lua plugins for users to use in their Hammerspoon configs. As a community, we have created many great configurations for Hammerspoon, but sharing code between them is hard and fragile. Spoons have been created as a way to address these issues. Users should be able to download a Spoon and quickly integrate it into their config without worrying about what it is doing internally.

If I can extract some of this repository's features into standalone Spoons, and if doing so makes it easier for people to choose the custom subset of features they want, and if it doesn't significantly increase maintenance overhead, then I'd love to make it happen. 🤞

Proof-of-concept

As a starting point, I've extracted a Spoon to provide the functionality that allows you to tap caps lock for escape and hold caps lock for control. Instead of housing that functionality directly in this repository, that functionality is available à la carte as a Spoon (https://github.com/jasonrudolph/ControlEscape.spoon), and this branch includes that Spoon as a submodule. For people that only want that one feature, they have access to it via that standalone Spoon. For people that want all of this repository's features, this branch continues to provide all of the original functionality.

TODO

• Extract features into standalone Spoons:
  • Access control and escape on the home row
  • (S)uper (D)uper Mode
  • Window Layout Mode
  • Markdown Mode
  • Hyper key for quickly launching apps
  • Push-to-talk/push-to-mute hotkey
• Update script/setup to symlink all of this repository's Spoons into ~./hammerspoon/Spoons/
• Update README (if needed)
• Release new version with upgrade instructions

[adamyonk]

I think this is a great idea! Set up an early version of Pust-to-talk here: https://github.com/adamyonk/PushToTalk.spoon

[jasonrudolph]

Closing this out for now. I may revisit it at some point in the future.