admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Sam Ford 5e57df7287
livecheck: restrict POST hashes to symbol keys 
I initially set the type for livecheck's `post_form` and `post_json`
hashes to allow either a string or symbol key. I used string keys in
the documentation, as there will inevitably be some form field names
that would pose a problem for symbols (e.g., `E-mail` uses a hyphen,
`1twothree` starts with a digit, etc.). However, I remembered that we
can simply use quote symbols like `:"E-mail"` to handle these
situations, as they have the flexibility of a string while still being
a symbol.

With that in mind, this updates related type signatures to only allow
symbol keys and updates documentation and tests accordingly. The
documentation example contains a hyphenated form field, so it
demonstrates how to handle names that don't work as a bare symbol.
2025-02-21 21:54:46 -05:00
..
.bundle
…
aliases
Import brew alias and brew unalias commands
2025-02-07 14:31:50 +00:00
api
remove all references to JSON v3
2025-02-06 21:04:08 -08:00
cask
livecheck: refactor HEAD-only formula handling
2025-02-20 22:39:18 -05:00
cli
Revert to_formulae_and_casks sig change
2025-02-16 15:41:57 -08:00
cmake
…
cmd
Merge pull request #19314 from Homebrew/typed-dep-helpers
2025-02-18 18:47:06 +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
creator: add zig option
2025-02-21 15:05:42 +01:00
extend
zig std args: apply -fno-rosetta on macs with arm
2025-02-21 19:10:41 +01:00
formula-analytics
build(deps): bump pyarrow in /Library/Homebrew/formula-analytics
2025-02-19 18:58:39 +00:00
language
language/python: link manpages by default
2024-11-05 11:24:13 -05:00
livecheck
livecheck: restrict POST hashes to symbol keys
2025-02-21 21:54:46 -05:00
manpages
docs: prefer /opt/homebrew in examples
2025-02-03 15:30:03 +01:00
os
feat: add linux tests
2025-01-19 12:32:55 +01:00
requirements
…
rubocops
rubocop/lines: prefer assert_path_exists and refute_path_exists
2025-02-18 10:52:32 -05:00
shims
Add support for bottling Portable Ruby for ARM64 Linux
2025-01-19 17:06:32 +08:00
sorbet
sorbet: Update RBI files.
2025-02-22 00:24:35 +00:00
standalone
Enforce finalized sorbet methods
2024-11-21 18:34:11 -08:00
startup
Import brew alias and brew unalias commands
2025-02-07 14:31:50 +00:00
test
livecheck: restrict POST hashes to symbol keys
2025-02-21 21:54:46 -05:00
unpack_strategy
unpack_strategy/directory: use mv for nested unpack
2024-10-20 11:29:30 -04:00
utils
Clean up OnSystem rbis
2025-02-13 16:33:59 -08:00
vendor
Merge pull request #19347 from Homebrew/dependabot/bundler/Library/Homebrew/sorbet-20eb92d5ee
2025-02-21 18:52:56 +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
remove all references to JSON v3
2025-02-06 21:04:08 -08: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
bottle_specification.rb
Split up SoftwareSpec
2025-02-04 16:27:39 +00:00
bottle.rb
Split up SoftwareSpec
2025-02-04 16:27:39 +00:00
brew_irbrc
…
brew.rb
Fix handling of case-mistyped commands
2025-01-27 08:42:49 +00:00
brew.sh
brew.sh: improve HOMEBREW_FORCE_BREW_WRAPPER error message
2025-02-07 13:23:52 +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
formula: don't include DATA patches in initial Git repo
2025-02-18 18:12:35 +08: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
brew style --fix
2024-10-02 10:03:12 -07:00
checksum.rb
…
cleaner.rb
Resolve rubocop violations
2025-02-17 18:56:31 -08:00
cleanup.rb
cleanup: improve cleanup version detection.
2025-01-23 16:04:31 +00:00
command_path.sh
…
commands.rb
…
compilers.rb
Resolve rubocop violations
2025-02-17 18:56:31 -08:00
completions.rb
Remove fish command completions for excluded commands
2024-11-20 17:35:42 -06:00
context.rb
…
cxxstdlib.rb
cxxstdlib: typed: strong
2024-09-26 14:32:55 -04:00
debrew.rb
…
dependable.rb
…
dependencies_helpers.rb
Fix type error in DependenciesHelpers#dependents
2025-02-18 20:48:56 -08:00
dependencies_helpers.rbi
Enable strict typing in DependenciesHelpers
2025-02-16 12:24:22 -08:00
dependencies.rb
Enable strict typing in DependenciesHelpers
2025-02-16 12:24:22 -08:00
dependencies.rbi
Fix select_includes sig
2025-02-16 13:26:10 -08:00
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
Move remaining OS extensions to prepend
2024-10-05 12:18:29 -07:00
diagnostic.rb
diagnostic: recommend untap where possible
2025-02-21 00:27:59 +08:00
download_queue.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
download_strategy.rb
implement fixes and comments for DisableComment rubocop
2025-01-29 09:17:11 +00:00
download_strategy.rbi
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
downloadable.rb
Use requires_ancestor consistently
2024-10-06 09:25:57 -07:00
env_config.rb
docs: various manpage grammar fixes
2025-02-05 13:38:39 +01:00
exceptions.rb
Use requires_ancestor consistently
2024-10-06 09:25:57 -07:00
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
Fix leftover errors for Dependencies vs. T::Array[Dependency]
2024-10-06 20:04:42 +01:00
formula_creator.rb
formula: add std_zig_args
2025-02-21 14:53:34 +01:00
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
Add brew install --skip-link
2025-01-23 14:42:03 +00:00
formula_name_cask_token_auditor.rb
…
formula_path.sh
…
formula_pin.rb
formula_pin: typed: strict
2024-09-26 14:48:32 -04:00
formula_support.rb
…
formula_versions.rb
…
formula.rb
zig std args: use symbols for compilation options
2025-02-21 17:07:29 +01:00
formulary.rb
remove all references to JSON v3
2025-02-06 21:04:08 -08:00
formulary.rbi
…
Gemfile
Import brew formula-analytics and generate-analytics-api commands
2025-02-07 20:05:05 +00:00
Gemfile.lock
Merge pull request #19347 from Homebrew/dependabot/bundler/Library/Homebrew/sorbet-20eb92d5ee
2025-02-21 18:52:56 +00:00
git_repository.rb
Add new odeprecated, odisabled, remove disabled code.
2024-09-24 10:15:34 +01:00
github_packages.rb
Resolve rubocop violations
2025-02-17 18:56:31 -08:00
github_releases.rb
…
github_runner_matrix.rb
Resolve rubocop violations
2025-02-17 18:56:31 -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
head_software_spec.rb
Split up SoftwareSpec
2025-02-04 16:27:39 +00:00
help.rb
Bump more files to Sorbet typed: strict
2024-10-06 20:04:42 +01:00
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
Add brew install --skip-link
2025-01-23 14:42:03 +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
livecheck: refactor HEAD-only formula handling
2025-02-20 22:39:18 -05:00
keg.rbi
Fix tests
2024-10-05 12:18:29 -07:00
lazy_object.rb
implement fixes and comments for DisableComment rubocop
2025-01-29 09:17:11 +00:00
linkage_cache_store.rb
Resolve rubocop violations
2025-02-17 18:56:31 -08:00
linkage_checker.rb
linkage_checker: replace Fiddle.dlopen with libSystem call
2024-10-03 23:20:52 +08:00
linux_runner_spec.rb
…
linuxbrew-core-migration.rb
…
list.sh
…
livecheck.rb
livecheck: restrict POST hashes to symbol keys
2025-02-21 21:54:46 -05:00
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
Import brew alias and brew unalias commands
2025-02-07 14:31:50 +00:00
options.rb
…
options.rbi
…
os.rb
glibc: set next version
2025-02-04 21:18:02 +01:00
patch.rb
patch: restore output from failed patch
2024-12-19 14:56:00 -05:00
PATH.rb
PATH: typed: strict
2024-09-26 16:19:11 -04:00
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
pour_bottle_check.rb
Split up SoftwareSpec
2025-02-04 16:27:39 +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
allow @ and + characters for search
2024-09-17 12:43:28 +09:00
service.rb
Add missing utils/service require
2024-12-07 10:35:33 -08:00
settings.rb
…
shell_command.rb
…
simulate_system.rb
…
software_spec.rb
Split up SoftwareSpec
2025-02-04 16:27:39 +00:00
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
remove all references to JSON v3
2025-02-06 21:04:08 -08:00
tap.sh
tap.sh: tweak naming
2024-09-25 16:49:46 +08:00
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
implement fixes and comments for DisableComment rubocop
2025-01-29 09:17:11 +00:00
version.rb
Fix test
2025-02-17 19:11:48 -08:00
warnings.rb
warnings: typed: strict
2024-09-27 12:31:59 -04:00

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!