homebrew-fund
"brew fund" helps you fund the upstream development of your favorite Homebrew packages
MIT License
homebrew-fund
[!WARNING] π§ This is a WORK IN PROGRESS. It may not work. It may break your
brew. It may provide incorrect funding links. Don't trust it until 1.0.0.
Homebrew-fund provides a Homebrew command brew fund that
helps you fund the upstream development of your favorite Homebrew packages by
suggesting where the package collects donations or other financial support.
brew fund came out of Homebrew/brew#15890.
Installation
Simply tap this repository:
brew tap colindean/fund
Usage
Run brew fund for online help, but normal usage is to pass a package in particular, e.g.
brew fund curl
will show potential places to fund the development of curl.
Caveats
Homebrew-fund uses a series of heuristics to suggest possible donation methods for a package. Donation methods may change. The heuristic could be wrong.
[!IMPORTANT] You are solely responsible for validating that payments made through any facility go to the intended recipient.
Heuristics
[!WARNING] Until 1.0.0, check the code, as this list may be outdated.
In general, Homebrew-fund will always attempt to retrieve the least amount of data in order to make a reasonable guess at the right URL(s) to provide.
- π A hardcoded URL for projects that aren't Homebrew packages specifically, such as Homebrew itself.
- π If the project has a GitHub homepage or download link,
use the GitHub GraphQL API to retrieve the project's funding links,
configured inFUNDING.yamlin a few known places.
You may need to set aGITHUB_TOKENorHOMEBREW_GITHUB_API_TOKENenvironment variable to use this API. - π Download the source archive andβ¦
- π Look for files such as
FUNDING.yml,DONAT{E|IONS}{.md,.adoc,.txt}, etc. - π Look for a Donations section in a
README{.md,.adoc,.txt}
- π Look for files such as
- π Scrape the homepage for links to
- π A
/donateor/donationslink - π Well-known donations pages, such as those documented in the
FUNDING.ymlspec.
- π A
Completion indicated by moon phases:
| Icon | Meaning |
|---|---|
| π | Not started |
| π | Started |
| π | Almost there, not thoroughly tested |
| π | Working as brightly as the moon in the clear night skyβ¦ which means it sometimes might not |
| π | Feature complete and should always be working |
Contributing
Contributions are welcome. Please consider opening an issue to describe what you'd like to do before doing it. I prize code submissions, but I really have to understand them to accept them.
Getting started
This repository defines a DevContainers configuration that loads well in GitHub Codespaces and VSCode/VSCodium.
Run make deps check test with Homebrew's Ruby pre-installed, and it should be ready to go.
If you use the DevContainer, it already is.
Tests
Tests can be run with make test.
Add tests to keep coverage above 70%. Once the app is 1.0, we'll ratchet coverage up toward 100%.
Copyright
Copyright (c) 2023 Colin Dean. See LICENSE for details.
