admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Claudia b36fd8ebd9 Fix brew audit Formula/formula.rb 
Fix a regression introduced in PR #8542, which wouldn’t exclude
formulae and casks from stricter style checks properly unless tapped.
This caused `brew audit Formula/formula.rb` to report violations which
were not meant for formulae and casks.

The fix is to add Exclude patterns for formulae and casks in any
`git clone`d tap’s working tree.

Working outside of the productive Homebrew installation makes sure that
the latter doesn’t interfere with development, and vice versa.
It also helps track work in progress, especially if one tends to forget
things.
2020-11-16 20:01:48 +01:00
..
.bundle
…
cask
manpage: fixes for grammar
2020-11-16 07:56:50 -05:00
cli
manpage: fixes for grammar
2020-11-16 07:56:50 -05:00
cmd
manpage: fixes for formatting
2020-11-16 08:02:50 -05:00
compat
Completely deprecate Homebrew.args.
2020-11-11 08:52:55 +01:00
data/spdx
…
debrew
…
dev-cmd
Merge pull request #9136 from EricFromCanada/man-page-formatting
2020-11-16 14:39:47 +00:00
extend
format note comments
2020-11-16 02:02:52 +01:00
language
Add more type signatures.
2020-11-13 12:26:36 +01:00
livecheck
livecheck: skip disabled formulae
2020-11-11 17:03:51 -05:00
manpages
manpage: fixes for formatting
2020-11-16 08:02:50 -05:00
os
Merge pull request #9054 from fxcoudert/bigsur
2020-11-16 12:22:34 +00:00
requirements
Add more type signatures.
2020-11-13 12:26:36 +01:00
rubocops
Fix RuboCop offenses.
2020-11-16 02:05:29 +01:00
shims
apidoc: update comment wording, punctuation, formatting
2020-11-06 00:21:02 -05:00
sorbet
Handle macOS Homebrew on ARM
2020-11-12 17:06:47 +00:00
test
Fix brew audit Formula/formula.rb
2020-11-16 20:01:48 +01:00
unpack_strategy
Add more type signatures.
2020-11-13 12:26:36 +01:00
utils
pr-pull: skip bottles for CI-syntax-only PRs
2020-11-14 02:52:43 -05:00
vendor
brew vendor-gems: commit updates.
2020-11-16 02:03:45 +01:00
version
Add more type signatures.
2020-11-13 12:26:36 +01:00
.rubocop_todo.yml
Handle macOS Homebrew on ARM
2020-11-12 17:06:47 +00:00
.rubocop.yml
…
.simplecov
…
bintray.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
brew.rb
docs - remove Discourse from communication methods
2020-11-15 13:20:03 -05:00
brew.sh
…
build_environment.rb
…
build_options.rb
apidoc: update examples' syntax
2020-11-05 23:50:55 -05:00
build.rb
Fix RuboCop offenses.
2020-11-16 02:05:29 +01:00
cache_store.rb
apidoc: update comment wording, punctuation, formatting
2020-11-06 00:21:02 -05:00
cask_dependent.rb
apidoc: update comment wording, punctuation, formatting
2020-11-06 00:21:02 -05:00
cask.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
caveats.rb
…
checksum.rb
…
cleaner.rb
Fix RuboCop offenses.
2020-11-16 02:05:29 +01:00
cleanup.rb
cleanup.rb: ensure cache exists before touching .cleaned
2020-11-14 10:48:10 -05:00
commands.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
compat.rb
Completely deprecate Homebrew.args.
2020-11-11 08:52:55 +01:00
compilers.rb
apidoc: update comment wording, punctuation, formatting
2020-11-06 00:21:02 -05:00
config.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
context.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
cxxstdlib.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
debrew.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
dependable.rb
apidoc: update comment wording, punctuation, formatting
2020-11-06 00:21:02 -05:00
dependable.rbi
…
dependencies_helpers.rb
…
dependencies_helpers.rbi
…
dependencies.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
dependency_collector.rb
fix Lint/DuplicateBranch style
2020-11-16 02:02:52 +01:00
dependency.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
deprecate_disable.rb
apidoc: update comment wording, punctuation, formatting
2020-11-06 00:21:02 -05:00
description_cache_store.rb
apidoc: update comment wording, punctuation, formatting
2020-11-06 00:21:02 -05:00
descriptions.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
development_tools.rb
…
diagnostic.rb
docs - remove Discourse from communication methods
2020-11-15 13:20:03 -05:00
download_strategy.rb
Fix RuboCop offenses.
2020-11-16 02:05:29 +01:00
env_config.rb
manpage: fixes for formatting
2020-11-16 08:02:50 -05:00
exceptions.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
fetch.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
formula_assertions.rb
apidoc: update comment wording, punctuation, formatting
2020-11-06 00:21:02 -05:00
formula_cellar_checks.rb
audit: allow python symlinks based on keg-only status
2020-10-20 12:46:23 -04:00
formula_creator.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
formula_free_port.rb
…
formula_info.rb
apidoc: update comment wording, punctuation, formatting
2020-11-06 00:21:02 -05:00
formula_installer.rb
Fix RuboCop offenses.
2020-11-16 02:05:29 +01:00
formula_pin.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
formula_support.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
formula_versions.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
formula.rb
Fix RuboCop offenses.
2020-11-16 02:05:29 +01:00
formulary.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
Gemfile
…
Gemfile.lock
build(deps): bump rubocop from 1.2.0 to 1.3.0 in /Library/Homebrew
2020-11-16 02:02:52 +01:00
global.rb
Handle macOS Homebrew on ARM
2020-11-12 17:06:47 +00:00
global.rbi
…
hardware.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
help.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
help.rbi
Move include Kernel into .rbi files again and split up existing .rbi files.
2020-10-10 19:10:58 +02:00
install_renamed.rb
…
install.rb
install: add ARM migration instructions.
2020-11-12 19:14:46 +00:00
install.rbi
…
keg_relocate.rb
apidoc: update comment wording, punctuation, formatting
2020-11-06 00:21:02 -05:00
keg.rb
Fix RuboCop offenses.
2020-11-16 02:05:29 +01:00
lazy_object.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
linkage_cache_store.rb
apidoc: update comment wording, punctuation, formatting
2020-11-06 00:21:02 -05:00
linkage_checker.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
livecheck.rb
apidoc: update comment wording, punctuation, formatting
2020-11-06 00:21:02 -05:00
load_path.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
locale.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
lock_file.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
messages.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
metafiles.rb
apidoc: update URLs
2020-11-05 23:50:55 -05:00
migrator.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
missing_formula.rb
Permit installation of googletest
2020-10-19 12:48:43 +01:00
mktemp.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
official_taps.rb
…
options.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
os.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
patch.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
PATH.rb
Fix RuboCop offenses.
2020-11-16 02:05:29 +01:00
pkg_version.rb
…
postinstall.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
readall.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
README.md
apidoc: update URLs
2020-11-05 23:50:55 -05:00
reinstall.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
requirement.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
requirements.rb
…
resource.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
rubocops.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
sandbox.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
search.rb
rubocop: fix Lint/NoReturnInBeginEndBlocks
2020-11-10 23:28:31 +11:00
searchable.rb
…
software_spec.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
style.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
system_command.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
system_config.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
tab.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
tap_constants.rb
apidoc: update comment wording, punctuation, formatting
2020-11-06 00:21:02 -05:00
tap.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
test.rb
Move type annotations into files.
2020-10-10 14:59:39 +02:00
uninstall.rb
fix style issues
2020-11-04 18:53:03 -05:00
uninstall.rbi
fix typecheck
2020-11-05 00:53:12 -05:00
unlink.rb
unlink: unlink only keg-only versioned formulae.
2020-11-16 14:45:15 +00:00
unpack_strategy.rb
Add type signatures for UnpackStrategy::Zip.
2020-10-20 09:50:21 +02:00
unpack_strategy.rbi
Add type signatures for UnpackStrategy::Zip.
2020-10-20 09:50:21 +02:00
upgrade.rb
fix Lint/DuplicateBranch style
2020-11-16 02:02:52 +01:00
utils.rb
Add more type signatures.
2020-11-13 12:26:36 +01:00
version.rb
Fix RuboCop offenses.
2020-11-16 02:05:29 +01:00

README.md

Homebrew's Formula API

This is the public 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!