admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Mike McQuaid a707c708c1
Fix/reenable brew style docs 
- start running this check again
- check the `docs` basename correctly
- use a different name (to a symlink) for the docs rubocop
  configuration so that path relativity is done correctly:
  https://docs.rubocop.org/rubocop/configuration.html#path-relativity
- add more wildcards to fix docs rubocop exclusions
2024-06-13 12:31:47 +01:00
..
.bundle
…
api
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
cask
Merge pull request #17373 from tesaguri/cp-reflink
2024-06-13 08:57:20 +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
cmd/tab: new command
2024-06-13 11:44:14 +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
Use repository consistently instead of repo
2024-06-10 09:31:53 +01:00
extend
Merge pull request #17373 from tesaguri/cp-reflink
2024-06-13 08:57:20 +01:00
language
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +01:00
livecheck
Make more files Sorbet typed: strict
2024-06-02 15:15:24 +01: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: skip variations for inapplicable versions
2024-06-03 12:33:00 -04:00
rubocops
rubocops/shared/desc_helper: fix autocorrect infinite loop
2024-05-21 23:55:26 +01:00
shims
compilers: add gcc-14
2024-05-02 09:40:09 +02:00
sorbet
Merge pull request #17449 from Homebrew/brew-mark
2024-06-13 09:11:00 +01:00
standalone
brew style --fix
2024-05-23 17:15:43 +01:00
startup
Make more files Sorbet typed: strict
2024-06-02 15:15:24 +01:00
test
Merge pull request #17449 from Homebrew/brew-mark
2024-06-13 09:11:00 +01:00
unpack_strategy
Merge pull request #17373 from tesaguri/cp-reflink
2024-06-13 08:57:20 +01:00
utils
Merge pull request #17373 from tesaguri/cp-reflink
2024-06-13 08:57:20 +01:00
vendor
Merge pull request #17484 from Homebrew/dependabot/bundler/Library/Homebrew/parser-3.3.3.0
2024-06-13 02:48:52 +08: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
ruby-version: move to Library/Homebrew.
2024-06-06 19:13:35 +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
bin/brew: fix tracking of original paths with brew-in-brew calls
2024-06-04 03:47:31 +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
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
diagnostic: fix cask taps doctor output.
2024-06-11 10:23:39 +01:00
download_strategy.rb
brew style --fix
2024-05-23 17:15:43 +01:00
download_strategy.rbi
…
downloadable.rb
Make documentation @api private by default.
2024-04-26 19:04:20 +02:00
env_config.rb
Revert "Revert "Enable HOMEBREW_AUTOREMOVE by autoremove_default""
2024-05-26 15:39:45 +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: add exemption for nghttp2
2024-05-29 16:31:59 +08: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
SBOM: more fixes.
2024-05-13 07:36:51 +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
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
Merge pull request #17385 from pe/migrations-broken
2024-06-08 19:34:14 -07:00
formulary.rbi
…
Gemfile
dev-cmd/prof: add vernier support.
2024-05-17 23:57:46 +09:00
Gemfile.lock
Merge pull request #17484 from Homebrew/dependabot/bundler/Library/Homebrew/parser-3.3.3.0
2024-06-13 02:48:52 +08:00
git_repository.rb
Use repository consistently instead of repo
2024-06-10 09:31:53 +01:00
github_packages.rb
Homebrew 4.3.0 deprecation/disable/removals.
2024-05-07 12:18:04 +01: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
Explicitly mark non-private APIs.
2024-04-22 21:16:49 +02: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
Port Homebrew::Cmd::Postinstall
2024-04-01 09:59:47 -07: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
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
Make documentation @api private by default.
2024-04-26 19:04:20 +02: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
Fix/reenable brew style docs
2024-06-13 12:31:47 +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!