admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Mike McQuaid debdc30aa0
language/*: only check required deps in detected_*_shebang 
Otherwise, we rewrite this even when we have a e.g. build or test
dependency on NodeJS.

See context in:
https://github.com/Homebrew/homebrew-core/issues/176257#issuecomment-2277602215
2024-08-09 14:08:29 +01:00
..
.bundle
…
api
Add env to disable finding packages from paths
2024-07-25 11:37:44 +01:00
cask
cask/info: tweak style.
2024-08-05 09:33:59 +01:00
cli
cli/named_args: improve missing_formula requires.
2024-07-25 12:54:03 +01:00
cmake
cmake: don't set cmake_minimum_required
2024-06-07 12:47:05 -04:00
cmd
cmd/update: make chown suggestion consistent
2024-08-06 21:42:50 +01:00
completions
…
data
Fix SBOM schema validation
2024-08-08 02:30:42 +01:00
debrew
debrew/irb: fix errors under Ruby 3.3
2024-08-03 01:18:22 +01:00
dev-cmd
dev-cmd/dispatch-build-bottle: add missing require
2024-08-03 17:44:41 -04:00
extend
diagnostic: fix XDG_DATA_DIRS check
2024-08-05 09:11:01 +01:00
language
language/*: only check required deps in detected_*_shebang
2024-08-09 14:08:29 +01:00
livecheck
Strategy#from_url: remove unused param
2024-07-25 13:41:40 -04:00
manpages
brew style --fix
2024-05-23 17:15:43 +01:00
os
Preliminary macOS 15 (Sequoia) support
2024-06-11 02:59:31 +01:00
requirements
cask/audit: support on_os blocks in audit_min_os
2024-06-21 19:25:51 -04:00
rubocops
Merge pull request #17867 from branchvincent/std_npm_args
2024-08-05 08:52:07 +01:00
shims
shims/super/cc: pass -ld_classic if needed for -dead_strip_dylibs
2024-08-03 14:46:18 -04:00
sorbet
Merge pull request #17990 from Homebrew/dependabot/bundler/Library/Homebrew/parser-3.3.4.2
2024-08-08 14:00:51 -07:00
standalone
Further Portable Ruby cleanup
2024-06-14 12:22:02 +01:00
startup
Remove maintainers.json
2024-07-14 09:03:18 -04:00
test
sbom: fix errors, improve reproducibility, tests.
2024-08-08 09:34:32 +01:00
unpack_strategy
unpack_strategy/cab: align method order
2024-07-28 10:17:23 -04:00
utils
utils/analytics: improve accuracy of GitHub Packages download counts
2024-08-04 05:33:46 +08:00
vendor
Merge pull request #17990 from Homebrew/dependabot/bundler/Library/Homebrew/parser-3.3.4.2
2024-08-08 14:00:51 -07:00
version
Make more files Sorbet typed: strict
2024-06-02 15:15:24 +01:00
yard
brew style --fix
2024-05-23 17:15:43 +01:00
.parlour
…
.rspec_parallel
…
.rubocop.yml
extend/pathname: import rmtree again.
2024-05-18 18:02:31 +02:00
.ruby-version
Portable Ruby 3.3.4
2024-07-13 11:43:17 -04:00
.simplecov
…
.yardopts
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
abstract_command.rb
Add ShellCommand module for shell command stubs
2024-07-15 14:48:36 -04:00
api.rb
Lazy-load development_tools in fetch_json_api_file
2024-07-18 23:02:51 +02:00
ast_constants.rb
ast_constants: enforce {allow,deny}_network_access! order
2024-04-22 22:48:08 -04:00
attestation.rb
attestation: only extract credentials when necessary
2024-07-30 04:51:29 +01:00
attrable.rb
…
attrable.rbi
…
brew_irbrc
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
brew.rb
Improve locking UX
2024-07-30 17:51:02 +01:00
brew.sh
Fix auto-update for WSL
2024-08-05 16:32:42 +00:00
build_environment.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
build_options.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
build.rb
Add env to disable finding packages from paths
2024-07-25 11:37:44 +01:00
bump_version_parser.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
bundle_version.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
cache_store.rb
description cache invalid if updated w/o EVAL_ALL
2024-07-01 15:18:28 -04:00
cask_dependent.rb
…
cask.rb
Add cask install receipts
2024-07-04 01:47:13 -04:00
caveats.rb
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +01:00
checksum.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
cleaner.rb
cleaner: rewrite node shebangs
2024-07-15 21:40:39 -07:00
cleanup.rb
Improve locking UX
2024-07-30 17:51:02 +01:00
command_path.sh
Optimise more command handling/speed
2024-04-30 12:48:29 +01:00
commands.rb
Fix completion generation for --repository
2024-07-14 14:46:59 -04:00
compilers.rb
compilers: add gcc-14
2024-05-02 09:40:09 +02:00
completions.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
context.rb
context: fix original context not being restored
2024-07-08 13:18:18 -04:00
cxxstdlib.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
debrew.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
dependable.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
dependencies_helpers.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
dependencies_helpers.rbi
…
dependencies.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
dependencies.rbi
…
dependency_collector.rb
Rearrange requires
2024-07-14 08:49:39 -04:00
dependency.rb
dependency: fix missed upgrades when an alias is changed to a formula
2024-07-18 15:30:04 +01:00
deprecate_disable.rb
Output disable date for deprecated packages
2024-07-14 11:49:44 -04:00
description_cache_store.rb
description cache invalid if updated w/o EVAL_ALL
2024-07-01 15:18:28 -04:00
descriptions.rb
Use API for description searches
2024-06-30 23:05:29 -04:00
development_tools.rb
Apply suggestions from code review
2024-07-06 15:22:08 +01:00
diagnostic.rb
Widen attestation verification rollout
2024-07-14 11:50:57 -04:00
download_strategy.rb
Improve locking UX
2024-07-30 17:51:02 +01:00
download_strategy.rbi
…
downloadable.rb
Fix missing requires for tap-info command
2024-07-16 21:19:37 +02:00
env_config.rb
Improve locking UX
2024-07-30 17:51:02 +01:00
exceptions.rb
Improve locking UX
2024-07-30 17:51:02 +01:00
exceptions.rbi
…
fetch.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
formula_assertions.rb
formula_assertions: Fix pipe_output type sig
2024-07-16 22:07:31 -04:00
formula_assertions.rbi
…
formula_auditor.rb
feat: enable audit for wayback urls on all formulae
2024-07-29 23:55:17 +02:00
formula_cellar_checks.rb
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +01:00
formula_cellar_checks.rbi
…
formula_creator.rb
docs: update with std_npm_args
2024-08-03 20:28:39 -07:00
formula_free_port.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula_info.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula_installer.rb
Vendor SBOM schema
2024-08-07 18:00:53 +01:00
formula_path.sh
…
formula_pin.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula_support.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
formula_versions.rb
Add utils/backtrace requires
2024-07-15 17:48:47 -04:00
formula.rb
formula: remove std_npm_args from system's pretty_args
2024-07-25 17:11:12 -07:00
formula.rbi
…
formulary.rb
Add env to disable finding packages from paths
2024-07-25 11:37:44 +01:00
formulary.rbi
…
Gemfile
Add vscode Ruby LSP config and documentation
2024-08-02 10:44:43 -04:00
Gemfile.lock
Merge pull request #17990 from Homebrew/dependabot/bundler/Library/Homebrew/parser-3.3.4.2
2024-08-08 14:00:51 -07:00
git_repository.rb
Use repository consistently instead of repo
2024-06-10 09:31:53 +01:00
github_packages.rb
bottle/github_packages: include path_exec_files.
2024-06-19 21:49:31 +02:00
github_releases.rb
Make more files Sorbet typed: strict
2024-06-02 15:15:24 +01:00
github_runner_matrix.rb
github_runner_matrix: define timeout values in constants
2024-05-12 04:48:00 +08:00
github_runner.rb
…
global.rb
Improve locking UX
2024-07-30 17:51:02 +01:00
global.rbi
…
hardware.rb
Fix for 'brew style'
2024-06-30 02:35:29 -04:00
help.rb
Port brew help (without arguments) to Bash
2024-07-14 11:54:05 -04:00
help.sh
Port brew help (without arguments) to Bash
2024-07-14 11:54:05 -04:00
ignorable.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
ignorable.rbi
…
install_renamed.rb
brew style --fix
2024-05-23 17:15:43 +01:00
install.rb
Revert "Create '.keepme' files in directories"
2024-05-10 08:26:31 +01:00
installed_dependents.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
items.sh
…
keg_relocate.rb
Rearrange requires
2024-07-14 08:49:39 -04:00
keg.rb
Rearrange requires
2024-07-14 08:49:39 -04:00
lazy_object.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
linkage_cache_store.rb
brew style --fix
2024-05-17 14:25:54 +09:00
linkage_checker.rb
Preliminary macOS 15 (Sequoia) support
2024-06-11 02:59:31 +01:00
linux_runner_spec.rb
…
linuxbrew-core-migration.rb
sorbet: Autobump sigils via Spoom
2024-07-14 00:24:16 +00:00
list.sh
Speed up brew list
2024-05-17 12:38:16 +09:00
livecheck.rb
Rearrange requires
2024-07-14 08:49:39 -04:00
locale.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
lock_file.rb
Improve locking UX
2024-07-30 17:51:02 +01:00
macos_runner_spec.rb
…
macos_version.rb
Preliminary macOS 15 (Sequoia) support
2024-06-11 02:59:31 +01:00
macos_version.rbi
…
manpages.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
messages.rb
messages: enable strict typing
2024-05-13 08:48:41 -04:00
metafiles.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
migrator.rb
Add utils/backtrace requires
2024-07-15 17:48:47 -04:00
missing_formula.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
mktemp.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
official_taps.rb
official_taps: Bump to Sorbet typed: strict
2024-07-17 16:02:01 -04:00
options.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
options.rbi
…
os.rb
os: Bump to Sorbet typed: strict
2024-07-17 16:01:59 -04:00
patch.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
PATH.rb
Rearrange requires
2024-07-14 08:49:39 -04:00
pkg_version.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
pkg_version.rbi
…
postinstall.rb
Add env to disable finding packages from paths
2024-07-25 11:37:44 +01:00
readall.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
README.md
…
reinstall.rb
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02:00
requirement.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
requirements.rb
…
resource_auditor.rb
resource_auditor: make typechecker happy
2024-07-29 10:27:42 -04:00
resource.rb
Implement verify_download_integrity for bottle manifests.
2024-07-13 16:50:53 -04:00
rubocops.rb
…
sandbox.rb
sandbox: disallow backslashes in path filter names
2024-07-31 12:10:51 -04:00
sbom.rb
sbom: fix errors, improve reproducibility, tests.
2024-08-08 09:34:32 +01:00
search.rb
Use API for description searches
2024-06-30 23:05:29 -04:00
service.rb
rm unnecessary casts
2024-05-31 15:49:12 -07:00
service.rbi
…
settings.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
shell_command.rb
shell_command: fix typecheck error
2024-07-15 15:39:10 -04:00
simulate_system.rb
Rearrange requires
2024-07-14 08:49:39 -04:00
software_spec.rb
software_spec: remove confusing missing version error
2024-07-25 02:17:27 +01:00
source_location.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
standalone.rb
…
startup.rb
…
style.rb
Replace deprecated Cop.registry with Registry.global
2024-07-10 13:07:02 -07:00
system_command.rb
system_command: fix EBADF on Ctrl+C
2024-07-23 18:48:42 +01:00
system_config.rb
Rearrange requires
2024-07-14 08:49:39 -04:00
tab.rb
Include recursive dependencies in cask tabs
2024-07-09 15:25:57 -04:00
tap_auditor.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
tap_constants.rb
homebrew/cask-versions: remove
2024-05-02 16:59:33 -04:00
tap.rb
Fix missing requires for tap-info command
2024-07-16 21:19:37 +02:00
test_runner_formula.rb
…
test.rb
Add env to disable finding packages from paths
2024-07-25 11:37:44 +01:00
uninstall.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
unlink.rb
…
unpack_strategy.rb
unpack_strategy: update types
2024-07-28 22:31:38 +10:00
unpack_strategy.rbi
…
unversioned_cask_checker.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
upgrade.rb
upgrade: fix missed upgrades when an alias is changed to a formula
2024-08-03 01:49:40 +01:00
upgrade.rbi
…
url.rb
Rearrange requires
2024-07-14 08:49:39 -04:00
utils.rb
Rearrange requires
2024-07-14 08:49:39 -04:00
version.rb
version: use T.unsafe for https://srb.help/7019
2024-07-25 12:14:06 +01:00
warnings.rb
Hide default gems warnings for Ruby 3.4.
2024-05-17 14:42:44 +09: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!