admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Issy Long c37601f585
dev-cmd/bump-{cask,formula}-pr: args.message is before the default 
- I was wondering why `brew bump` PRs have descriptions with both commands, like:

```
Created with `brew bump`.

---

Created by `brew bump-formula-pr`.
```

- Then I read the code and realised that "append" was the wrong word for the
  `--message` arg description.
2022-11-19 23:03:23 +00:00
..
.bundle
…
api
Load formulae from their aliases using the API
2022-09-14 23:59:10 -04:00
cask
Fix install <cask> --dry-run
2022-11-11 17:33:11 +00: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
dev-cmd/bump-{cask,formula}-pr: args.message is before the default
2022-11-19 23:03:23 +00:00
extend
CPU: cleanup sysctl_int method
2022-11-16 10:51:59 +00: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
Allow multiple macOS requirements
2022-11-09 01:19:46 +00:00
rubocops
uses_from_macos: add mandoc to allowed list
2022-11-10 21:56:23 -08:00
shims
Update Bundler to 2.3.26
2022-11-17 16:35:08 +00:00
sorbet
Update RBI files for bootsnap.
2022-11-18 17:38:01 +00:00
standalone
Remove sitedir from LOAD_PATH
2022-10-24 19:42:49 +01:00
startup
Universally apply Ruby disable options
2022-11-05 01:58:12 +00:00
test
Only optimize for the core tap
2022-11-17 21:15:43 -08:00
unpack_strategy
sorbet: Bump some files from typed: false to typed: true
2022-10-11 01:09:03 +01:00
utils
utils/gems: use env shebang when installing gems
2022-11-19 00:58:05 +00:00
vendor
brew vendor-gems: commit updates.
2022-11-18 17:31:29 +00: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
Universally apply Ruby disable options
2022-11-05 01:58:12 +00: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
rubydoc: fixes for output
2022-11-11 16:16:54 -05:00
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
brew style --fix
2022-06-30 08:56:21 +01:00
description_cache_store.rb
Deprecate reading all formulae through commands
2022-09-05 13:57:22 +01:00
descriptions.rb
…
development_tools.rb
tests: test on Ubuntu 18.04.
2022-11-09 14:45:43 +00:00
diagnostic.rb
Strengthen "don't create issues" language
2022-10-20 11:39:20 +01:00
download_strategy.rb
reset require-utils/github location
2022-11-07 23:12:27 +09:00
env_config.rb
docs: Fix env variable typo
2022-11-10 07:33:52 -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
Merge pull request #13366 from hyuraku/repair-check_cpuid_instruction
2022-06-28 09:59:41 +01:00
formula_creator.rb
…
formula_free_port.rb
…
formula_info.rb
…
formula_installer.rb
tests: test on Ubuntu 18.04.
2022-11-09 14:45:43 +00:00
formula_pin.rb
…
formula_support.rb
…
formula_text_auditor.rb
…
formula_versions.rb
…
formula.rb
rubydoc: fixes for output
2022-11-11 16:16:54 -05: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
Allow gem installation on Rubies other than 2.6
2022-11-05 15:23:19 +00:00
Gemfile.lock
build(deps): bump bootsnap from 1.13.0 to 1.14.0 in /Library/Homebrew
2022-11-18 17:24:22 +00: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
dev-cmd/unbottled: simulate target tag
2022-11-16 00:07:31 +00: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
minor typo fixes
2022-11-06 22:50:07 -05:00
livecheck.rb
Add arch cask DSL
2022-08-05 17:12:55 -04:00
locale.rb
…
lock_file.rb
…
macos_versions.rb
Create MacOSVersions module
2022-06-29 11:34:49 -04:00
manpages.rb
repair style
2022-11-08 21:11:10 +09:00
manpages.rbi
add manpage.rb to generating homebrew manual
2022-11-08 20:33:30 +09:00
messages.rb
…
metafiles.rb
…
migrator.rb
…
missing_formula.rb
Only optimize for the core tap
2022-11-17 21:15:43 -08: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
minor typo fixes
2022-11-06 22:50:07 -05:00
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
Allow multiple macOS requirements
2022-11-09 01:19:46 +00: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: add method to define a root requirement
2022-11-06 13:52:53 +01: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
style: check more shell scripts.
2022-11-09 17:29:38 +00: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
tests: test on Ubuntu 18.04.
2022-11-09 14:45:43 +00: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
ExtractPlist: Modify #find_versions url usage
2022-06-24 00:08:53 -04:00
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!