diff --git a/README.md b/README.md index a6ef069..40bb947 100644 --- a/README.md +++ b/README.md @@ -75,16 +75,21 @@ brewshelf Unknown packages (not in the built-in catalog) appear under **Other / Dependencies**. -## Adding descriptions +## Descriptions -The package catalog lives in `brewshelf.sh` inside the `init_data()` function. Adding a new entry is one line: +Every description comes from Homebrew itself (`brew info --json=v2 --installed`), so all packages +are described — including the ones brewshelf has no category for. Packages from +[untrusted taps](https://docs.brew.sh/Taps) are still listed, just without a description. + +## Adding categories + +Categories live in `brewshelf.sh` inside the `init_data()` function. Adding a package is one line: ```bash PKG_CAT[package-name]="Category Name" -PKG_DESC[package-name]="What it does" ``` -PRs for missing packages are welcome. +PRs for uncategorized packages are welcome. ## License diff --git a/brewshelf.sh b/brewshelf.sh index b647d49..ac0a032 100755 --- a/brewshelf.sh +++ b/brewshelf.sh @@ -24,183 +24,226 @@ BLUE=$'\e[34m' RED=$'\e[31m' WHITE=$'\e[37m' +# Category of each known formula. Descriptions come from Homebrew itself (load_descriptions). typeset -gA PKG_CAT -typeset -gA PKG_DESC +typeset -gA FORMULA_DESC CASK_DESC + +# Reads the descriptions of all installed packages from `brew info --json=v2 --installed` +# and prints them as "formula|cask name description" lines. +# Uses jq when available (bundled with macOS 15+), otherwise JavaScript via osascript, +# which every macOS has. BREWSHELF_JSON_PARSER=jq|osascript forces one (used by the tests). +json_to_rows() { + local parser=${BREWSHELF_JSON_PARSER:-} + if [[ -z "$parser" ]]; then + if command -v jq >/dev/null 2>&1; then parser=jq; else parser=osascript; fi + fi + + if [[ "$parser" == jq ]]; then + jq -r ' + def clean: (. // "") | gsub("[\t\n\r]+"; " "); + (.formulae[]? | ["formula", .name, (.desc | clean)]), + (.casks[]? | ["cask", .token, (.desc | clean)]) + | join("\t")' + else + osascript -l JavaScript -e ' + ObjC.import("Foundation"); + const data = $.NSFileHandle.fileHandleWithStandardInput.readDataToEndOfFile; + const info = JSON.parse($.NSString.alloc.initWithDataEncoding(data, $.NSUTF8StringEncoding).js); + const clean = (s) => (s || "").replace(/[\t\n\r]+/g, " "); + [ + ...(info.formulae || []).map((f) => ["formula", f.name, clean(f.desc)].join("\t")), + ...(info.casks || []).map((c) => ["cask", c.token, clean(c.desc)].join("\t")), + ].join("\n");' + fi +} + +# Packages from untrusted taps or removed from Homebrew are missing from the JSON; +# they are still listed (from `brew list`), just without a description. +load_descriptions() { + local row kind name desc + for row in ${(f)"$(brew info --json=v2 --installed 2>/dev/null | json_to_rows 2>/dev/null)"}; do + IFS=$'\t' read -r kind name desc <<< "$row" + case "$kind" in + formula) FORMULA_DESC[$name]=$desc ;; + cask) CASK_DESC[$name]=$desc ;; + esac + done +} init_data() { # Video & Media - PKG_CAT[ffmpeg]="Video & Media"; PKG_DESC[ffmpeg]="Swiss-army knife for video/audio processing" - PKG_CAT[aom]="Video & Media"; PKG_DESC[aom]="AV1 video codec library" - PKG_CAT[dav1d]="Video & Media"; PKG_DESC[dav1d]="Fast AV1 decoder" - PKG_CAT[rav1e]="Video & Media"; PKG_DESC[rav1e]="Fast AV1 encoder" - PKG_CAT[svt-av1]="Video & Media"; PKG_DESC[svt-av1]="Scalable AV1 encoder by Intel" - PKG_CAT[libvpx]="Video & Media"; PKG_DESC[libvpx]="VP8/VP9 codec" - PKG_CAT[libvorbis]="Video & Media"; PKG_DESC[libvorbis]="Ogg Vorbis audio codec" - PKG_CAT[libvmaf]="Video & Media"; PKG_DESC[libvmaf]="Netflix video quality metric" - PKG_CAT[libvidstab]="Video & Media"; PKG_DESC[libvidstab]="Video stabilization library" - PKG_CAT[x264]="Video & Media"; PKG_DESC[x264]="H.264 video encoder" - PKG_CAT[x265]="Video & Media"; PKG_DESC[x265]="H.265/HEVC video encoder" - PKG_CAT[xvid]="Video & Media"; PKG_DESC[xvid]="MPEG-4 video codec" - PKG_CAT[opus]="Video & Media"; PKG_DESC[opus]="Modern audio codec" - PKG_CAT[lame]="Video & Media"; PKG_DESC[lame]="MP3 audio encoder" - PKG_CAT[flac]="Video & Media"; PKG_DESC[flac]="Lossless audio codec" - PKG_CAT[theora]="Video & Media"; PKG_DESC[theora]="Ogg Theora video codec" - PKG_CAT[speex]="Video & Media"; PKG_DESC[speex]="Speech audio codec" - PKG_CAT[mpg123]="Video & Media"; PKG_DESC[mpg123]="MPEG audio player/decoder" - PKG_CAT[opencore-amr]="Video & Media"; PKG_DESC[opencore-amr]="AMR audio codec (mobile standard)" - PKG_CAT[libsamplerate]="Video & Media"; PKG_DESC[libsamplerate]="Audio sample rate converter" - PKG_CAT[libsndfile]="Video & Media"; PKG_DESC[libsndfile]="Audio file read/write library" - PKG_CAT[rubberband]="Video & Media"; PKG_DESC[rubberband]="Audio time-stretch and pitch-shift" - PKG_CAT[sdl2]="Video & Media"; PKG_DESC[sdl2]="Cross-platform multimedia library" - PKG_CAT[frei0r]="Video & Media"; PKG_DESC[frei0r]="Minimalist video plugin API" - PKG_CAT[libbluray]="Video & Media"; PKG_DESC[libbluray]="Blu-ray disc playback library" - PKG_CAT[libudfread]="Video & Media"; PKG_DESC[libudfread]="UDF filesystem reading (optical discs)" - PKG_CAT[aribb24]="Video & Media"; PKG_DESC[aribb24]="ARIB STD-B24 subtitles (Japanese broadcast)" - PKG_CAT[libass]="Video & Media"; PKG_DESC[libass]="Subtitle renderer for ASS/SSA format" - PKG_CAT[libunibreak]="Video & Media"; PKG_DESC[libunibreak]="Unicode line/word breaking library" - PKG_CAT[zimg]="Video & Media"; PKG_DESC[zimg]="Image scaling and colorspace library" - PKG_CAT[librist]="Video & Media"; PKG_DESC[librist]="Reliable Internet Stream Transport" - PKG_CAT[srt]="Video & Media"; PKG_DESC[srt]="Secure Reliable Transport streaming protocol" - PKG_CAT[libssh]="Video & Media"; PKG_DESC[libssh]="SSH/SFTP library (used by FFmpeg)" - PKG_CAT[libogg]="Video & Media"; PKG_DESC[libogg]="Ogg container format library" - PKG_CAT[libsoxr]="Video & Media"; PKG_DESC[libsoxr]="High quality audio resampler" - PKG_CAT[camsnap]="Video & Media"; PKG_DESC[camsnap]="Grab frames, clips, or motion alerts from RTSP/ONVIF cams" - PKG_CAT[gifgrep]="Video & Media"; PKG_DESC[gifgrep]="Grep the GIF. Stick the landing" - PKG_CAT[songsee]="Video & Media"; PKG_DESC[songsee]="Spectral visualization CLI for audio files" - PKG_CAT[sag]="Video & Media"; PKG_DESC[sag]="Command-line ElevenLabs TTS with mac-style flags" + PKG_CAT[ffmpeg]="Video & Media" + PKG_CAT[aom]="Video & Media" + PKG_CAT[dav1d]="Video & Media" + PKG_CAT[rav1e]="Video & Media" + PKG_CAT[svt-av1]="Video & Media" + PKG_CAT[libvpx]="Video & Media" + PKG_CAT[libvorbis]="Video & Media" + PKG_CAT[libvmaf]="Video & Media" + PKG_CAT[libvidstab]="Video & Media" + PKG_CAT[x264]="Video & Media" + PKG_CAT[x265]="Video & Media" + PKG_CAT[xvid]="Video & Media" + PKG_CAT[opus]="Video & Media" + PKG_CAT[lame]="Video & Media" + PKG_CAT[flac]="Video & Media" + PKG_CAT[theora]="Video & Media" + PKG_CAT[speex]="Video & Media" + PKG_CAT[mpg123]="Video & Media" + PKG_CAT[opencore-amr]="Video & Media" + PKG_CAT[libsamplerate]="Video & Media" + PKG_CAT[libsndfile]="Video & Media" + PKG_CAT[rubberband]="Video & Media" + PKG_CAT[sdl2]="Video & Media" + PKG_CAT[frei0r]="Video & Media" + PKG_CAT[libbluray]="Video & Media" + PKG_CAT[libudfread]="Video & Media" + PKG_CAT[aribb24]="Video & Media" + PKG_CAT[libass]="Video & Media" + PKG_CAT[libunibreak]="Video & Media" + PKG_CAT[zimg]="Video & Media" + PKG_CAT[librist]="Video & Media" + PKG_CAT[srt]="Video & Media" + PKG_CAT[libssh]="Video & Media" + PKG_CAT[libogg]="Video & Media" + PKG_CAT[libsoxr]="Video & Media" + PKG_CAT[camsnap]="Video & Media" + PKG_CAT[gifgrep]="Video & Media" + PKG_CAT[songsee]="Video & Media" + PKG_CAT[sag]="Video & Media" # Development - PKG_CAT[node]="Development"; PKG_DESC[node]="JavaScript runtime (Node.js)" - PKG_CAT[nvm]="Development"; PKG_DESC[nvm]="Node.js version manager" - PKG_CAT[pnpm]="Development"; PKG_DESC[pnpm]="Fast, disk-efficient package manager" - PKG_CAT[python@3.12]="Development"; PKG_DESC[python@3.12]="Python 3.12" - PKG_CAT[python@3.13]="Development"; PKG_DESC[python@3.13]="Python 3.13" - PKG_CAT[python@3.14]="Development"; PKG_DESC[python@3.14]="Python 3.14 (latest)" - PKG_CAT[pipx]="Development"; PKG_DESC[pipx]="Install Python CLI tools in isolated envs" - PKG_CAT[dotnet]="Development"; PKG_DESC[dotnet]="Microsoft .NET SDK/runtime" - PKG_CAT[gh]="Development"; PKG_DESC[gh]="GitHub official CLI" - PKG_CAT[git]="Development"; PKG_DESC[git]="Distributed revision control system" - PKG_CAT[go]="Development"; PKG_DESC[go]="Open source programming language" - PKG_CAT[python@3.11]="Development"; PKG_DESC[python@3.11]="Python 3.11 interpreted programming language" - PKG_CAT[python-tk@3.13]="Development"; PKG_DESC[python-tk@3.13]="Python interface to Tcl/Tk" - PKG_CAT[tcl-tk]="Development"; PKG_DESC[tcl-tk]="Tool Command Language" - PKG_CAT[xcodegen]="Development"; PKG_DESC[xcodegen]="Generate your Xcode project from a spec file" - PKG_CAT[axe]="Development"; PKG_DESC[axe]="CLI tool for interacting with iOS Simulators via accessibility and HID APIs" - PKG_CAT[opencode]="Development"; PKG_DESC[opencode]="AI coding agent, built for the terminal" - PKG_CAT[codex]="Development"; PKG_DESC[codex]="OpenAI's coding agent that runs in your terminal" + PKG_CAT[node]="Development" + PKG_CAT[nvm]="Development" + PKG_CAT[pnpm]="Development" + PKG_CAT[python@3.12]="Development" + PKG_CAT[python@3.13]="Development" + PKG_CAT[python@3.14]="Development" + PKG_CAT[pipx]="Development" + PKG_CAT[dotnet]="Development" + PKG_CAT[gh]="Development" + PKG_CAT[git]="Development" + PKG_CAT[go]="Development" + PKG_CAT[python@3.11]="Development" + PKG_CAT[python-tk@3.13]="Development" + PKG_CAT[tcl-tk]="Development" + PKG_CAT[xcodegen]="Development" + PKG_CAT[axe]="Development" + PKG_CAT[opencode]="Development" + PKG_CAT[codex]="Development" # Database - PKG_CAT[mongodb-community]="Database"; PKG_DESC[mongodb-community]="MongoDB document database" - PKG_CAT[mongodb-database-tools]="Database"; PKG_DESC[mongodb-database-tools]="MongoDB import/export/backup tools" - PKG_CAT[mongodb-atlas-cli]="Database"; PKG_DESC[mongodb-atlas-cli]="MongoDB Atlas cloud management CLI" - PKG_CAT[mongosh]="Database"; PKG_DESC[mongosh]="Modern MongoDB shell" - PKG_CAT[sqlite]="Database"; PKG_DESC[sqlite]="Lightweight embedded SQL database" + PKG_CAT[mongodb-community]="Database" + PKG_CAT[mongodb-database-tools]="Database" + PKG_CAT[mongodb-atlas-cli]="Database" + PKG_CAT[mongosh]="Database" + PKG_CAT[sqlite]="Database" # Security & Network - PKG_CAT[mkcert]="Security & Network"; PKG_DESC[mkcert]="Create locally-trusted SSL certificates" - PKG_CAT[openssl@3]="Security & Network"; PKG_DESC[openssl@3]="TLS/SSL cryptography library" - PKG_CAT[ca-certificates]="Security & Network"; PKG_DESC[ca-certificates]="Root certificate bundle" - PKG_CAT[gnutls]="Security & Network"; PKG_DESC[gnutls]="TLS/SSL alternative to OpenSSL" - PKG_CAT[mbedtls]="Security & Network"; PKG_DESC[mbedtls]="Lightweight TLS library" - PKG_CAT[mbedtls@3]="Security & Network"; PKG_DESC[mbedtls@3]="Lightweight TLS library v3" - PKG_CAT[nettle]="Security & Network"; PKG_DESC[nettle]="Low-level cryptography library" - PKG_CAT[libsodium]="Security & Network"; PKG_DESC[libsodium]="Modern cryptography library" - PKG_CAT[unbound]="Security & Network"; PKG_DESC[unbound]="Validating DNS resolver" - PKG_CAT[p11-kit]="Security & Network"; PKG_DESC[p11-kit]="PKCS#11 module management" - PKG_CAT[libtasn1]="Security & Network"; PKG_DESC[libtasn1]="ASN.1 structure parsing library" - PKG_CAT[libidn2]="Security & Network"; PKG_DESC[libidn2]="Internationalized domain names library" - PKG_CAT[libunistring]="Security & Network"; PKG_DESC[libunistring]="Unicode string handling library" - PKG_CAT[c-ares]="Security & Network"; PKG_DESC[c-ares]="Async DNS resolver library" - PKG_CAT[libevent]="Security & Network"; PKG_DESC[libevent]="Async event notification library" - PKG_CAT[libnghttp2]="Security & Network"; PKG_DESC[libnghttp2]="HTTP/2 library" - PKG_CAT[libnghttp3]="Security & Network"; PKG_DESC[libnghttp3]="HTTP/3 library" - PKG_CAT[libngtcp2]="Security & Network"; PKG_DESC[libngtcp2]="QUIC transport protocol library" - PKG_CAT[cloudflared]="Security & Network"; PKG_DESC[cloudflared]="Cloudflare Tunnel client" - PKG_CAT[mtr]="Security & Network"; PKG_DESC[mtr]="Traceroute and ping in a single tool" - PKG_CAT[sshpass]="Security & Network"; PKG_DESC[sshpass]="Non-interactive SSH password authentication" + PKG_CAT[mkcert]="Security & Network" + PKG_CAT[openssl@3]="Security & Network" + PKG_CAT[ca-certificates]="Security & Network" + PKG_CAT[gnutls]="Security & Network" + PKG_CAT[mbedtls]="Security & Network" + PKG_CAT[mbedtls@3]="Security & Network" + PKG_CAT[nettle]="Security & Network" + PKG_CAT[libsodium]="Security & Network" + PKG_CAT[unbound]="Security & Network" + PKG_CAT[p11-kit]="Security & Network" + PKG_CAT[libtasn1]="Security & Network" + PKG_CAT[libidn2]="Security & Network" + PKG_CAT[libunistring]="Security & Network" + PKG_CAT[c-ares]="Security & Network" + PKG_CAT[libevent]="Security & Network" + PKG_CAT[libnghttp2]="Security & Network" + PKG_CAT[libnghttp3]="Security & Network" + PKG_CAT[libngtcp2]="Security & Network" + PKG_CAT[cloudflared]="Security & Network" + PKG_CAT[mtr]="Security & Network" + PKG_CAT[sshpass]="Security & Network" # CLI Tools - PKG_CAT[tree]="CLI Tools"; PKG_DESC[tree]="Display directory tree in terminal" - PKG_CAT[speedtest-cli]="CLI Tools"; PKG_DESC[speedtest-cli]="Run internet speed test from terminal" - PKG_CAT[mailsy]="CLI Tools"; PKG_DESC[mailsy]="Generate disposable email addresses in terminal" - PKG_CAT[zeromq]="CLI Tools"; PKG_DESC[zeromq]="High-performance async messaging library" - PKG_CAT[bird]="CLI Tools"; PKG_DESC[bird]="Fast X CLI for tweeting, replying, and reading" - PKG_CAT[cliclick]="CLI Tools"; PKG_DESC[cliclick]="Tool for emulating mouse and keyboard events" - PKG_CAT[gogcli]="CLI Tools"; PKG_DESC[gogcli]="Google Suite CLI" - PKG_CAT[goplaces]="CLI Tools"; PKG_DESC[goplaces]="Modern Go client + CLI for the Google Places API" - PKG_CAT[himalaya]="CLI Tools"; PKG_DESC[himalaya]="CLI email client written in Rust" - PKG_CAT[imsg]="CLI Tools"; PKG_DESC[imsg]="Send and read iMessage / SMS from the terminal" - PKG_CAT[memo]="CLI Tools"; PKG_DESC[memo]="CLI app to manage your Apple Notes and Apple reminders" - PKG_CAT[mole]="CLI Tools"; PKG_DESC[mole]="Deep clean and optimize your Mac" - PKG_CAT[obsidian-cli]="CLI Tools"; PKG_DESC[obsidian-cli]="Interactive Obsidian vault manager in the terminal" - PKG_CAT[openhue-cli]="CLI Tools"; PKG_DESC[openhue-cli]="CLI for interacting with Philips Hue smart lighting systems" - PKG_CAT[ordercli]="CLI Tools"; PKG_DESC[ordercli]="Multi-provider order CLI (Foodora, Deliveroo)" - PKG_CAT[peekaboo]="CLI Tools"; PKG_DESC[peekaboo]="Lightning-fast macOS screenshots & AI vision analysis" - PKG_CAT[remindctl]="CLI Tools"; PKG_DESC[remindctl]="Fast CLI for Apple Reminders" - PKG_CAT[ripgrep]="CLI Tools"; PKG_DESC[ripgrep]="Search tool like grep and The Silver Searcher" - PKG_CAT[summarize]="CLI Tools"; PKG_DESC[summarize]="Multi-modal AI tool to extract and summarize content" - PKG_CAT[wacli]="CLI Tools"; PKG_DESC[wacli]="WhatsApp CLI built on whatsmeow" + PKG_CAT[tree]="CLI Tools" + PKG_CAT[speedtest-cli]="CLI Tools" + PKG_CAT[mailsy]="CLI Tools" + PKG_CAT[zeromq]="CLI Tools" + PKG_CAT[bird]="CLI Tools" + PKG_CAT[cliclick]="CLI Tools" + PKG_CAT[gogcli]="CLI Tools" + PKG_CAT[goplaces]="CLI Tools" + PKG_CAT[himalaya]="CLI Tools" + PKG_CAT[imsg]="CLI Tools" + PKG_CAT[memo]="CLI Tools" + PKG_CAT[mole]="CLI Tools" + PKG_CAT[obsidian-cli]="CLI Tools" + PKG_CAT[openhue-cli]="CLI Tools" + PKG_CAT[ordercli]="CLI Tools" + PKG_CAT[peekaboo]="CLI Tools" + PKG_CAT[remindctl]="CLI Tools" + PKG_CAT[ripgrep]="CLI Tools" + PKG_CAT[summarize]="CLI Tools" + PKG_CAT[wacli]="CLI Tools" # Image & Graphics - PKG_CAT[cairo]="Image & Graphics"; PKG_DESC[cairo]="2D graphics rendering library" - PKG_CAT[pango]="Image & Graphics"; PKG_DESC[pango]="Text layout and rendering" - PKG_CAT[pixman]="Image & Graphics"; PKG_DESC[pixman]="Low-level pixel manipulation library" - PKG_CAT[fontconfig]="Image & Graphics"; PKG_DESC[fontconfig]="Font configuration and access library" - PKG_CAT[freetype]="Image & Graphics"; PKG_DESC[freetype]="Font rendering engine" - PKG_CAT[harfbuzz]="Image & Graphics"; PKG_DESC[harfbuzz]="Text shaping engine" - PKG_CAT[graphite2]="Image & Graphics"; PKG_DESC[graphite2]="Graphite smart font rendering" - PKG_CAT[giflib]="Image & Graphics"; PKG_DESC[giflib]="GIF image format library" - PKG_CAT[jpeg-turbo]="Image & Graphics"; PKG_DESC[jpeg-turbo]="Fast JPEG codec" - PKG_CAT[jpeg-xl]="Image & Graphics"; PKG_DESC[jpeg-xl]="Next-gen JPEG XL image format" - PKG_CAT[libpng]="Image & Graphics"; PKG_DESC[libpng]="PNG image format library" - PKG_CAT[libtiff]="Image & Graphics"; PKG_DESC[libtiff]="TIFF image format library" - PKG_CAT[webp]="Image & Graphics"; PKG_DESC[webp]="Google WebP image format" - PKG_CAT[openjpeg]="Image & Graphics"; PKG_DESC[openjpeg]="JPEG 2000 codec" - PKG_CAT[openjph]="Image & Graphics"; PKG_DESC[openjph]="JPEG 2000 High-Throughput codec" - PKG_CAT[openexr]="Image & Graphics"; PKG_DESC[openexr]="HDR image format by ILM" - PKG_CAT[imath]="Image & Graphics"; PKG_DESC[imath]="Math library for graphics (OpenEXR)" - PKG_CAT[tesseract]="Image & Graphics"; PKG_DESC[tesseract]="OCR engine — extract text from images" - PKG_CAT[leptonica]="Image & Graphics"; PKG_DESC[leptonica]="Image processing library (used by Tesseract)" - PKG_CAT[highway]="Image & Graphics"; PKG_DESC[highway]="SIMD instruction abstraction library" - PKG_CAT[little-cms2]="Image & Graphics"; PKG_DESC[little-cms2]="Color management engine" - PKG_CAT[fribidi]="Image & Graphics"; PKG_DESC[fribidi]="Unicode bidirectional text algorithm" + PKG_CAT[cairo]="Image & Graphics" + PKG_CAT[pango]="Image & Graphics" + PKG_CAT[pixman]="Image & Graphics" + PKG_CAT[fontconfig]="Image & Graphics" + PKG_CAT[freetype]="Image & Graphics" + PKG_CAT[harfbuzz]="Image & Graphics" + PKG_CAT[graphite2]="Image & Graphics" + PKG_CAT[giflib]="Image & Graphics" + PKG_CAT[jpeg-turbo]="Image & Graphics" + PKG_CAT[jpeg-xl]="Image & Graphics" + PKG_CAT[libpng]="Image & Graphics" + PKG_CAT[libtiff]="Image & Graphics" + PKG_CAT[webp]="Image & Graphics" + PKG_CAT[openjpeg]="Image & Graphics" + PKG_CAT[openjph]="Image & Graphics" + PKG_CAT[openexr]="Image & Graphics" + PKG_CAT[imath]="Image & Graphics" + PKG_CAT[tesseract]="Image & Graphics" + PKG_CAT[leptonica]="Image & Graphics" + PKG_CAT[highway]="Image & Graphics" + PKG_CAT[little-cms2]="Image & Graphics" + PKG_CAT[fribidi]="Image & Graphics" # Compression & Data - PKG_CAT[brotli]="Compression & Data"; PKG_DESC[brotli]="Google Brotli compression" - PKG_CAT[lz4]="Compression & Data"; PKG_DESC[lz4]="Extremely fast compression" - PKG_CAT[lzo]="Compression & Data"; PKG_DESC[lzo]="Fast data compression library" - PKG_CAT[xz]="Compression & Data"; PKG_DESC[xz]="XZ/LZMA compression" - PKG_CAT[zstd]="Compression & Data"; PKG_DESC[zstd]="Facebook Zstandard compression" - PKG_CAT[snappy]="Compression & Data"; PKG_DESC[snappy]="Fast compression by Google" - PKG_CAT[libarchive]="Compression & Data"; PKG_DESC[libarchive]="Multi-format archive library" - PKG_CAT[libdeflate]="Compression & Data"; PKG_DESC[libdeflate]="Fast DEFLATE/zlib compression" - PKG_CAT[libb2]="Compression & Data"; PKG_DESC[libb2]="BLAKE2 cryptographic hash library" + PKG_CAT[brotli]="Compression & Data" + PKG_CAT[lz4]="Compression & Data" + PKG_CAT[lzo]="Compression & Data" + PKG_CAT[xz]="Compression & Data" + PKG_CAT[zstd]="Compression & Data" + PKG_CAT[snappy]="Compression & Data" + PKG_CAT[libarchive]="Compression & Data" + PKG_CAT[libdeflate]="Compression & Data" + PKG_CAT[libb2]="Compression & Data" # System Libraries - PKG_CAT[glib]="System Libraries"; PKG_DESC[glib]="Core utility library for GNOME/GTK" - PKG_CAT[gmp]="System Libraries"; PKG_DESC[gmp]="GNU multiple precision arithmetic" - PKG_CAT[gettext]="System Libraries"; PKG_DESC[gettext]="Internationalization (i18n) utilities" - PKG_CAT[icu4c@76]="System Libraries"; PKG_DESC[icu4c@76]="Unicode/globalization support (v76)" - PKG_CAT[icu4c@77]="System Libraries"; PKG_DESC[icu4c@77]="Unicode/globalization support (v77)" - PKG_CAT[icu4c@78]="System Libraries"; PKG_DESC[icu4c@78]="Unicode/globalization support (v78)" - PKG_CAT[pcre2]="System Libraries"; PKG_DESC[pcre2]="Perl-compatible regular expressions v2" - PKG_CAT[readline]="System Libraries"; PKG_DESC[readline]="Line editing in terminal (used by shells)" - PKG_CAT[mpdecimal]="System Libraries"; PKG_DESC[mpdecimal]="Decimal arithmetic library (Python uses this)" - PKG_CAT[libuv]="System Libraries"; PKG_DESC[libuv]="Async I/O library (Node.js uses this)" - PKG_CAT[uvwasi]="System Libraries"; PKG_DESC[uvwasi]="WASI system call implementation" - PKG_CAT[simdjson]="System Libraries"; PKG_DESC[simdjson]="Fastest JSON parser (SIMD-accelerated)" - PKG_CAT[cjson]="System Libraries"; PKG_DESC[cjson]="Ultralightweight JSON parser in C" - PKG_CAT[libxcb]="System Libraries"; PKG_DESC[libxcb]="X11 C bindings" - PKG_CAT[libx11]="System Libraries"; PKG_DESC[libx11]="Core X11 library" - PKG_CAT[libxext]="System Libraries"; PKG_DESC[libxext]="X11 extensions library" - PKG_CAT[libxrender]="System Libraries"; PKG_DESC[libxrender]="X11 rendering extension" - PKG_CAT[libxau]="System Libraries"; PKG_DESC[libxau]="X11 authorization library" - PKG_CAT[libxdmcp]="System Libraries"; PKG_DESC[libxdmcp]="X11 display manager control protocol" - PKG_CAT[xorgproto]="System Libraries"; PKG_DESC[xorgproto]="X.Org protocol headers" - PKG_CAT[libmicrohttpd]="System Libraries"; PKG_DESC[libmicrohttpd]="Embeddable HTTP server library" - PKG_CAT[jansson]="System Libraries"; PKG_DESC[jansson]="C library for encoding, decoding, and manipulating JSON" - PKG_CAT[libiconv]="System Libraries"; PKG_DESC[libiconv]="Character set conversion library" - PKG_CAT[libtommath]="System Libraries"; PKG_DESC[libtommath]="C library for number theoretic multiple-precision integers" + PKG_CAT[glib]="System Libraries" + PKG_CAT[gmp]="System Libraries" + PKG_CAT[gettext]="System Libraries" + PKG_CAT[icu4c@76]="System Libraries" + PKG_CAT[icu4c@77]="System Libraries" + PKG_CAT[icu4c@78]="System Libraries" + PKG_CAT[pcre2]="System Libraries" + PKG_CAT[readline]="System Libraries" + PKG_CAT[mpdecimal]="System Libraries" + PKG_CAT[libuv]="System Libraries" + PKG_CAT[uvwasi]="System Libraries" + PKG_CAT[simdjson]="System Libraries" + PKG_CAT[cjson]="System Libraries" + PKG_CAT[libxcb]="System Libraries" + PKG_CAT[libx11]="System Libraries" + PKG_CAT[libxext]="System Libraries" + PKG_CAT[libxrender]="System Libraries" + PKG_CAT[libxau]="System Libraries" + PKG_CAT[libxdmcp]="System Libraries" + PKG_CAT[xorgproto]="System Libraries" + PKG_CAT[libmicrohttpd]="System Libraries" + PKG_CAT[jansson]="System Libraries" + PKG_CAT[libiconv]="System Libraries" + PKG_CAT[libtommath]="System Libraries" } category_color() { @@ -248,7 +291,7 @@ print_shelf() { echo "" local -a order - local color desc + local color order=("Development" "Database" "CLI Tools" "Security & Network" "Video & Media" "Image & Graphics" "Compression & Data" "System Libraries") for cat in "${order[@]}"; do @@ -257,8 +300,7 @@ print_shelf() { print "${BOLD}${color}▶ ${cat}${RESET}" print "${color}$(printf '─%.0s' {1..50})${RESET}" for pkg in ${=cat_items[$cat]}; do - desc="${PKG_DESC[$pkg]:-No description available}" - printf " ${BOLD}%-30s${RESET} ${DIM}%s${RESET}\n" "$pkg" "$desc" + printf " ${BOLD}%-30s${RESET} ${DIM}%s${RESET}\n" "$pkg" "${FORMULA_DESC[$pkg]:-}" done echo "" done @@ -267,30 +309,16 @@ print_shelf() { print "${BOLD}${DIM}▶ Other / Dependencies${RESET}" print "${DIM}$(printf '─%.0s' {1..50})${RESET}" for pkg in "${unknown[@]}"; do - printf " ${DIM}%s${RESET}\n" "$pkg" + printf " ${DIM}%-30s %s${RESET}\n" "$pkg" "${FORMULA_DESC[$pkg]:-}" done echo "" fi if [[ ${#casks[@]} -gt 0 ]]; then - typeset -A cask_desc - cask_desc[claude-code]="Anthropic's Claude CLI for coding" - cask_desc[android-platform-tools]="ADB and fastboot for Android debugging" - cask_desc[mongodb-compass]="Visual GUI for MongoDB" - cask_desc[git-credential-manager]="Secure Git credential storage" - cask_desc[codex]="OpenAI's coding agent that runs in your terminal" - cask_desc[codexbar]="Menu bar usage monitor for Codex and Claude" - cask_desc[gcloud-cli]="Google Cloud CLI to manage resources and applications" - cask_desc[ngrok]="Reverse proxy, secure tunnels to localhost" - cask_desc[openinterminal]="Finder Toolbar app to open current directory in Terminal or Editor" - cask_desc[tigervnc]="Multi-platform VNC client and server" - cask_desc[tigervnc-viewer]="Multi-platform VNC client" - print "${BOLD}${GREEN}▶ GUI Applications (Casks)${RESET}" print "${GREEN}$(printf '─%.0s' {1..50})${RESET}" for cask in "${casks[@]}"; do - local cdesc="${cask_desc[$cask]:-GUI application}" - printf " ${BOLD}%-30s${RESET} ${DIM}%s${RESET}\n" "$cask" "$cdesc" + printf " ${BOLD}%-30s${RESET} ${DIM}%s${RESET}\n" "$cask" "${CASK_DESC[$cask]:-}" done echo "" fi @@ -303,4 +331,5 @@ print_shelf() { } init_data +load_descriptions print_shelf diff --git a/tests/bin/brew b/tests/bin/brew index 7a3640d..8d8cbb8 100755 --- a/tests/bin/brew +++ b/tests/bin/brew @@ -1,8 +1,13 @@ #!/bin/sh # Fake `brew` for tests. Package lists come from the files named in -# FAKE_BREW_FORMULAS / FAKE_BREW_CASKS (one name per line). +# FAKE_BREW_FORMULAS / FAKE_BREW_CASKS (one name per line), package metadata +# from the JSON file in FAKE_BREW_JSON. FAKE_BREW_INFO_FAILS=1 makes `brew info` fail. case "$1 $2" in "list --formula") cat "$FAKE_BREW_FORMULAS" 2>/dev/null ;; "list --cask") cat "$FAKE_BREW_CASKS" 2>/dev/null ;; + "info --json=v2") + [ "$FAKE_BREW_INFO_FAILS" = 1 ] && { echo "Error: something went wrong" >&2; exit 1; } + cat "$FAKE_BREW_JSON" 2>/dev/null || echo '{"formulae":[],"casks":[]}' + ;; *) echo "fake brew: unsupported command: $*" >&2; exit 1 ;; esac diff --git a/tests/run.zsh b/tests/run.zsh index 6da0cb4..25ac8cc 100644 --- a/tests/run.zsh +++ b/tests/run.zsh @@ -13,6 +13,26 @@ TEST_PATH="$TESTS_DIR/bin:/usr/bin:/bin" typeset -i passed=0 failed=0 OUT="" STATUS=0 +# What `brew info --json=v2 --installed` returns. "untrusted-formula" is missing on purpose: +# Homebrew leaves out formulas from untrusted taps and formulas removed from Homebrew. +cat > "$WORK/info.json" <<'JSON' +{ + "formulae": [ + { "name": "node", "desc": "Open-source, cross-platform JavaScript runtime environment" }, + { "name": "ffmpeg", "desc": "Play, record, convert, and stream audio and video" }, + { "name": "sqlite", "desc": "Command-line interface for SQLite" }, + { "name": "some-unknown-formula", "desc": "Formula without a category" }, + { "name": "multiline", "desc": "First line\tand a tab\nsecond line" } + ], + "casks": [ + { "token": "ngrok", "desc": "Reverse proxy, secure introspectable tunnels to localhost" } + ] +} +JSON + +# Extra environment for the next run_brewshelf call, e.g. (BREWSHELF_JSON_PARSER=osascript) +typeset -a EXTRA_ENV=() + # run_brewshelf [shell] — lists are newline-separated names run_brewshelf() { print -rn -- "$1" > "$WORK/formulas" @@ -20,6 +40,7 @@ run_brewshelf() { local shell=${3:-zsh} OUT=$(env -i HOME="$HOME" PATH="$TEST_PATH" \ FAKE_BREW_FORMULAS="$WORK/formulas" FAKE_BREW_CASKS="$WORK/casks" \ + FAKE_BREW_JSON="$WORK/info.json" "${EXTRA_ENV[@]}" \ "$shell" "$SCRIPT" 2>&1) STATUS=$? # Strip ANSI colors so assertions match plain text @@ -49,14 +70,41 @@ print "known packages" run_brewshelf $'node\nffmpeg\nsqlite' $'ngrok' check "exits 0" status_is 0 check "groups formulas by category" contains "▶ Development" -check "shows the description" contains "JavaScript runtime (Node.js)" +check "shows the Homebrew description" contains "Open-source, cross-platform JavaScript runtime environment" check "lists casks" contains "ngrok" +check "shows the cask description" contains "Reverse proxy, secure introspectable tunnels to localhost" check "counts formulas + casks" contains "Total: 4 packages installed" print "unknown packages" run_brewshelf $'node\nsome-unknown-formula' '' check "puts unknown formulas under Other" contains "▶ Other / Dependencies" check "lists the unknown formula" contains "some-unknown-formula" +check "describes the unknown formula too" contains "Formula without a category" + +print "descriptions" +run_brewshelf $'node\nuntrusted-formula' '' +check "lists a formula missing from brew info" contains "untrusted-formula" +check "still counts it" contains "Total: 2 packages installed" +run_brewshelf $'multiline' '' +check "flattens tabs and newlines in descriptions" contains "First line and a tab second line" +EXTRA_ENV=(FAKE_BREW_INFO_FAILS=1) +run_brewshelf $'node' '' +check "brew info failing: exits 0" status_is 0 +check "brew info failing: still lists packages" contains "node" +EXTRA_ENV=() + +print "JSON parsers" +for parser in jq osascript; do + if [[ $parser == jq ]] && ! PATH=$TEST_PATH command -v jq >/dev/null; then + print " - jq not installed, skipped" + continue + fi + EXTRA_ENV=(BREWSHELF_JSON_PARSER=$parser) + run_brewshelf $'node\nsome-unknown-formula' $'ngrok' + check "$parser: formula description" contains "Open-source, cross-platform JavaScript runtime environment" + check "$parser: cask description" contains "Reverse proxy, secure introspectable tunnels to localhost" +done +EXTRA_ENV=() print "no casks" run_brewshelf $'node' ''