admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
apainintheneck 373b7d1dbb tap: tweak core tap warning 
Most users don't need the core taps to be installed locally but the
current message doesn't communicate that they're sometimes necessary
for local development. This just tweaks the message to be more
informative.

```console
$ brew tap homebrew/cask
Error: Tapping homebrew/cask is no longer typically necessary.
Add --force if you are sure you need it for local development.
```
2024-05-04 09:59:47 -07:00
..
.bundle
…
api
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
cask
various: remove remaining Homebrew/cask-versions references
2024-05-02 15:29:21 -07:00
cli
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02:00
cmd
Merge pull request #17204 from Homebrew/ruby_scripts_to_utils_files
2024-05-02 10:44:00 +01:00
completions
…
data/spdx
…
debrew
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
dev-cmd
Merge pull request #17204 from Homebrew/ruby_scripts_to_utils_files
2024-05-02 10:44:00 +01:00
extend
Fix internal formula json v3 frozen hash parsing bug
2024-05-01 21:36:37 -07:00
language
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
livecheck
Pypi: Update strategy regex
2024-05-03 10:21:03 -04:00
manpages
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
os
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
requirements
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
rubocops
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
shims
compilers: add gcc-14
2024-05-02 09:40:09 +02:00
sorbet
Update RBI files for rubocop-rspec.
2024-05-03 14:10:32 +00:00
standalone
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
startup
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
test
Pypi: Update strategy regex
2024-05-03 10:21:03 -04:00
unpack_strategy
…
utils
Merge pull request #17204 from Homebrew/ruby_scripts_to_utils_files
2024-05-02 10:44:00 +01:00
vendor
Merge pull request #17216 from Homebrew/dependabot/bundler/Library/Homebrew/multi-5c08dc554c
2024-05-03 07:23:29 -07:00
version
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
yard
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
.parlour
…
.rspec_parallel
…
.rubocop.yml
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02: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
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
ast_constants.rb
ast_constants: enforce {allow,deny}_network_access! order
2024-04-22 22:48:08 -04:00
attestation.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
attrable.rb
…
attrable.rbi
…
brew_irbrc
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
brew.rb
analytics: support command and test-bot analytics.
2024-04-25 17:38:04 +01:00
brew.sh
Merge pull request #17204 from Homebrew/ruby_scripts_to_utils_files
2024-05-02 10:44:00 +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
Make documentation @api private by default.
2024-04-26 19:04:20 +02: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
Lint Ruby docs.
2024-05-01 11:35:21 +02: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
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
deprecate_disable.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
description_cache_store.rb
…
descriptions.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
development_tools.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
diagnostic.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
download_strategy.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
download_strategy.rbi
…
downloadable.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
env_config.rb
Merge pull request #17081 from alebcay/formula-offline-phases
2024-04-23 08:30:10 +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
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
formula_cellar_checks.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02: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
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02: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_text_auditor.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
formula: fix missing test resources.
2024-05-03 08:29:10 +01:00
formula.rbi
…
formulary.rb
Fix internal formula json v3 frozen hash parsing bug
2024-05-01 21:36:37 -07:00
formulary.rbi
…
Gemfile
Add redcarpet gem.
2024-05-01 11:35:21 +02:00
Gemfile.lock
Merge pull request #17216 from Homebrew/dependabot/bundler/Library/Homebrew/multi-5c08dc554c
2024-05-03 07:23:29 -07:00
git_repository.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
github_packages.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
github_releases.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
github_runner_matrix.rb
…
github_runner.rb
…
global.rb
…
global.rbi
…
hardware.rb
…
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
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
install.rb
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02: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
…
linkage_checker.rb
Document Tab.for_keg and use Keg#tab where possible.
2024-04-28 20:50:13 +02:00
linux_runner_spec.rb
…
linuxbrew-core-migration.rb
…
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
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
macos_version.rbi
…
manpages.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
messages.rb
…
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
homebrew/cask-versions: remove
2024-05-02 16:59:33 -04: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
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
rubocops.rb
…
sandbox.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
search.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
service.rb
…
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
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
source_location.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02:00
standalone.rb
…
startup.rb
…
style.rb
Warn about undocumented non-private APIs.
2024-05-01 11:35:20 +02: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
tap: tweak core tap warning
2024-05-04 09:59:47 -07: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
Lint Ruby docs.
2024-05-01 11:35:21 +02:00
version.rbi
…
warnings.rb
Lint Ruby docs.
2024-05-01 11:35:21 +02: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!