Improvements and fixes to zsh completion by okapia · Pull Request #2772 · sharkdp/bat

okapia · 2023-11-12T13:58:09Z

Use correct return status so that approximate completion isn't broken. Zsh completions should not return 0 if they fail to add matches. Supporting this typically involves a local variable named ret as in the patch. Someone was complaining on a forum about this not working which is what motivated me to take a look
Follow zsh conventions on description forms. Not using capitalisation is the convention going back a long time and most people agree that consistency is more important than any preference one way or another. There was also some things which look like copy-paste from help output. We don't put types in angle brackets, e.g. - users can configure that if they like it and references to something like N only make sense in help output where N also appears in a syntax summary.
Some options can be used multiple times, e.g. -H, -r, --file-name. That's the initial * in the spec.
Set completion context correctly for the cache subcommand. This matters for configuration with zstyle.
Better completion for --map-syntax argument
Add --nonprintable-notation option. There's also -S/--chop-long-lines but I'm not sure whether these are deprecated forms of --wrap.
Correct some of the mutual exclusion lists for options. Options don't need to exclude themselves - that's the default. And some options were excluding : instead of * which doesn't make sense with _files being called from a * spec - perhaps that was reflecting an old form the function took.

I also put in a fallback to complete "cache" if _files fails. I think this addresses the concerns from the old linked github issue while allowing bat cac to complete to 'cache' if there aren't already files. The normal zsh approach would actually be to use _alternative and allow the user to configure it.

keith-hall

The usual caveat of me not being a ZSH user and not knowing much about completions applies, but the PR description indicates you know what you are doing, and the diff seems reasonable, so you get my approval. Thanks for your contribution. Note that in order to pass CI checks, you'll need to add a changelog entry.

* Use correct return status so that approximate completion isn't broken * Follow zsh conventions on description forms * Some options can be used multiple times, e.g. -H, -r, --file-name * Set completion context correctly for the cache subcommand * Better completion for --map-syntax argument * Add --nonprintable-notation option * Correct some of the mutual exclusion lists for options

okapia · 2023-11-14T23:20:53Z

