admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Sam Ford f23d0ce373
livecheck: convert head-only strings to Versions 
`brew livecheck` currently gives a Sorbet type error when run on a
HEAD-only formula: `Parameter 'version': Expected type Version, got
type String with value "c06c10d"`. This happens because the `current`
and `latest` values are strings but `LivecheckVersion#create` expects
a `Version` object.

This addresses the issue by creating a `Version` object from the
related commit strings. This ensures that the type of these variables
is more uniform, which makes them easier to reason about.
2024-07-25 10:23:39 -04:00
..
.bundle
…
api
Add env to disable finding packages from paths
2024-07-25 11:37:44 +01:00
cask
Add env to disable finding packages from paths
2024-07-25 11:37:44 +01:00
cli
Add missing_formula require
2024-07-18 20:42:05 -07:00
cmake
cmake: don't set cmake_minimum_required
2024-06-07 12:47:05 -04:00
cmd
Merge pull request #17850 from Homebrew/repository-prefix-fix
2024-07-25 09:54:37 +08:00
completions
…
data/spdx
spdx: update license data.
2024-05-23 00:11:53 +00:00
debrew
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
dev-cmd
contributions: resolve type errors
2024-07-18 15:40:10 -04:00
extend
Remove unused argument.
2024-07-14 15:08:37 -04:00
language
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +01:00
livecheck
livecheck: convert head-only strings to Versions
2024-07-25 10:23:39 -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
Make the bin starts_with method its own thing as it needs more args
2024-07-24 22:41:26 +01:00
shims
compilers: add gcc-14
2024-05-02 09:40:09 +02:00
sorbet
Merge pull request #17840 from Homebrew/forbid-path-installs
2024-07-25 11:48:30 +01: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
Merge pull request #17840 from Homebrew/forbid-path-installs
2024-07-25 11:48:30 +01:00
unpack_strategy
unpack_strategy/dmg: Convert to Sorbet typed: strict
2024-07-11 21:34:26 -04:00
utils
Merge pull request #17851 from Homebrew/misconfigured-nss-fix
2024-07-25 04:47:43 +01:00
vendor
brew vendor-gems: commit updates.
2024-07-24 17:44:01 +00: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
…
attestation.rb
attestation: only fallback to backfill on 404
2024-07-23 16:59:52 +01:00
attrable.rb
…
attrable.rbi
…
brew_irbrc
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
brew.rb
Add utils/backtrace requires
2024-07-15 17:48:47 -04:00
brew.sh
brew.sh: fix nested developer command detection
2024-07-15 02:46:22 +01: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
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
cleanup.rb
version: enable strict typing
2024-06-11 23:03:53 +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
download_strategy: fix handling of Apache projects moved to Attic
2024-07-23 15:27:37 +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
Add env to disable finding packages from paths
2024-07-25 11:37:44 +01:00
exceptions.rb
Rearrange requires
2024-07-14 08:49:39 -04: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
formula_auditor: scope eol check to core tap
2024-06-22 12:19:09 -07: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
Lint Ruby docs.
2024-05-01 11:35:21 +02: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
attestation: only fallback to backfill on 404
2024-07-23 16:59:52 +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
Merge pull request #17774 from branchvincent/std_npm_args
2024-07-25 05:41:19 +01:00
formula.rbi
…
formulary.rb
Add env to disable finding packages from paths
2024-07-25 11:37:44 +01:00
formulary.rbi
…
Gemfile
Remove non-Portable Ruby bootsnap support
2024-06-19 16:08:05 +01:00
Gemfile.lock
brew vendor-gems: commit updates.
2024-07-24 17:44:01 +00: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
global: more require ordering fixes.
2024-07-14 14:11:42 -04: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
Make documentation @api private by default.
2024-04-26 19:04:20 +02: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: add missing require
2024-07-20 14:48:49 -04:00
resource.rb
Implement verify_download_integrity for bottle manifests.
2024-07-13 16:50:53 -04:00
rubocops.rb
…
sandbox.rb
Revert "sandbox: deny signal to other processes"
2024-07-15 12:22:02 -04:00
sbom.rb
sbom: fix dependency bottle information in SBOM.
2024-05-26 16:48:48 +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: Fix ref_type type (Symbol, not String)
2024-07-11 19:37:46 +01:00
unpack_strategy.rbi
…
unversioned_cask_checker.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
upgrade.rb
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02: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!