admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Mike McQuaid aeaeccc3b1
formula: add .keepme files to prevent cleanup 
Allow the use of `.keepme` files inside a keg to prevent the cleanup.

Rather than having a binary state of "never cleanup if `.keepme` is
present" and "can cleanup without", instead a `.keepme` file is
essentially providing reference counting.

It can contain one or more lines which reference files on disk. If the
file exists, the `.keepme` file will prevent cleanup. If/when it does
not: `brew cleanup` will happily cleanup this keg (providing all other
conditions apply).
2025-01-23 14:29:48 +00:00
..
.bundle
…
api
Bump more files to Sorbet typed: strict
2025-01-11 00:11:27 +00:00
cask
sudo: Elevate priviliges before adding metadata after relocating a cask, if necessary
2025-01-20 14:35:36 -08:00
cli
Fix use of tap
2024-12-08 10:28:10 -08:00
cmake
…
cmd
Merge pull request #19084 from Homebrew/add-comments-to-rubocop-disables
2025-01-13 11:32:31 +00:00
completions
feat: Add Bash completion for Homebrew aliases
2024-12-03 23:48:50 -05:00
data
spdx: update license data.
2024-12-31 00:15:10 +00:00
debrew
…
dev-cmd
Fix type errors
2025-01-22 01:45:19 +05:30
extend
Merge pull request #19111 from Homebrew/aarch64-linux
2025-01-19 14:48:42 +00:00
language
language/python: link manpages by default
2024-11-05 11:24:13 -05:00
livecheck
livecheck: remove URL and Strategy info in some cases
2025-01-07 10:27:58 +05:30
manpages
…
os
feat: add linux tests
2025-01-19 12:32:55 +01:00
requirements
…
rubocops
Bump more RuboCops to Sorbet typed: strict
2025-01-06 00:09:53 +00:00
shims
Add support for bottling Portable Ruby for ARM64 Linux
2025-01-19 17:06:32 +08:00
sorbet
Update RBI files for sorbet.
2025-01-22 22:45:59 +00:00
standalone
Enforce finalized sorbet methods
2024-11-21 18:34:11 -08:00
startup
Add support for Homebrew wrappers
2025-01-07 17:40:18 +00:00
test
Mirror real installation directory structure for tests
2025-01-23 03:11:59 -05:00
unpack_strategy
unpack_strategy/directory: use mv for nested unpack
2024-10-20 11:29:30 -04:00
utils
Only need a single, more readable, print_stderr
2025-01-22 22:03:28 +00:00
vendor
brew vendor-gems: commit updates.
2025-01-22 22:45:48 +00:00
version
…
yard
…
.rspec_parallel
…
.rubocop.yml
…
.ruby-version
Portable Ruby 3.3.7
2025-01-16 15:12:03 -08:00
.simplecov
…
.yardopts
…
abstract_command.rb
…
api.rb
Add HOMEBREW_FORCE_API_AUTO_UPDATE
2025-01-07 16:27:44 +00:00
ast_constants.rb
ast_constants: order deprecate! before disable!
2024-12-20 14:45:15 -05:00
attestation.rb
document the version that causes problems here
2024-12-05 14:16:30 -05:00
attrable.rb
Migrate Parlour extensions to Tapioca compilers
2024-10-14 19:50:09 -07:00
brew_irbrc
…
brew.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
brew.sh
Fix HOMEBREW_*BREW_WRAPPER behaviour
2025-01-08 14:10:55 +00:00
build_environment.rb
build_environment: pass http_proxy env vars through to build env
2025-01-13 19:35:31 +00:00
build_options.rb
…
build.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
bump_version_parser.rb
bump: skip PR checking when up to date
2024-11-24 20:50:37 -05:00
bundle_version.rb
Bump more files to Sorbet typed: strict
2025-01-11 00:11:27 +00:00
cache_store.rb
…
cask_dependent.rb
Bump more files to Sorbet typed: strict
2025-01-11 00:11:27 +00:00
cask.rb
…
caveats.rb
…
checksum.rb
…
cleaner.rb
…
cleanup.rb
Apply suggestions from code review
2024-11-05 16:44:12 +00:00
command_path.sh
…
commands.rb
…
compilers.rb
…
completions.rb
Remove fish command completions for excluded commands
2024-11-20 17:35:42 -06:00
context.rb
…
cxxstdlib.rb
…
debrew.rb
…
dependable.rb
…
dependencies_helpers.rb
deps command: add --include-implicit flag
2024-12-24 15:28:47 -05:00
dependencies.rb
…
dependencies.rbi
…
dependency_collector.rb
…
dependency.rb
Migrate Parlour extensions to Tapioca compilers
2024-10-14 19:50:09 -07:00
deprecate_disable.rb
deprecate_disable: typed: strict
2024-12-20 13:33:16 -05:00
description_cache_store.rb
…
descriptions.rb
brew style --fix
2024-11-26 14:09:13 -08:00
development_tools.rb
…
diagnostic.rb
Update Library/Homebrew/diagnostic.rb
2025-01-19 23:19:03 +08:00
download_queue.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
download_strategy.rb
Merge pull request #18809 from reitermarkus/download-lock-interrupt
2024-11-25 08:36:58 +00:00
download_strategy.rbi
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
downloadable.rb
…
env_config.rb
Fix HOMEBREW_*BREW_WRAPPER behaviour
2025-01-08 14:10:55 +00:00
exceptions.rb
…
fetch.rb
…
formula_assertions.rb
…
formula_auditor.rb
formula_auditor: avoid pkg-config dependency in core tap
2024-12-02 21:46:51 -05:00
formula_cellar_checks.rb
…
formula_creator.rb
…
formula_free_port.rb
…
formula_info.rb
Bump more files to Sorbet typed: strict
2025-01-11 00:11:27 +00:00
formula_installer.rb
Merge pull request #19084 from Homebrew/add-comments-to-rubocop-disables
2025-01-13 11:32:31 +00:00
formula_name_cask_token_auditor.rb
…
formula_path.sh
…
formula_pin.rb
…
formula_support.rb
…
formula_versions.rb
…
formula.rb
formula: add .keepme files to prevent cleanup
2025-01-23 14:29:48 +00:00
formula.rbi
Remove OpenStruct from Uses cmd
2024-11-22 21:04:51 -08:00
formulary.rb
Curl: use typed: strict
2025-01-14 08:14:39 -05:00
formulary.rbi
…
Gemfile
Gemfile: add recursive dependencies we rely on.
2025-01-07 17:39:04 +00:00
Gemfile.lock
brew vendor-gems: commit updates.
2025-01-22 22:45:48 +00:00
git_repository.rb
…
github_packages.rb
Curl: use typed: strict
2025-01-14 08:14:39 -05:00
github_releases.rb
…
github_runner_matrix.rb
github_runner_matrix: extend timeout for dependent tests on arm64
2024-11-01 12:26:50 +08:00
github_runner.rb
…
global.rb
Add support for Homebrew wrappers
2025-01-07 17:40:18 +00:00
hardware.rb
hardware: recognize 10 cores as deca
2025-01-18 18:40:21 -05:00
help.rb
…
help.sh
…
ignorable.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
ignorable.rbi
…
install_renamed.rb
…
install.rb
Revamp installed_on_request handling
2024-11-19 08:39:55 +00:00
installed_dependents.rb
…
items.sh
…
keg_relocate.rb
keg_relocate: fix error when dylib_id doesn't need changing
2024-10-26 06:31:05 +01:00
keg.rb
Remove removable constants
2024-10-07 19:45:48 -07:00
keg.rbi
…
lazy_object.rb
…
linkage_cache_store.rb
…
linkage_checker.rb
…
linux_runner_spec.rb
…
linuxbrew-core-migration.rb
…
list.sh
…
livecheck.rb
livecheck: update #formula comment
2025-01-07 02:11:15 +05:30
locale.rb
…
lock_file.rb
Prevent race condition when deleting lock files.
2024-11-24 01:29:42 +01:00
macos_runner_spec.rb
…
macos_version.rb
macos_version: define a method instead
2024-10-31 15:15:02 +08:00
manpages.rb
Namespace some top-level constants
2024-12-11 11:04:55 -08:00
messages.rb
…
metafiles.rb
…
migrator.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
missing_formula.rb
…
mktemp.rb
Add support for Homebrew wrappers
2025-01-07 17:40:18 +00:00
official_taps.rb
…
options.rb
…
options.rbi
…
os.rb
os: use native ruby calls for uname
2024-10-31 15:35:58 +08:00
patch.rb
patch: restore output from failed patch
2024-12-19 14:56:00 -05:00
PATH.rb
…
pkg_version.rb
pkg_version: make typed: strict
2024-12-05 14:01:37 +00:00
pkg_version.rbi
…
postinstall.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
readall.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
README.md
…
reinstall.rb
Merge pull request #19084 from Homebrew/add-comments-to-rubocop-disables
2025-01-13 11:32:31 +00:00
requirement.rb
Remove :final from Requirement#satisfied? sig
2024-11-24 15:49:49 -08:00
requirements.rb
…
resource_auditor.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
resource.rb
Standardize livecheck block language formatting
2024-12-02 10:13:04 -05:00
retryable_download.rb
…
rubocops.rb
…
sandbox.rb
Add support for Homebrew wrappers
2025-01-07 17:40:18 +00:00
sbom.rb
…
search.rb
…
service.rb
Add missing utils/service require
2024-12-07 10:35:33 -08:00
service.rbi
…
settings.rb
…
shell_command.rb
…
simulate_system.rb
…
software_spec.rb
…
source_location.rb
…
standalone.rb
…
startup.rb
…
style.rb
Add support for Homebrew wrappers
2025-01-07 17:40:18 +00:00
system_command.rb
…
system_config.rb
system_config: print brew branch
2024-11-25 23:06:40 +08:00
tab.rb
Merge pull request #19087 from Homebrew/installed_on_request_true
2025-01-13 09:36:05 +00:00
tap_auditor.rb
tap_auditor: check renamed formula exists
2024-11-09 12:02:03 -05:00
tap_constants.rb
dev-cmd/bump-formula-pr: always use full git repo as tap remote
2024-10-15 10:20:58 +02:00
tap.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
tap.sh
…
test_runner_formula.rb
…
test.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
uninstall.rb
uninstall: don't ignore deps even for developers
2024-11-18 00:13:12 +08:00
unlink.rb
…
unpack_strategy.rb
unpack_strategy/directory: use mv for nested unpack
2024-10-20 11:29:30 -04:00
unversioned_cask_checker.rb
…
upgrade.rb
Fix usage of Tab#installed_(on_request|as_dependency)
2025-01-13 09:24:42 +00:00
url.rb
…
utils.rb
…
version.rb
…
warnings.rb
…

README.md

Homebrew Ruby API

This is the API for Homebrew.

The main class you should look at is the {Formula} class (and classes linked from there). That's the class that's used to create Homebrew formulae (i.e. package descriptions). Assume anything else you stumble upon is private.

You may also find the Formula Cookbook and Ruby Style Guide helpful in creating formulae.

Good luck!