admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Issy Long f2f4f1c06d
sorbet: Tighten up dev-cmd types 
- Change `returns(NilClass)` to `void`.
- Get rid of some of the `T.untyped`.
2024-07-04 12:04:29 +01:00
..
.bundle
…
api
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
cask
Merge pull request #17608 from Homebrew/audit_min_os-more-fixes
2024-07-02 09:03:49 +01:00
cli
brew style --fix
2024-05-23 17:15:43 +01:00
cmake
cmake: don't set cmake_minimum_required
2024-06-07 12:47:05 -04:00
cmd
Use API for description searches
2024-06-30 23:05:29 -04: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
sorbet: Tighten up dev-cmd types
2024-07-04 12:04:29 +01:00
extend
cask/audit: handle on_os range bounded by depends_on
2024-07-01 23:11:26 -04:00
language
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +01:00
livecheck
Remove redundant early return in livecheck skip_conditions
2024-06-29 11:42:24 -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
rubocops/class: allow disabled formulae to be without a test block
2024-07-03 10:25:26 +01:00
shims
compilers: add gcc-14
2024-05-02 09:40:09 +02:00
sorbet
Update RBI files for vernier.
2024-07-01 18:10:50 +00:00
standalone
Further Portable Ruby cleanup
2024-06-14 12:22:02 +01:00
startup
Remove non-Portable Ruby bootsnap support
2024-06-19 16:08:05 +01:00
test
rubocops/class: allow disabled formulae to be without a test block
2024-07-03 10:25:26 +01:00
unpack_strategy
Revert "Use cp -c when copying files"
2024-06-17 21:17:10 -07:00
utils
autoremove: skip formulae where installed_on_request is nil
2024-06-28 21:57:47 -04:00
vendor
Merge pull request #17616 from Homebrew/dependabot/bundler/Library/Homebrew/rubocop-rspec-3.0.2
2024-07-03 12:12:04 -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.3
2024-06-14 03:32:38 +01:00
.simplecov
…
.yardopts
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
abstract_command.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
api.rb
Hide default gems warnings for Ruby 3.4.
2024-05-17 14:42:44 +09:00
ast_constants.rb
ast_constants: enforce {allow,deny}_network_access! order
2024-04-22 22:48:08 -04:00
attestation.rb
Use repository consistently instead of repo
2024-06-10 09:31:53 +01:00
attrable.rb
…
attrable.rbi
…
brew_irbrc
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
brew.rb
Make more files Sorbet typed: strict
2024-06-02 15:15:24 +01:00
brew.sh
cmd/setup-ruby: fix Portable Ruby install failing
2024-06-14 02:26:16 +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
Make documentation @api private by default.
2024-04-26 19:04:20 +02: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
…
cask_dependent.rb
…
cask.rb
…
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
Make documentation @api private by default.
2024-04-26 19:04:20 +02: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
Make documentation @api private by default.
2024-04-26 19:04:20 +02: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
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
dependency.rb
brew style --fix
2024-05-23 17:15:43 +01:00
deprecate_disable.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
description_cache_store.rb
brew style --fix
2024-05-17 14:25:54 +09:00
descriptions.rb
Use API for description searches
2024-06-30 23:05:29 -04:00
development_tools.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
diagnostic.rb
diagnostic: fix cask taps doctor output.
2024-06-11 10:23:39 +01:00
download_strategy.rb
Add a comment for what and why we're rescuing
2024-06-27 12:27:30 +01:00
download_strategy.rbi
…
downloadable.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
env_config.rb
Remove non-Portable Ruby bootsnap support
2024-06-19 16:08:05 +01:00
exceptions.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
exceptions.rbi
…
fetch.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
formula_assertions.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02: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
formula_installer: fix gh bootstrap cycle
2024-06-21 12:35:01 -04: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
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula.rb
Use repository consistently instead of repo
2024-06-10 09:31:53 +01:00
formula.rbi
…
formulary.rb
Load tap migration renames from API with short names
2024-07-01 18:53:31 -07:00
formulary.rbi
…
Gemfile
Remove non-Portable Ruby bootsnap support
2024-06-19 16:08:05 +01:00
Gemfile.lock
Merge pull request #17616 from Homebrew/dependabot/bundler/Library/Homebrew/rubocop-rspec-3.0.2
2024-07-03 12:12:04 -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
brew style --fix
2024-05-17 14:25:54 +09:00
global.rbi
…
hardware.rb
Fix for 'brew style'
2024-06-30 02:35:29 -04:00
help.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02: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
…
keg.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02: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
…
list.sh
Speed up brew list
2024-05-17 12:38:16 +09:00
livecheck.rb
…
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
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02: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
docs: update for Homebrew/cask-fonts deprecation
2024-05-16 09:21:14 -07:00
options.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
options.rbi
…
os.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
patch.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
PATH.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
pkg_version.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
pkg_version.rbi
…
postinstall.rb
…
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
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
resource.rb
brew style --fix
2024-05-23 17:15:43 +01:00
rubocops.rb
…
sandbox.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02: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
simulate_system.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
software_spec.rb
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +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
style: chdir before running rubocop
2024-06-30 01:51:56 +01:00
system_command.rb
Explicitly mark non-public APIs.
2024-04-23 19:10:45 +02:00
system_config.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
tab.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02: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
Use repository consistently instead of repo
2024-06-10 09:31:53 +01:00
test_runner_formula.rb
…
test.rb
…
uninstall.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
unlink.rb
…
unpack_strategy.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02: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
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
utils.rb
…
version.rb
version: enable strict typing
2024-06-11 23:03:53 +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!