admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Issy Long 32e7268596
rubocop: Only enable Style/Documentation for @api public code 
- Suggested in https://github.com/Homebrew/brew/pull/14709#issuecomment-1437461642.
- Found the public API paths with `git grep -l "@api public"`.
2023-02-28 00:10:06 +00:00
..
.bundle
Don't force Ruby platform.
2023-02-08 10:03:45 +01:00
api
Checksum Ruby source file downloads
2023-02-22 22:50:24 +00:00
cask
Merge pull request #14808 from dduugg/audit-types
2023-02-27 13:33:05 +00:00
cli
dev-cmd/contributions: Stats for all maintainers
2023-02-22 16:05:58 +00:00
cmd
Move HOMEBREW_NO_INSTALL_FROM_API defaults to shell
2023-02-24 21:53:08 +00:00
compat
…
completions
Handle undeclared POSIXLY_CORRECT in Bash completions
2023-02-20 18:36:59 -05:00
data/spdx
spdx: update license data.
2023-02-19 00:13:29 +00:00
debrew
…
dev-cmd
Merge pull request #14821 from issyl0/support-date-ranges-in-pr-reviews-query
2023-02-28 00:06:41 +00:00
extend
Isolate Kernel extensions
2023-02-27 11:22:10 -08:00
language
python: reinstate pip's --no-binary
2022-12-19 23:25:53 -08:00
livecheck
Merge pull request #14785 from samford/livecheck/add-json-strategy
2023-02-24 18:02:40 +00:00
manpages
docs: add missing template file edits
2023-02-19 16:22:39 -05:00
os
os/linux.rb: wsl_version: apply suggestions from code review
2023-02-27 16:56:28 +00:00
requirements
Move HOMEBREW_NO_INSTALL_FROM_API defaults to shell
2023-02-24 21:53:08 +00:00
rubocops
Consolidate some rubocop configurations
2023-02-21 16:50:29 -08:00
shims
shims/super/cc: unset RUBYLIB
2022-11-30 03:50:38 +00:00
sorbet
Merge pull request #14806 from Homebrew/dependabot/bundler/Library/Homebrew/concurrent-ruby-1.2.1
2023-02-27 12:45:49 +00:00
standalone
Remove sitedir from LOAD_PATH
2022-10-24 19:42:49 +01:00
startup
Universally apply Ruby disable options
2022-11-05 01:58:12 +00:00
test
Move tests too
2023-02-27 11:22:23 -08:00
unpack_strategy
Add signatures for extraction functions.
2023-02-22 22:15:53 +01:00
utils
Merge pull request #14821 from issyl0/support-date-ranges-in-pr-reviews-query
2023-02-28 00:06:41 +00:00
vendor
brew vendor-gems: commit updates.
2023-02-24 19:00:52 +00:00
version
version/null: fix major_minor(_patch) type signature
2022-10-07 19:21:11 +01:00
yard
sorbet: Bump some files from typed: false to typed: true
2022-10-11 01:09:03 +01:00
.parlour
…
.rspec_parallel
workflows/tests: faster, more reliable tests.
2023-02-17 15:26:18 +00:00
.rubocop.yml
rubocop: Only enable Style/Documentation for @api public code
2023-02-28 00:10:06 +00:00
.simplecov
More tweaks to testing output and speed
2023-02-17 16:17:45 +00:00
.yardopts
…
api.rb
api: improve root messaging.
2023-02-23 12:48:18 +00:00
ast_constants.rb
…
brew.rb
api: don't download files as root when Homebrew's not owned by root.
2023-02-23 10:04:50 +00:00
brew.sh
Move HOMEBREW_NO_INSTALL_FROM_API defaults to shell
2023-02-24 21:53:08 +00:00
build_environment.rb
…
build_options.rb
…
build.rb
…
bundle_version.rb
…
cache_store.rb
rubydoc: fixes for output
2022-11-11 16:16:54 -05:00
cask_dependent.rb
…
cask.rb
…
caveats.rb
Allow defining service run command per platform
2023-01-19 11:36:37 +01:00
checksum.rb
…
cleaner.rb
…
cleanup.rb
Remove active_support Time extensions
2023-02-04 13:51:35 -08:00
commands.rb
Set HOMEBREW_NO_INSTALL_FROM_API for certain commands
2023-02-06 16:17:04 +01:00
compilers.rb
…
completions.rb
Bash completions: cache names of 'doctor' checks
2023-02-23 18:36:51 -07:00
completions.rbi
…
context.rb
…
cxxstdlib.rb
…
debrew.rb
…
default_prefix.rb
Move HOMEBREW_NO_INSTALL_FROM_API defaults to shell
2023-02-24 21:53:08 +00:00
dependable.rb
Resolve dependable_spec violation
2023-01-22 17:26:44 -08:00
dependencies_helpers.rb
…
dependencies_helpers.rbi
…
dependencies.rb
…
dependencies.rbi
…
dependency_collector.rb
formulary: support requirements, aliases etc from API
2023-02-14 03:32:56 +00:00
dependency.rb
Resolve dependable_spec violation
2023-01-22 17:26:44 -08:00
deprecate_disable.rb
…
description_cache_store.rb
description*: fix argument handling of eval_all.
2022-12-08 09:57:12 +00:00
descriptions.rb
Stop including/extending search.rb
2022-12-17 11:08:13 -08:00
development_tools.rb
tests: test on Ubuntu 18.04.
2022-11-09 14:45:43 +00:00
diagnostic.rb
Move HOMEBREW_NO_INSTALL_FROM_API defaults to shell
2023-02-24 21:53:08 +00:00
download_strategy.rb
Add signatures for extraction functions.
2023-02-22 22:15:53 +01:00
env_config.rb
Move HOMEBREW_NO_INSTALL_FROM_API defaults to shell
2023-02-24 21:53:08 +00:00
env_config.rbi
Enabling typing in Homebrew::API module
2023-02-13 21:33:04 -08:00
exceptions.rb
internal messaging fixes
2023-02-10 23:17:16 -05:00
fetch.rb
…
formula_assertions.rb
…
formula_auditor.rb
Disallow references to PRs that are closed but not merged
2023-02-15 16:18:48 +08:00
formula_cellar_checks.rb
Harden plist parsing
2023-02-22 22:52:06 +00:00
formula_creator.rb
formula_creator: use tool-agnostic meson commands
2022-12-08 10:10:36 -08:00
formula_free_port.rb
…
formula_info.rb
…
formula_installer.rb
Checksum Ruby source file downloads
2023-02-22 22:50:24 +00:00
formula_path.sh
Add shell optimisation for --cellar
2023-02-19 05:38:16 +00:00
formula_pin.rb
…
formula_support.rb
…
formula_text_auditor.rb
rubocop: check for closed issues in comments
2023-02-08 09:30:07 +01:00
formula_versions.rb
…
formula.rb
Move HOMEBREW_NO_INSTALL_FROM_API defaults to shell
2023-02-24 21:53:08 +00:00
formula.rbi
Checksum Ruby source file downloads
2023-02-22 22:50:24 +00:00
formulary.rb
Move HOMEBREW_NO_INSTALL_FROM_API defaults to shell
2023-02-24 21:53:08 +00:00
Gemfile
Stop including *flight block source in cask API
2023-02-13 21:22:18 -08:00
Gemfile.lock
build(deps): bump concurrent-ruby in /Library/Homebrew
2023-02-24 18:57:22 +00:00
github_packages.rb
github_packages: improve schema debugging.
2023-02-10 09:05:10 +00:00
github_releases.rb
…
global.rb
Move HOMEBREW_NO_INSTALL_FROM_API defaults to shell
2023-02-24 21:53:08 +00:00
global.rbi
…
hardware.rb
dev-cmd/unbottled: simulate target tag
2022-11-16 00:07:31 +00:00
help.rb
…
help.rbi
…
ignorable.rb
brew style --fix
2023-01-02 19:18:51 +00:00
install_renamed.rb
…
install.rb
Better support source builds under API mode
2023-02-06 13:27:36 +00:00
install.rbi
…
installed_dependents.rb
…
items.sh
items.sh: return early when no Taps directory
2022-12-19 09:28:12 -08:00
keg_relocate.rb
…
keg.rb
add linux's binary_executable_or_library_files to keg
2023-01-26 21:41:45 +09:00
lazy_object.rb
rubocop: In-line disables of Naming/MemoizedInstanceVariableName
2023-02-19 16:33:21 +00:00
linkage_cache_store.rb
…
linkage_checker.rb
…
linuxbrew-core-migration.rb
minor typo fixes
2022-11-06 22:50:07 -05:00
livecheck.rb
Extract latest_version string to a constant
2022-12-19 18:15:51 -05:00
locale.rb
…
lock_file.rb
…
macos_versions.rb
…
manpages.rb
update-maintainers/manpages: not all PLC are maintainers.
2023-02-02 17:09:25 +00:00
manpages.rbi
add manpage.rb to generating homebrew manual
2022-11-08 20:33:30 +09:00
messages.rb
…
metafiles.rb
…
migrator.rb
…
missing_formula.rb
Only optimize for the core tap
2022-11-17 21:15:43 -08:00
mktemp.rb
…
official_taps.rb
…
options.rb
Options: Add #to_s method
2023-01-19 12:40:50 -05:00
os.rb
Use 'wslview' instead of 'xdg-open' on Windows
2023-02-27 14:39:56 +00:00
patch.rb
internal messaging fixes
2023-02-10 23:17:16 -05:00
PATH.rb
minor typo fixes
2022-11-06 22:50:07 -05:00
pkg_version.rb
…
postinstall.rb
…
readall.rb
readall: reject casks with no URL
2023-02-24 18:07:19 +00:00
README.md
…
reinstall.rb
…
requirement.rb
Resolve dependable_spec violation
2023-01-22 17:26:44 -08:00
requirements.rb
…
resource_auditor.rb
ResourceAuditor: Fix #audit_head_branch error
2022-10-17 13:28:20 -04:00
resource.rb
internal messaging fixes
2023-02-10 23:17:16 -05:00
rubocops.rb
…
sandbox.rb
brew style --fix
2022-12-13 11:37:06 +00:00
search.rb
Move HOMEBREW_NO_INSTALL_FROM_API defaults to shell
2023-02-24 21:53:08 +00:00
searchable.rb
…
service.rb
Allow defining service run command per platform
2023-01-19 11:36:37 +01:00
service.rbi
Allow defining service run command per platform
2023-01-19 11:36:37 +01:00
settings.rb
…
settings.rbi
…
simulate_system.rb
Move SimulateSystem check to extend/os
2022-11-29 23:13:50 -08:00
software_spec.rb
Preliminary compatibility fixes for Ruby 3
2022-10-11 02:53:27 +01:00
standalone.rb
…
startup.rb
…
style.rb
Consolidate some rubocop configurations
2023-02-21 16:50:29 -08:00
system_command.rb
Harden plist parsing
2023-02-22 22:52:06 +00:00
system_config.rb
Fix references to formula.json and cask.json
2023-02-24 16:46:15 +00:00
tab.rb
…
tap_auditor.rb
…
tap_constants.rb
Load cask from API with fullname
2023-01-31 19:39:10 -08:00
tap.rb
Move HOMEBREW_NO_INSTALL_FROM_API defaults to shell
2023-02-24 21:53:08 +00:00
test.rb
…
uninstall.rb
…
uninstall.rbi
…
unlink.rb
…
unpack_strategy.rb
Only make directories writable when extracting.
2023-02-24 12:28:05 +01:00
unpack_strategy.rbi
…
unversioned_cask_checker.rb
Look for all packages if specified packages are not found.
2023-02-21 14:06:33 +01:00
upgrade.rb
Enable typing in Homebrew::Upgrade
2023-02-15 14:24:58 +00:00
upgrade.rbi
Enable typing in Homebrew::Upgrade
2023-02-15 14:24:58 +00:00
utils.rb
Isolate Kernel extensions
2023-02-27 11:22:10 -08:00
version.rb
version: fix bad regexps in version parsers
2023-02-01 10:48:45 +08:00
version.rbi
…
warnings.rb
…
warnings.rbi
…

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!