admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Issy Long f3d43110b5
test/rubocops/formula_desc: Ensure that desc allows ending with etc. 
- This was funny (and embarrassing), I was looking at my first contributions to
  Homebrew since someone asked me how long I'd been involved.
- Turns out that in 2017 I improved the formula description RuboCop rule to
  allow descriptions to end with `etc.` in
  https://github.com/Homebrew/brew/pull/3411. Apparently I didn't have time
  back then to write a test for it. So now I will remedy this 5 years later.
2022-11-03 22:25:07 +00:00
..
.bundle
…
api
Load formulae from their aliases using the API
2022-09-14 23:59:10 -04:00
cask
Fix: Sparkle audit prior to el_capitan
2022-11-02 21:30:51 -07:00
cli
Additional fixes for Ruby 3 compatibility
2022-10-18 01:54:59 +01:00
cmd
cmd/search: better handle non-TTY output.
2022-11-01 13:51:13 +00:00
compat
Remove odisabled for 3.6.0
2022-08-23 11:25:02 +01:00
completions
…
data/spdx
spdx: update license data.
2022-08-13 00:13:41 +00:00
debrew
…
dev-cmd
tests: fix under GitHub Codespaces.
2022-11-03 16:33:04 +00:00
extend
os/mac/diagnostic: allow Ruby 2.6.10 on < Ventura
2022-10-25 10:55:05 +01:00
language
language/python: support python3 from PATH in #detected_python_shebang
2022-08-13 01:11:09 +08:00
livecheck
Additional fixes for Ruby 3 compatibility
2022-10-18 01:54:59 +01:00
manpages
…
os
os/mac/xcode: do not recommend softwareupdate CLI
2022-10-30 18:16:08 +00:00
requirements
…
rubocops
Allow livecheck method in on_system blocks
2022-10-18 16:02:29 -04:00
rubyext/rubygems/defaults
Workaround macOS system Ruby issue picking incorrect native gem archs
2022-10-14 01:30:38 +01:00
shims
Workaround macOS system Ruby issue picking incorrect native gem archs
2022-10-14 01:30:38 +01:00
sorbet
sorbet: Update RBI files.
2022-10-18 00:37:06 +00:00
standalone
Remove sitedir from LOAD_PATH
2022-10-24 19:42:49 +01:00
startup
Replace sorbet-runtime-stub with sorbet-runtime
2022-07-19 23:43:14 +01:00
test
test/rubocops/formula_desc: Ensure that desc allows ending with etc.
2022-11-03 22:25:07 +00:00
unpack_strategy
sorbet: Bump some files from typed: false to typed: true
2022-10-11 01:09:03 +01:00
utils
Merge pull request #14041 from Bo98/no-sitedir
2022-10-25 23:02:10 +01:00
vendor
Gemfile: bump nokogiri.
2022-10-25 12:56:06 +01:00
version
version/null: fix major_minor(_patch) type signature
2022-10-07 19:21:11 +01:00
yard
sorbet: Bump some files from typed: false to typed: true
2022-10-11 01:09:03 +01:00
.parlour
…
.rspec_parallel
…
.rubocop_todo.yml
…
.rubocop.yml
Move Metrics/Blocklength disable to rubocop.yml
2022-08-02 09:06:28 -07:00
.simplecov
…
.yardopts
…
api.rb
…
ast_constants.rb
Add on_system to and reorder component order cop
2022-07-24 23:37:35 +02:00
brew.rb
Strengthen "don't create issues" language
2022-10-20 11:39:20 +01:00
brew.sh
Remove sitedir from LOAD_PATH
2022-10-24 19:42:49 +01:00
build_environment.rb
Freeze formula definition once first instance is created
2022-08-31 20:40:42 +01:00
build_options.rb
…
build.rb
Prevent require executing some scripts
2022-09-08 01:44:31 +01:00
bundle_version.rb
…
cache_store.rb
…
cask_dependent.rb
cask_dependent: fix incorrect requirement logic
2022-08-31 19:17:52 +01:00
cask.rb
…
caveats.rb
sorbet: Bump some files from typed: false to typed: true
2022-10-11 01:09:03 +01:00
checksum.rb
…
cleaner.rb
…
cleanup.rb
Move autoremove code to util and add tests
2022-09-13 23:23:48 -07:00
commands.rb
…
compilers.rb
glibc related cleanup
2022-08-23 12:42:02 +01:00
completions.rb
…
completions.rbi
…
config.rbi
…
context.rb
…
cxxstdlib.rb
…
debrew.rb
…
default_prefix.rb
Move HOMEBREW_SIMULATE_MACOS_ON_LINUX handling to SimulateSystem
2022-07-28 15:04:25 -04:00
dependable.rb
…
dependable.rbi
…
dependencies_helpers.rb
…
dependencies_helpers.rbi
…
dependencies.rb
cask_dependent: fix incorrect requirement logic
2022-08-31 19:17:52 +01:00
dependencies.rbi
…
dependency_collector.rb
Freeze formula definition once first instance is created
2022-08-31 20:40:42 +01:00
dependency.rb
…
deprecate_disable.rb
…
description_cache_store.rb
Deprecate reading all formulae through commands
2022-09-05 13:57:22 +01:00
descriptions.rb
…
development_tools.rb
install glibc/gcc automatically if too old.
2022-08-25 11:04:37 +01:00
diagnostic.rb
Strengthen "don't create issues" language
2022-10-20 11:39:20 +01:00
download_strategy.rb
Singularise only_paths (now only_path)
2022-10-22 10:53:02 -04:00
env_config.rb
resource: automatic determine mirrors for PyPI resources
2022-09-16 01:57:19 +08:00
exceptions.rb
build_environment: add proper types to dump() and fix inreplace error
2022-08-15 19:03:55 +02:00
fetch.rb
…
formula_assertions.rb
…
formula_auditor.rb
formula_auditor: support non-master default branch for downgrade audit
2022-10-07 18:42:51 +01:00
formula_cellar_checks.rb
…
formula_creator.rb
…
formula_free_port.rb
…
formula_info.rb
…
formula_installer.rb
Strengthen "don't create issues" language
2022-10-20 11:39:20 +01:00
formula_pin.rb
…
formula_support.rb
…
formula_text_auditor.rb
…
formula_versions.rb
…
formula.rb
Add stable checksum to the JSON API
2022-10-21 01:22:36 -04:00
formula.rbi
Add --variations option to brew info
2022-07-21 16:41:15 +02:00
formulary.rb
Add stable checksum to the JSON API
2022-10-21 01:22:36 -04:00
Gemfile
Gemfile*,dev-cmd/typecheck: Use Spoom for --suggest-typed
2022-10-11 01:09:02 +01:00
Gemfile.lock
Gemfile: bump nokogiri.
2022-10-25 12:56:06 +01:00
github_packages.rb
glibc related cleanup
2022-08-23 12:42:02 +01:00
github_releases.rb
…
global.rb
Adds brew docs to close #13834
2022-09-11 22:10:37 -05:00
global.rbi
…
hardware.rb
Enable Linux AArch64 support
2022-09-29 16:33:44 +08:00
help.rb
…
help.rbi
…
ignorable.rb
…
install_renamed.rb
…
install.rb
Merge branch 'master' into add-dry-run-option-to-brew-install
2022-10-03 10:10:58 +01:00
install.rbi
…
installed_dependents.rb
…
items.sh
…
keg_relocate.rb
install glibc/gcc automatically if too old.
2022-08-25 11:04:37 +01:00
keg.rb
rename & inline dsymutil to prepare_debug_symbols
2022-07-30 11:08:52 +01:00
lazy_object.rb
…
linkage_cache_store.rb
…
linkage_checker.rb
linkage_checker: ignore broken linkage with LLVM libc++.
2022-09-19 12:37:32 +08:00
linuxbrew-core-migration.rb
sorbet: Bump some files from typed: false to typed: true
2022-10-11 01:09:03 +01:00
livecheck.rb
Add arch cask DSL
2022-08-05 17:12:55 -04:00
locale.rb
…
lock_file.rb
…
macos_versions.rb
…
messages.rb
…
metafiles.rb
…
migrator.rb
…
missing_formula.rb
missing_formula: message for postgres rename.
2022-08-10 15:15:21 +01:00
mktemp.rb
fix debug-symbols
2022-08-13 23:30:20 -10:00
official_taps.rb
official_taps: Add cask-fonts, cask-drivers taps
2022-08-03 17:52:54 +01:00
options.rb
Freeze formula definition once first instance is created
2022-08-31 20:40:42 +01:00
os.rb
Use unversioned GCC for runtime libraries when required.
2022-09-27 13:11:04 +08:00
patch.rb
…
PATH.rb
…
pkg_version.rb
…
postinstall.rb
Prevent require executing some scripts
2022-09-08 01:44:31 +01:00
prefix.sh
…
readall.rb
Simulate all OS/arch combinations in brew readall
2022-10-10 23:56:37 -04:00
README.md
…
reinstall.rb
Connecting up --debug-symbols flag
2022-07-26 12:15:53 +01:00
requirement.rb
requirement: require instances to use a subclass
2022-08-31 19:17:55 +01:00
requirements.rb
…
resource_auditor.rb
ResourceAuditor: Fix #audit_head_branch error
2022-10-17 13:28:20 -04:00
resource.rb
resource: automatic determine mirrors for PyPI resources
2022-09-16 01:57:19 +08:00
rubocops.rb
…
sandbox.rb
…
search.rb
…
searchable.rb
…
service.rb
service: use default.target on Linux
2022-10-07 20:22:12 +02:00
settings.rb
…
settings.rbi
…
simulate_system.rb
Move HOMEBREW_SIMULATE_MACOS_ON_LINUX handling to SimulateSystem
2022-07-28 15:04:25 -04:00
software_spec.rb
Preliminary compatibility fixes for Ruby 3
2022-10-11 02:53:27 +01:00
standalone.rb
…
startup.rb
Replace sorbet-runtime-stub with sorbet-runtime
2022-07-19 23:43:14 +01:00
style.rb
Workaround macOS system Ruby issue picking incorrect native gem archs
2022-10-14 01:30:38 +01:00
system_command.rb
Preliminary compatibility fixes for Ruby 3
2022-10-11 02:53:27 +01:00
system_config.rb
…
tab.rb
Include loaded_from_api key in Tab
2022-09-14 22:23:01 -04:00
tap_auditor.rb
formula_auditor: create a versioned formula dependent conflict allowlist
2022-08-18 15:40:54 +08:00
tap_constants.rb
…
tap.rb
Deprecate reading all formulae through commands
2022-09-05 13:57:22 +01:00
test.rb
Prevent require executing some scripts
2022-09-08 01:44:31 +01:00
uninstall.rb
Moved autoremove logic into autoremove.rb
2022-07-13 16:31:41 -07:00
uninstall.rbi
…
unlink.rb
…
unpack_strategy.rb
…
unpack_strategy.rbi
…
unversioned_cask_checker.rb
…
upgrade.rb
share Install.print_dry_run_dependencies
2022-09-03 16:01:55 +09:00
utils.rb
utils: prefer BBEdit over TextWrangler
2022-08-31 15:26:58 -04:00
version.rb
…
version.rbi
…
warnings.rb
…
warnings.rbi
…

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!