Hammerspoon / Hammerspoon/Spoons

Alternative way of sharing spoons

Open
#255 7 comments 9 reactions 0 assignees View on GitHub
Dominant language
Lua
Stars
567
Forks
171
PR merge metrics
No merged PRs in 30d

Description

I would like to propose an alternative way of sharing spoons.

What I think is missing in the current way of sharing spoons using a mono repo https://github.com/Hammerspoon/Spoons:
- it's not user (beginner) friendly. Instead of showing **how** to use the spoons, the spoon page is giving a documentation about the internals of the spoon, like methods and variables ([example](http://www.hammerspoon.org/Spoons/MenubarFlag.html)). I believe that this way is perfect for libraries or utility functions.
- no screenshots. I guess it's not possible with lua docs to add screenshots. But most of the spoons provides some kind of visual changes, like menubar apps, window management, notifications, and screenshots would be the great addition to the description of the spoon.

What I propose:
To put each spoon in it's own repository. This gives following benefits:
- Readme in markdown: screenshots, video, code examples, etc.
- Gives visibility of which spoons are popular by being able to star a repo.
- Release management. With a simple [gh-action](https://github.com/fork-my-spoons/spotify-search-and-play.spoon/blob/main/.github/workflows/blank.yml) it's possible to setup automated releases. Gh-action generates a `.zip` with a `.spoon` inside. Each new version can be simply downloaded from the releases page of the repository.
- Updates. With github releases it's possbile to check if there is a new version of the spoon. Here is an [example function](https://github.com/fork-my-spoons/gitlab-merge-requests.spoon/blob/master/init.lua#L64).
- Maybe this will simplify life of hammerspoon maintainers? 😄 Spoons will be created by community only, so you don't need to maintain the /spoons repository anymore.

You can find some examples here:
- [/gitlab-merge-requests.spoon](https://github.com/fork-my-spoons/gitlab-merge-requests.spoon).
- [/spotify-search-and-play.spoon](https://github.com/fork-my-spoons/spotify-search-and-play.spoon).

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.