admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Sam Ford 1d404e437b
dev-cmd/livecheck: avoid watchlist in test 
The existing watchlist test in `dev-cmd/livecheck_spec.rb` will only
pass if the testing environment doesn't contain a livecheck watchlist
file. When a watchlist file is present, it ends up being treated as
empty (formulae and casks aren't available in tests) and produces an
`Invalid usage: No formulae or casks to check` error instead. We don't
have to worry about a watchlist file on CI but it's a potential issue
when running `brew test` locally.

This provides a bogus `HOMEBREW_LIVECHECK_WATCHLIST` value to the
`#brew` call, to ensure that any watchlist file in the testing
environment is not used for this test.

Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2023-08-16 15:08:34 -04:00
..
.bundle
…
api
Download tap_migrations.json files from the API
2023-07-05 17:18:12 +01:00
cask
Turn up the types
2023-08-12 22:01:22 -07:00
cli
Various sharding fixes
2023-08-04 16:43:13 +01:00
cmd
cmd/update-report: improve tap/untap behaviour.
2023-08-16 14:06:26 +01:00
completions
completions/fish: fix cask references for Linux
2023-04-19 13:03:56 +02:00
data/spdx
spdx: update license data.
2023-06-19 00:12:59 +00:00
debrew
…
dev-cmd
dev-cmd/tests: add --fail-fast.
2023-08-10 16:27:37 +01:00
extend
Turn up the types
2023-08-12 22:01:22 -07:00
language
python: refactor to align Shebang modules
2023-08-15 00:53:41 -04:00
livecheck
Livecheck: allow quiet output with --newer-only
2023-08-15 17:43:36 -07:00
manpages
Formula-Cookbook: expand terminology table
2023-08-12 21:48:16 -04:00
os
os/mac/mach: fix rpath deletion of fat machos
2023-08-14 14:29:05 +08:00
requirements
Deprecate/disable/delete code.
2023-07-06 16:56:20 +01:00
rubocops
formula_cop: fix style_exceptions_dir handling.
2023-08-09 15:20:57 +01:00
shims
shims/mac/super/make: use standard exec routines
2023-07-12 23:21:00 +01:00
sorbet
sorbet: Update RBI files.
2023-08-16 00:25:52 +00:00
standalone
…
startup
dev-cmd/update-maintainers: write JSON of maintainers
2023-05-29 21:30:47 +08:00
test
dev-cmd/livecheck: avoid watchlist in test
2023-08-16 15:08:34 -04:00
unpack_strategy
unpack_strategy/zip: avoid loading formulae unnecessarily
2023-05-31 00:06:55 +08:00
utils
utils/gems: update to Bundler 2.4
2023-08-16 01:34:16 +01:00
vendor
brew vendor-gems: commit updates.
2023-08-16 01:34:19 +01:00
version
Merge HeadVersion and NullVersion into Version.
2023-05-09 01:13:54 +02:00
yard
…
.parlour
…
.rspec_parallel
…
.rubocop.yml
Finish renaming GithubRelease to GithubReleases
2023-05-16 16:08:18 -04:00
.simplecov
…
.yardopts
…
api.rb
Download tap_migrations.json files from the API
2023-07-05 17:18:12 +01:00
ast_constants.rb
Turn up the types
2023-08-12 22:01:22 -07:00
brew_irbrc
…
brew.rb
…
brew.sh
brew.sh: fix shellcheck warning.
2023-08-16 12:01:25 +01:00
build_environment.rb
brew style --fix
2023-04-24 20:42:39 -07:00
build_options.rb
…
build.rb
build: don't add implicit dependencies to build environment
2023-07-04 13:40:59 +01:00
bump_version_parser.rb
rename class and reorganize files
2023-07-25 06:41:38 -04:00
bundle_version.rb
Fix BundleVersion comparison.
2023-05-16 14:23:15 +02:00
cache_store.rb
…
cask_dependent.rb
…
cask.rb
Implement cask renames.
2023-05-12 21:17:30 +02:00
caveats.rb
service: add custom service name DSL
2023-05-13 14:53:01 -07:00
checksum.rb
…
cleaner.rb
…
cleanup.rb
cleanup: handle GitHub Actions artifacts
2023-05-17 21:11:16 +08:00
commands.rb
post_install: improvements and fixes.
2023-07-28 11:26:09 +01:00
compilers.rb
brew style --fix
2023-04-24 20:42:39 -07:00
completions.rb
brew style --fix
2023-04-24 20:42:39 -07:00
context.rb
…
cxxstdlib.rb
brew style --fix
2023-04-24 20:42:39 -07:00
debrew.rb
brew style --fix
2023-04-24 20:42:39 -07:00
default_prefix.rb
Turn up the types
2023-08-12 22:01:22 -07:00
dependable.rb
Introduce tag for implicit dependencies
2023-07-04 13:40:58 +01:00
dependencies_helpers.rb
Remove TapDependency
2023-07-04 13:31:58 +01:00
dependencies_helpers.rbi
…
dependencies.rb
Introduce UsesFromMacOSDependency
2023-07-04 13:40:55 +01:00
dependencies.rbi
…
dependency_collector.rb
Introduce tag for implicit dependencies
2023-07-04 13:40:58 +01:00
dependency.rb
various: fix miscellaneous typos
2023-07-18 08:52:49 -07:00
deprecate_disable.rb
…
description_cache_store.rb
…
descriptions.rb
…
development_tools.rb
development_tools: allow Symbols to be located
2023-08-04 11:26:30 +08:00
diagnostic.rb
diagnostic: don't complain about missing homebrew/cask.
2023-07-18 10:31:51 +01:00
download_strategy.rb
Deprecate/disable/delete code.
2023-07-06 16:56:20 +01:00
download_strategy.rbi
…
downloadable.rb
Fix DownloadError erroring itself
2023-05-02 02:09:53 +01:00
env_config.rb
Merge pull request #15868 from MikeMcQuaid/more_install_from_api_again
2023-08-15 14:27:06 +01:00
env_config.rbi
Allow HOMEBREW_CURLRC to provide a path for curl --config
2023-08-15 11:29:02 +01:00
exceptions.rb
dev-cmd/edit: suggest tapping core repositories
2023-08-01 13:39:28 -04:00
exceptions.rbi
…
fetch.rb
Fix tests on generic OS.
2023-05-17 15:26:46 +02:00
formula_assertions.rb
…
formula_assertions.rbi
…
formula_auditor.rb
formula_{auditor,versions}: handle sharding.
2023-08-14 19:31:15 +01:00
formula_cellar_checks.rb
Make more warnings quiet with environment hints disabled.
2023-08-04 09:36:27 +01:00
formula_cellar_checks.rbi
…
formula_creator.rb
Various sharding fixes
2023-08-04 16:43:13 +01:00
formula_free_port.rb
Turn up the types
2023-08-12 22:01:22 -07:00
formula_info.rb
Deprecate/disable/delete code.
2023-07-06 16:56:20 +01:00
formula_installer.rb
formula_installer: improve a comment.
2023-08-15 14:44:35 +01:00
formula_path.sh
Various sharding fixes
2023-08-04 16:43:13 +01:00
formula_pin.rb
…
formula_support.rb
brew style --fix
2023-04-24 20:42:39 -07:00
formula_text_auditor.rb
…
formula_versions.rb
formula_{auditor,versions}: handle sharding.
2023-08-14 19:31:15 +01:00
formula.rb
Merge pull request #15824 from dduugg/inreplace-static
2023-08-08 12:32:10 +01:00
formula.rbi
Remove methods from formula.rbi.
2023-05-20 19:28:29 +02:00
formulary.rb
Various sharding fixes
2023-08-04 16:43:13 +01:00
formulary.rbi
…
Gemfile
Vendor mechanize gem outside Gemfile
2023-04-24 14:03:55 +01:00
Gemfile.lock
brew vendor-gems: commit updates.
2023-08-16 01:34:19 +01:00
git_repository.rb
brew style --fix
2023-04-24 20:42:39 -07:00
github_packages.rb
github_packages: abort with an error if image index is >= 4MB
2023-07-28 00:43:57 +01:00
github_releases.rb
brew style --fix
2023-04-24 20:42:39 -07:00
github_runner_matrix.rb
github_runner_matrix: remove GITHUB_RUN_ATTEMPT
2023-05-29 22:36:00 +08:00
github_runner.rb
Rename OS::Mac::Version to MacOSVersion.
2023-05-09 05:08:38 +02:00
global.rb
Use HOMEBREW_CELLAR_PLACEHOLDER
2023-07-18 10:59:27 +01:00
global.rbi
…
hardware.rb
Wording
2023-06-24 11:09:28 +01:00
help.rb
Refactor module_function to reduce rbi need
2023-04-17 10:37:59 -07:00
ignorable.rb
…
ignorable.rbi
…
install_renamed.rb
…
install.rb
Support multiple oldnames for formulae
2023-04-27 05:15:43 +01:00
installed_dependents.rb
brew style --fix
2023-04-24 20:42:39 -07:00
items.sh
items.sh: use regex for find_exclude_filter
2023-05-25 01:49:25 -07:00
keg_relocate.rb
keg_relocate: fix all text files being marked as changed
2023-07-28 00:43:30 +01:00
keg.rb
Support multiple oldnames for formulae
2023-04-27 05:15:43 +01:00
lazy_object.rb
…
linkage_cache_store.rb
…
linkage_checker.rb
Merge pull request #15571 from gerlero/relocate-relative-names
2023-07-11 04:38:26 +08:00
linux_runner_spec.rb
brew style --fix
2023-04-24 20:42:39 -07:00
linuxbrew-core-migration.rb
…
livecheck.rb
Type livecheck.rb.
2023-05-06 03:27:42 +02:00
locale.rb
brew style --fix
2023-04-24 20:42:39 -07:00
lock_file.rb
…
macos_runner_spec.rb
Merge pull request #15309 from carlocab/longer-big-sur-timeout
2023-04-25 17:52:51 +08:00
macos_version.rb
Deprecate/disable/delete code.
2023-07-06 16:56:20 +01:00
macos_version.rbi
Deprecate/disable/delete code.
2023-07-06 16:56:20 +01:00
manpages.rb
brew style --fix
2023-04-24 20:42:39 -07:00
messages.rb
brew style --fix
2023-04-24 20:42:39 -07:00
metafiles.rb
…
migrator.rb
Implement cask renames.
2023-05-12 21:17:30 +02:00
missing_formula.rb
…
mktemp.rb
brew style --fix
2023-04-24 20:42:39 -07:00
official_taps.rb
homebrew-cask-drivers: deprecate official tap
2023-06-08 08:12:59 -04:00
options.rb
brew style --fix
2023-04-24 20:42:39 -07:00
options.rbi
…
os.rb
Rename OS::Mac::Version to MacOSVersion.
2023-05-09 05:08:38 +02:00
patch.rb
Refactor formula, cask and Ruby source downloads to use shared code
2023-04-27 23:23:07 +01:00
PATH.rb
brew style --fix
2023-04-24 20:42:39 -07:00
pkg_version.rb
Deprecate/disable/delete code.
2023-07-06 16:56:20 +01:00
pkg_version.rbi
…
postinstall.rb
…
readall.rb
Various sharding fixes
2023-08-04 16:43:13 +01:00
README.md
…
reinstall.rb
…
requirement.rb
various: fix miscellaneous typos
2023-07-18 08:52:49 -07:00
requirements.rb
…
resource_auditor.rb
Disable false positive
2023-04-25 09:26:24 -07:00
resource.rb
Fix type errors.
2023-05-09 01:13:55 +02:00
rubocops.rb
Include T::Sig in Module
2023-04-24 20:42:38 -07:00
sandbox.rb
brew style --fix
2023-04-24 20:42:39 -07:00
search.rb
Refactor module_function to reduce rbi need
2023-04-17 10:37:59 -07:00
service.rb
service: handle quoting in service file, too.
2023-08-16 13:58:03 +01:00
service.rbi
…
settings.rb
Refactor module_function to reduce rbi need
2023-04-17 10:37:59 -07:00
simulate_system.rb
various: fix miscellaneous typos
2023-07-18 08:52:49 -07:00
software_spec.rb
Deprecate/disable/delete code.
2023-07-06 16:56:20 +01:00
source_location.rb
Turn up the types
2023-08-12 22:01:22 -07:00
standalone.rb
…
startup.rb
…
style.rb
Add cask URL location to audit problems.
2023-05-21 16:17:16 +02:00
system_command.rb
sudo: change sudo_user to sudo_as_root.
2023-04-28 11:22:54 -07:00
system_config.rb
brew style --fix
2023-04-24 20:42:39 -07:00
tab.rb
tab: fix typing of versions
2023-05-11 12:33:27 +01:00
tap_auditor.rb
tap_auditor: fix API data getting mixed in
2023-07-04 16:08:53 +01:00
tap_constants.rb
Turn up the types
2023-08-12 22:01:22 -07:00
tap.rb
Fix cask sharding issues
2023-08-10 16:08:47 +01:00
test_runner_formula.rb
Add SimulateSystem::with.
2023-05-14 01:45:04 +02:00
test.rb
…
uninstall.rb
Refactor module_function to reduce rbi need
2023-04-17 10:37:59 -07:00
unlink.rb
…
unpack_strategy.rb
brew style --fix
2023-04-24 20:42:39 -07:00
unpack_strategy.rbi
…
unversioned_cask_checker.rb
unversioned_cask_checker.rb - fix signature of KeyboardLayout
2023-08-06 21:30:45 +02:00
upgrade.rb
Make more warnings quiet with environment hints disabled.
2023-08-04 09:36:27 +01:00
upgrade.rbi
…
url.rb
Refactor formula, cask and Ruby source downloads to use shared code
2023-04-27 23:23:07 +01:00
utils.rb
brew style --fix
2023-04-24 20:42:39 -07:00
version.rb
Fix type errors when HOMEBREW_SORBET_RUNTIME=1
2023-07-18 10:22:51 -07:00
version.rbi
…
warnings.rb
Refactor module_function to reduce rbi need
2023-04-17 10:37:59 -07: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!