diff --git a/highlighters/main/main-highlighter.zsh b/highlighters/main/main-highlighter.zsh index e6f5e35..f109fc3 100644 --- a/highlighters/main/main-highlighter.zsh +++ b/highlighters/main/main-highlighter.zsh @@ -249,6 +249,43 @@ _zsh_highlight_main__is_runnable() { fi } +# Check whether $1 is a Git subcommand. +# +# Return 0 if it is, 1 if it is not, and 2 if the subcommand list could not be +# obtained. The list is loaded once, on first use. +_zsh_highlight_main__is_git_subcommand() { + if (( ! _zsh_highlight_main__git_subcommands_loaded )); then + local line section + local -a words + local output + + _zsh_highlight_main__git_subcommands=() + output="$(LC_ALL=C command git help -a 2>/dev/null)" || return 2 + + for line in ${(f)output}; do + if [[ $line != ' '* ]]; then + section=$line + continue + fi + if [[ $section == *Commands* || $section == 'External commands' ]]; then + words=(${=line}) + (( $#words )) && _zsh_highlight_main__git_subcommands[$words[1]]=1 + fi + done + + # Include git-* executables that an older Git may omit from `git help -a`. + if zmodload -e zsh/parameter; then + for line in ${(k)commands[(I)git-*]}; do + _zsh_highlight_main__git_subcommands[${line#git-}]=1 + done + fi + + _zsh_highlight_main__git_subcommands_loaded=1 + fi + + (( ${+_zsh_highlight_main__git_subcommands[$1]} )) +} + # Check whether the first argument is a redirection operator token. # Report result via the exit code. _zsh_highlight_main__is_redirection() { @@ -1102,6 +1139,9 @@ _zsh_highlight_main_highlighter_highlight_list() continue ;; esac + if [[ $arg == git && $res == (command|hashed) ]]; then + next_word+=':git-subcommand:' + fi fi if [[ -n ${(M)ZSH_HIGHLIGHT_TOKENS_CONTROL_FLOW:#"$arg"} ]]; then next_word=':start::start_of_pipeline:' @@ -1161,6 +1201,15 @@ _zsh_highlight_main_highlighter_highlight_list() : elif [[ $arg == $'\x5d' ]] && _zsh_highlight_main__stack_pop 'Q' builtin; then : + elif [[ $this_word == *':git-subcommand:'* ]]; then + if _zsh_highlight_main__is_git_subcommand ${(Q)arg}; then + style=command + elif (( $? == 1 )); then + style=unknown-token + else + _zsh_highlight_main_highlighter_highlight_argument 1 $(( 1 != in_redirection )) + continue + fi else _zsh_highlight_main_highlighter_highlight_argument 1 $(( 1 != in_redirection )) continue @@ -1844,4 +1893,6 @@ else # Make sure the cache is unset unset _zsh_highlight_main__command_type_cache fi +typeset -gA _zsh_highlight_main__git_subcommands +typeset -gi _zsh_highlight_main__git_subcommands_loaded=0 typeset -ga ZSH_HIGHLIGHT_DIRS_BLACKLIST diff --git a/highlighters/main/test-data/git-invalid-subcommand.zsh b/highlighters/main/test-data/git-invalid-subcommand.zsh new file mode 100644 index 0000000..85972d8 --- /dev/null +++ b/highlighters/main/test-data/git-invalid-subcommand.zsh @@ -0,0 +1,39 @@ +#!/usr/bin/env zsh +# ------------------------------------------------------------------------------------------------- +# Copyright (c) 2026 zsh-syntax-highlighting contributors +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted +# provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this list of conditions +# and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, this list of +# conditions and the following disclaimer in the documentation and/or other materials provided +# with the distribution. +# * Neither the name of the zsh-syntax-highlighting contributors nor the names of its contributors +# may be used to endorse or promote products derived from this software without specific prior +# written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +# FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER +# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# ------------------------------------------------------------------------------------------------- +# -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*- +# vim: ft=zsh sw=2 ts=2 et +# ------------------------------------------------------------------------------------------------- + +_zsh_highlight_main__git_subcommands=(status 1) +_zsh_highlight_main__git_subcommands_loaded=1 + +BUFFER='git statu' + +expected_region_highlight=( + '1 3 command' # git + '5 9 unknown-token' # statu +) diff --git a/highlighters/main/test-data/git-valid-subcommand.zsh b/highlighters/main/test-data/git-valid-subcommand.zsh new file mode 100644 index 0000000..b4c9ed4 --- /dev/null +++ b/highlighters/main/test-data/git-valid-subcommand.zsh @@ -0,0 +1,48 @@ +#!/usr/bin/env zsh +# ------------------------------------------------------------------------------------------------- +# Copyright (c) 2026 zsh-syntax-highlighting contributors +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted +# provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this list of conditions +# and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, this list of +# conditions and the following disclaimer in the documentation and/or other materials provided +# with the distribution. +# * Neither the name of the zsh-syntax-highlighting contributors nor the names of its contributors +# may be used to endorse or promote products derived from this software without specific prior +# written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +# FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER +# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# ------------------------------------------------------------------------------------------------- +# -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*- +# vim: ft=zsh sw=2 ts=2 et +# ------------------------------------------------------------------------------------------------- + +_zsh_highlight_main__git_subcommands=(status 1 commit 1 push 1 lfs 1) +_zsh_highlight_main__git_subcommands_loaded=1 + +BUFFER='git status; git commit; git push; git lfs' + +expected_region_highlight=( + '1 3 command' # git + '5 10 command' # status + '11 11 commandseparator' # ; + '13 15 command' # git + '17 22 command' # commit + '23 23 commandseparator' # ; + '25 27 command' # git + '29 32 command' # push + '33 33 commandseparator' # ; + '35 37 command' # git + '39 41 command' # lfs +)