Thanks, as requested, I've added a changelog entry.

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [sharkdp/bat](https://github.com/sharkdp/bat) | minor | `v0.24.0` -> `v0.25.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>sharkdp/bat (sharkdp/bat)</summary> ### [`v0.25.0`](https://github.com/sharkdp/bat/blob/HEAD/CHANGELOG.md#v0250) [Compare Source](sharkdp/bat@v0.24.0...v0.25.0) #### Features - Set terminal title to file names when Paging is not Paging::Never [#2807](sharkdp/bat#2807) ([@Oliver-Looney](https://github.com/Oliver-Looney)) - `bat --squeeze-blank`/`bat -s` will now squeeze consecutive empty lines, see [#1441](sharkdp/bat#1441) ([@eth-p](https://github.com/eth-p)) and [#2665](sharkdp/bat#2665) ([@einfachIrgendwer0815](https://github.com/einfachIrgendwer0815)) - `bat --squeeze-limit` to set the maximum number of empty consecutive when using `--squeeze-blank`, see [#1441](sharkdp/bat#1441) ([@eth-p](https://github.com/eth-p)) and [#2665](sharkdp/bat#2665) ([@einfachIrgendwer0815](https://github.com/einfachIrgendwer0815)) - `PrettyPrinter::squeeze_empty_lines` to support line squeezing for bat as a library, see [#1441](sharkdp/bat#1441) ([@eth-p](https://github.com/eth-p)) and [#2665](sharkdp/bat#2665) ([@einfachIrgendwer0815](https://github.com/einfachIrgendwer0815)) - Syntax highlighting for JavaScript files that start with `#!/usr/bin/env bun` [#2913](sharkdp/bat#2913) ([@sharunkumar](https://github.com/sharunkumar)) - `bat --strip-ansi={never,always,auto}` to remove ANSI escape sequences from bat's input, see [#2999](sharkdp/bat#2999) ([@eth-p](https://github.com/eth-p)) - Add or remove individual style components without replacing all styles [#2929](sharkdp/bat#2929) ([@eth-p](https://github.com/eth-p)) - Automatically choose theme based on the terminal's color scheme, see [#2896](sharkdp/bat#2896) ([@bash](https://github.com/bash)) - Add option `--binary=as-text` for printing binary content, see issue [#2974](sharkdp/bat#2974) and MR [#2976](sharkdp/bat#2976) ([@einfachIrgendwer0815](https://github.com/einfachIrgendwer0815)) - Make shell completions available via `--completion <shell>`, see issue [#2057](sharkdp/bat#2057) and MR [#3126](sharkdp/bat#3126) ([@einfachIrgendwer0815](https://github.com/einfachIrgendwer0815)) - Syntax highlighting for puppet code blocks within Markdown files, see [#3152](sharkdp/bat#3152) ([@liliwilson](https://github.com/liliwilson)) #### Bugfixes - Fix long file name wrapping in header, see [#2835](sharkdp/bat#2835) ([@FilipRazek](https://github.com/FilipRazek)) - Fix `NO_COLOR` support, see [#2767](sharkdp/bat#2767) ([@acuteenvy](https://github.com/acuteenvy)) - Fix handling of inputs with OSC ANSI escape sequences, see [#2541](sharkdp/bat#2541) and [#2544](sharkdp/bat#2544) ([@eth-p](https://github.com/eth-p)) - Fix handling of inputs with combined ANSI color and attribute sequences, see [#2185](sharkdp/bat#2185) and [#2856](sharkdp/bat#2856) ([@eth-p](https://github.com/eth-p)) - Fix panel width when line 10000 wraps, see [#2854](sharkdp/bat#2854) ([@eth-p](https://github.com/eth-p)) - Fix compile issue of `time` dependency caused by standard library regression [#3045](sharkdp/bat#3045) ([@cyqsimon](https://github.com/cyqsimon)) - Fix override behavior of --plain and --paging, see issue [#2731](sharkdp/bat#2731) and MR [#3108](sharkdp/bat#3108) ([@einfachIrgendwer0815](https://github.com/einfachIrgendwer0815)) - Fix bugs in `$LESSOPEN` support, see [#2805](sharkdp/bat#2805) ([@Anomalocaridid](https://github.com/Anomalocaridid)) #### Other - Upgrade to Rust 2021 edition [#2748](sharkdp/bat#2748) ([@cyqsimon](https://github.com/cyqsimon)) - Refactor and cleanup build script [#2756](sharkdp/bat#2756) ([@cyqsimon](https://github.com/cyqsimon)) - Checks changelog has been written to for MRs in CI [#2766](sharkdp/bat#2766) ([@cyqsimon](https://github.com/cyqsimon)) - Use GitHub API to get correct MR submitter [#2791](sharkdp/bat#2791) ([@cyqsimon](https://github.com/cyqsimon)) - Minor benchmark script improvements [#2768](sharkdp/bat#2768) ([@cyqsimon](https://github.com/cyqsimon)) - Update Arch Linux package URL in README files [#2779](sharkdp/bat#2779) ([@brunobell](https://github.com/brunobell)) - Update and improve `zsh` completion, see [#2772](sharkdp/bat#2772) ([@okapia](https://github.com/okapia)) - More extensible syntax mapping mechanism [#2755](sharkdp/bat#2755) ([@cyqsimon](https://github.com/cyqsimon)) - Use proper Architecture for Debian packages built for musl, see [#2811](sharkdp/bat#2811) ([@Enselic](https://github.com/Enselic)) - Pull in fix for unsafe-libyaml security advisory, see [#2812](sharkdp/bat#2812) ([@dtolnay](https://github.com/dtolnay)) - Update git-version dependency to use Syn v2, see [#2816](sharkdp/bat#2816) ([@dtolnay](https://github.com/dtolnay)) - Update git2 dependency to v0.18.2, see [#2852](sharkdp/bat#2852) ([@eth-p](https://github.com/eth-p)) - Improve performance when color output disabled, see [#2397](sharkdp/bat#2397) and [#2857](sharkdp/bat#2857) ([@eth-p](https://github.com/eth-p)) - Relax syntax mapping rule restrictions to allow brace expansion [#2865](sharkdp/bat#2865) ([@cyqsimon](https://github.com/cyqsimon)) - Apply clippy fixes [#2864](sharkdp/bat#2864) ([@cyqsimon](https://github.com/cyqsimon)) - Faster startup by offloading glob matcher building to a worker thread [#2868](sharkdp/bat#2868) ([@cyqsimon](https://github.com/cyqsimon)) - Display which theme is the default one in basic output (no colors), see [#2937](sharkdp/bat#2937) ([@sblondon](https://github.com/sblondon)) - Display which theme is the default one in colored output, see [#2838](sharkdp/bat#2838) ([@sblondon](https://github.com/sblondon)) - Add aarch64-apple-darwin ("Apple Silicon") binary tarballs to releases, see [#2967](sharkdp/bat#2967) ([@someposer](https://github.com/someposer)) - Update the Lisp syntax, see [#2970](sharkdp/bat#2970) ([@ccqpein](https://github.com/ccqpein)) - Use bat's ANSI iterator during tab expansion, see [#2998](sharkdp/bat#2998) ([@eth-p](https://github.com/eth-p)) - Support 'statically linked binary' for aarch64 in 'Release' page, see [#2992](sharkdp/bat#2992) ([@tzq0301](https://github.com/tzq0301)) - Update options in shell completions and the man page of `bat`, see [#2995](sharkdp/bat#2995) ([@akinomyoga](https://github.com/akinomyoga)) - Update nix dev-dependency to v0.29.0, see [#3112](sharkdp/bat#3112) ([@decathorpe](https://github.com/decathorpe)) - Bump MSRV to [1.74](https://blog.rust-lang.org/2023/11/16/Rust-1.74.0.html), see [#3154](sharkdp/bat#3154) ([@keith-hall](https://github.com/keith-hall)) - Update clircle dependency to remove winapi transitive dependency, see [#3113](sharkdp/bat#3113) ([@niklasmohrin](https://github.com/niklasmohrin)) #### Syntaxes - `cmd-help`: scope subcommands followed by other terms, and other misc improvements, see [#2819](sharkdp/bat#2819) ([@victor-gp](https://github.com/victor-gp)) - Upgrade JQ syntax, see [#2820](sharkdp/bat#2820) ([@dependabot](https://github.com/dependabot)\[bot]) - Add syntax mapping for quadman quadlets [#2866](sharkdp/bat#2866) ([@cyqsimon](https://github.com/cyqsimon)) - Map containers .conf files to TOML syntax [#2867](sharkdp/bat#2867) ([@cyqsimon](https://github.com/cyqsimon)) - Associate `.xsh` files with `xonsh` syntax that is Python, see [#2840](sharkdp/bat#2840) ([@anki-code](https://github.com/anki-code)) - Associate JSON with Comments `.jsonc` with `json` syntax, see [#2795](sharkdp/bat#2795) ([@mxaddict](https://github.com/mxaddict)) - Associate JSON-LD `.jsonld` files with `json` syntax, see [#3037](sharkdp/bat#3037) ([@vorburger](https://github.com/vorburger)) - Associate `.textproto` files with `ProtoBuf` syntax, see [#3038](sharkdp/bat#3038) ([@vorburger](https://github.com/vorburger)) - Associate GeoJSON `.geojson` files with `json` syntax, see [#3084](sharkdp/bat#3084) ([@mvaaltola](https://github.com/mvaaltola)) - Associate `.aws/{config,credentials}`, see [#2795](sharkdp/bat#2795) ([@mxaddict](https://github.com/mxaddict)) - Associate Wireguard config `/etc/wireguard/*.conf`, see [#2874](sharkdp/bat#2874) ([@cyqsimon](https://github.com/cyqsimon)) - Add support for [CFML](https://www.adobe.com/products/coldfusion-family.html), see [#3031](sharkdp/bat#3031) ([@brenton-at-pieces](https://github.com/brenton-at-pieces)) - Map `*.mkd` files to `Markdown` syntax, see issue [#3060](sharkdp/bat#3060) and MR [#3061](sharkdp/bat#3061) ([@einfachIrgendwer0815](https://github.com/einfachIrgendwer0815)) - Add syntax mapping for CITATION.cff, see [#3103](sharkdp/bat#3103) ([@Ugzuzg](https://github.com/Ugzuzg)) - Add syntax mapping for kubernetes config files [#3049](sharkdp/bat#3049) ([@cyqsimon](https://github.com/cyqsimon)) - Adds support for pipe delimiter for CSV [#3115](sharkdp/bat#3115) ([@pratik-m](https://github.com/pratik-m)) - Add syntax mapping for `/etc/pacman.conf` [#2961](sharkdp/bat#2961) ([@cyqsimon](https://github.com/cyqsimon)) - Associate `uv.lock` with `TOML` syntax, see [#3132](sharkdp/bat#3132) ([@fepegar](https://github.com/fepegar)) #### Themes - Patched/improved themes for better Manpage syntax highlighting support, see [#2994](sharkdp/bat#2994) ([@keith-hall](https://github.com/keith-hall)). #### `bat` as a library - Changes to `syntax_mapping::SyntaxMapping` [#2755](sharkdp/bat#2755) ([@cyqsimon](https://github.com/cyqsimon)) - `SyntaxMapping::get_syntax_for` is now correctly public - \[BREAKING] `SyntaxMapping::{empty,builtin}` are removed; use `SyntaxMapping::new` instead - \[BREAKING] `SyntaxMapping::mappings` is replaced by `SyntaxMapping::{builtin,custom,all}_mappings` - Make `Controller::run_with_error_handler`'s error handler `FnMut`, see [#2831](sharkdp/bat#2831) ([@rhysd](https://github.com/rhysd)) - Improve compile time by 20%, see [#2815](sharkdp/bat#2815) ([@dtolnay](https://github.com/dtolnay)) - Add `theme::theme` for choosing an appropriate theme based on the terminal's color scheme, see [#2896](sharkdp/bat#2896) ([@bash](https://github.com/bash)) - \[BREAKING] Remove `HighlightingAssets::default_theme`. Use `theme::default_theme` instead. - Add `PrettyPrinter::print_with_writer` for custom output destinations, see [#3070](sharkdp/bat#3070) ([@kojix2](https://github.com/kojix2)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

keith-hall approved these changes Nov 13, 2023

View reviewed changes

okapia force-pushed the zsh-completion branch from a1375e8 to 11e5829 Compare November 14, 2023 21:06

Merge branch 'master' into zsh-completion

0870874

Enselic merged commit b43d31b into sharkdp:master Dec 1, 2023

This was referenced Feb 16, 2025

Bump sharkdp/bat from 0.24.0 to 0.25.0 in lib/functions/general/bat-cat.sh torte71/armbian-mksklipad50#5

Open

Bump sharkdp/bat from 0.24.0 to 0.25.0 in lib/functions/general/bat-cat.sh poiuztreq/Armbian-ZNP-K1-build#2

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Improvements and fixes to zsh completion#2772

Improvements and fixes to zsh completion#2772
Enselic merged 2 commits intosharkdp:masterfrom
okapia:zsh-completion

okapia commented Nov 12, 2023

Uh oh!

keith-hall left a comment

Uh oh!

okapia commented Nov 14, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

okapia commented Nov 12, 2023

Uh oh!

keith-hall left a comment

Choose a reason for hiding this comment

Uh oh!

okapia commented Nov 14, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants