Refactoring

- Shorten too long descriptions
- Add missing option descriptions
- Improve completion
This commit is contained in:
Shohei YOSHIDA 2024-02-07 18:19:32 +09:00
parent 10d8919acb
commit 9f7a83c0ac
No known key found for this signature in database
GPG Key ID: C9A1BB11BB940CF2
1 changed files with 58 additions and 61 deletions

View File

@ -20,9 +20,9 @@ _pre_commit_commands() {
"clean:Clean out pre-commit files" "clean:Clean out pre-commit files"
"gc:Clean unused cached repos" "gc:Clean unused cached repos"
"help:Show help for a specific command" "help:Show help for a specific command"
"init-templatedir:Install hook script in a directory intended for use with \`git config init.templateDir\`" "init-templatedir:Install hook script in a directory intended for use with 'git config init.templateDir'"
"install:Install the pre-commit script" "install:Install the pre-commit script"
"install-hooks:Install hook environments for all environments in the config file. You may find \`pre-commit install --install-hooks\` more useful" "install-hooks:Install hook environments for all environments in the config file"
"migrate-config:Migrate list configuration to new map configuration" "migrate-config:Migrate list configuration to new map configuration"
"run:Run hooks" "run:Run hooks"
"sample-config:Produce a sample .pre-commit-config.yaml file" "sample-config:Produce a sample .pre-commit-config.yaml file"
@ -41,21 +41,21 @@ _pre_commit_options=(
_pre_commit_autoupdate_options=( _pre_commit_autoupdate_options=(
"(- : *)"{-h,--help}"[show this help message and exit]" "(- : *)"{-h,--help}"[show this help message and exit]"
"--color[Whether to use color in output. Defaults to \`\%(default)s\`.]:color:" "--color[Whether to use color in output. Defaults to 'auto']:color:(auto always never)"
{-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'" {-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'"
"--bleeding-edge[Update to the bleeding edge of \`HEAD\` instead of the latest tagged version (the default behavior).]" "--bleeding-edge[Update to the bleeding edge of 'HEAD' instead of the latest tagged version]"
"--freeze[Store \"frozen\" hashes in \`rev\` instead of tag names]" "--freeze[Store 'frozen' hashes in 'rev' instead of tag names]"
"*--repo[Only update this repository -- may be specified multiple times.]:repos:" "*--repo[Only update this repository -- may be specified multiple times]:repos:"
) )
_pre_commit_clean_options=( _pre_commit_clean_options=(
"(- : *)"{-h,--help}"[show this help message and exit]" "(- : *)"{-h,--help}"[show this help message and exit]"
"--color[Whether to use color in output. Defaults to \`\%(default)s\`.]:color:" "--color[Whether to use color in output. Defaults to 'auto']:color:(auto always never)"
) )
_pre_commit_gc_options=( _pre_commit_gc_options=(
"(- : *)"{-h,--help}"[show this help message and exit]" "(- : *)"{-h,--help}"[show this help message and exit]"
"--color[Whether to use color in output. Defaults to \`\%(default)s\`.]:color:" "--color[Whether to use color in output. Defaults to 'auto']:color:(auto always never)"
) )
_pre_commit_help_options=( _pre_commit_help_options=(
@ -65,54 +65,54 @@ _pre_commit_help_options=(
_pre_commit_init_templatedir_options=( _pre_commit_init_templatedir_options=(
"(- : *)"{-h,--help}"[show this help message and exit]" "(- : *)"{-h,--help}"[show this help message and exit]"
"--color[Whether to use color in output. Defaults to \`\%(default)s\`.]:color:" "--color[Whether to use color in output. Defaults to 'auto']:color:(auto always never)"
{-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'" {-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'"
"--no-allow-missing-config[Assume cloned repos should have a \`pre-commit\` config.]" "--no-allow-missing-config[Assume cloned repos should have a 'pre-commit' config]"
"*"{-t,--hook-type}"[]:hook_types:(pre-commit pre-merge-commit pre-push prepare-commit-msg commit-msg post-commit post-checkout post-merge post-rewrite)" "*"{-t,--hook-type}"[which hook type to install]:hook_types:(pre-commit pre-merge-commit pre-push prepare-commit-msg commit-msg post-commit post-checkout post-merge post-rewrite)"
":The directory in which to write the hook script.:_files -/" ":The directory in which to write the hook script.:_files -/"
) )
_pre_commit_install_options=( _pre_commit_install_options=(
"(- : *)"{-h,--help}"[show this help message and exit]" "(- : *)"{-h,--help}"[show this help message and exit]"
"--color[Whether to use color in output. Defaults to \`\%(default)s\`.]:color:" "--color[Whether to use color in output. Defaults to 'auto']:color:(auto always never)"
{-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'" {-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'"
{-f,--overwrite}"[Overwrite existing hooks \/ remove migration mode.]" {-f,--overwrite}"[Overwrite existing hooks / remove migration mode]"
"--install-hooks[Whether to install hook environments for all environments in the config file.]" "--install-hooks[Whether to install hook environments for all environments in the config file]"
"*"{-t,--hook-type}"[]:hook_types:(pre-commit pre-merge-commit pre-push prepare-commit-msg commit-msg post-commit post-checkout post-merge post-rewrite)" "*"{-t,--hook-type}"[which hook type to install]:hook_types:(pre-commit pre-merge-commit pre-push prepare-commit-msg commit-msg post-commit post-checkout post-merge post-rewrite)"
"--allow-missing-config[Whether to allow a missing \`pre-commit\` configuration file or exit with a failure code.]" "--allow-missing-config[Hook scripts will permit a missing configuration file]"
) )
_pre_commit_install_hooks_options=( _pre_commit_install_hooks_options=(
"(- : *)"{-h,--help}"[show this help message and exit]" "(- : *)"{-h,--help}"[show this help message and exit]"
"--color[Whether to use color in output. Defaults to \`\%(default)s\`.]:color:" "--color[Whether to use color in output. Defaults to 'auto']:color:(auto always never)"
{-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'" {-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'"
) )
_pre_commit_migrate_config_options=( _pre_commit_migrate_config_options=(
"(- : *)"{-h,--help}"[show this help message and exit]" "(- : *)"{-h,--help}"[show this help message and exit]"
"--color[Whether to use color in output. Defaults to \`\%(default)s\`.]:color:" "--color[Whether to use color in output. Defaults to 'auto']:color:(auto always never)"
{-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'" {-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'"
) )
_pre_commit_run_options=( _pre_commit_run_options=(
"(- : *)"{-h,--help}"[show this help message and exit]" "(- : *)"{-h,--help}"[show this help message and exit]"
"--color[Whether to use color in output. Defaults to \`\%(default)s\`.]:color:" "--color[Whether to use color in output. Defaults to 'auto']:color:(auto always never)"
{-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'" {-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'"
{--verbose,-v}"[]" {--verbose,-v}"[ produce hook output independent of success]"
{--all-files,-a}"[Run on all the files in the repo.]" {--all-files,-a}"[Run on all the files in the repo]"
"--files[Specific filenames to run hooks on.]:files:_files" "--files[Specific filenames to run hooks on]:files:_files"
"--show-diff-on-failure[When hooks fail, run \`git diff\` directly afterward.]" "--show-diff-on-failure[When hooks fail, run 'git diff' directly afterward]"
"--hook-stage[The stage during which the hook is fired. One of \%(choices)s]:hook_stage:(commit merge-commit prepare-commit-msg commit-msg post-commit manual post-checkout push post-merge post-rewrite)" "--hook-stage[The stage during which the hook is fired]:hook_stage:(commit merge-commit prepare-commit-msg commit-msg post-commit manual post-checkout push post-merge post-rewrite)"
"--remote-branch[Remote branch ref used by \`git push\`.]:remote_branch:" "--remote-branch[Remote branch ref used by 'git push']:remote_branch:"
"--local-branch[Local branch ref used by \`git push\`.]:local_branch:" "--local-branch[Local branch ref used by 'git push']:local_branch:"
{--from-ref,--source,-s}"[(for usage with \`--to-ref\`) -- this option represents the original ref in a \`from_ref...to_ref\` diff expression. For \`pre-push\` hooks, this represents the branch you are pushing to. For \`post-checkout\` hooks, this represents the branch that was previously checked out.]:from_ref:" {--from-ref,--source,-s}"[the original ref in a 'from_ref...to_ref' diff expression]:from_ref:"
{--to-ref,--origin,-o}"[(for usage with \`--from-ref\`) -- this option represents the destination ref in a \`from_ref...to_ref\` diff expression. For \`pre-push\` hooks, this represents the branch being pushed. For \`post-checkout\` hooks, this represents the branch that is now checked out.]:to_ref:" {--to-ref,--origin,-o}"[the destination ref in a 'from_ref...to_ref' diff expression]:to_ref:"
"--commit-msg-filename[Filename to check when running during \`commit-msg\`]:commit_msg_filename:" "--commit-msg-filename[Filename to check when running during 'commit-msg']:commit_msg_filename:"
"--prepare-commit-message-source[Source of the commit message (typically the second argument to .git\/hooks\/prepare-commit-msg)]:prepare_commit_message_source:" "--prepare-commit-message-source[Source of the commit message]:prepare_commit_message_source:"
"--commit-object-name[Commit object name (typically the third argument to .git\/hooks\/prepare-commit-msg)]:commit_object_name:" "--commit-object-name[Commit object name]:commit_object_name:"
"--remote-name[Remote name used by \`git push\`.]:remote_name:" "--remote-name[Remote name used by 'git push']:remote_name:"
"--remote-url[Remote url used by \`git push\`.]:remote_url:" "--remote-url[Remote url used by 'git push']:remote_url:"
"--checkout-type[Indicates whether the checkout was a branch checkout (changing branches, flag\=1) or a file checkout (retrieving a file from the index, flag\=0).]:checkout_type:" "--checkout-type[Indicates whether the checkout was a branch checkout or a file checkout]:checkout_type:((0\:file\ checkout 1\:branch\ checkout))"
"--is-squash-merge[During a post-merge hook, indicates whether the merge was a squash merge]:is_squash_merge:" "--is-squash-merge[During a post-merge hook, indicates whether the merge was a squash merge]:is_squash_merge:"
"--rewrite-command[During a post-rewrite hook, specifies the command that invoked the rewrite]:rewrite_command:" "--rewrite-command[During a post-rewrite hook, specifies the command that invoked the rewrite]:rewrite_command:"
":A single hook-id to run:" ":A single hook-id to run:"
@ -120,29 +120,29 @@ _pre_commit_run_options=(
_pre_commit_sample_config_options=( _pre_commit_sample_config_options=(
"(- : *)"{-h,--help}"[show this help message and exit]" "(- : *)"{-h,--help}"[show this help message and exit]"
"--color[Whether to use color in output. Defaults to \`\%(default)s\`.]:color:" "--color[Whether to use color in output. Defaults to 'auto']:color:(auto always never)"
) )
_pre_commit_try_repo_options=( _pre_commit_try_repo_options=(
"(- : *)"{-h,--help}"[show this help message and exit]" "(- : *)"{-h,--help}"[show this help message and exit]"
"--color[Whether to use color in output. Defaults to \`\%(default)s\`.]:color:" "--color[Whether to use color in output. Defaults to 'auto']:color:(auto always never)"
{-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'" {-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'"
{--ref,--rev}"[Manually select a rev to run against, otherwise the \`HEAD\` revision will be used.]:ref:" {--ref,--rev}"[Manually select a rev to run against, otherwise 'HEAD']:ref:"
{--verbose,-v}"[]" {--verbose,-v}"[verbose output]"
{--all-files,-a}"[Run on all the files in the repo.]" {--all-files,-a}"[Run on all the files in the repo]"
"--files[Specific filenames to run hooks on.]:files:_files" "--files[Specific filenames to run hooks on]:files:_files"
"--show-diff-on-failure[When hooks fail, run \`git diff\` directly afterward.]" "--show-diff-on-failure[When hooks fail, run 'git diff' directly afterward]"
"--hook-stage[The stage during which the hook is fired. One of \%(choices)s]:hook_stage:(commit merge-commit prepare-commit-msg commit-msg post-commit manual post-checkout push post-merge post-rewrite)" "--hook-stage[The stage during which the hook is fired]:hook_stage:(commit merge-commit prepare-commit-msg commit-msg post-commit manual post-checkout push post-merge post-rewrite)"
"--remote-branch[Remote branch ref used by \`git push\`.]:remote_branch:" "--remote-branch[Remote branch ref used by 'git push']:remote_branch:"
"--local-branch[Local branch ref used by \`git push\`.]:local_branch:" "--local-branch[Local branch ref used by 'git push']:local_branch:"
{--from-ref,--source,-s}"[(for usage with \`--to-ref\`) -- this option represents the original ref in a \`from_ref...to_ref\` diff expression. For \`pre-push\` hooks, this represents the branch you are pushing to. For \`post-checkout\` hooks, this represents the branch that was previously checked out.]:from_ref:" {--from-ref,--source,-s}"[the original ref in a 'from_ref...to_ref' diff expression]:from_ref:"
{--to-ref,--origin,-o}"[(for usage with \`--from-ref\`) -- this option represents the destination ref in a \`from_ref...to_ref\` diff expression. For \`pre-push\` hooks, this represents the branch being pushed. For \`post-checkout\` hooks, this represents the branch that is now checked out.]:to_ref:" {--to-ref,--origin,-o}"[the destination ref in a 'from_ref...to_ref' diff expression]:to_ref:"
"--commit-msg-filename[Filename to check when running during \`commit-msg\`]:commit_msg_filename:" "--commit-msg-filename[Filename to check when running during 'commit-msg']:commit_msg_filename:"
"--prepare-commit-message-source[Source of the commit message (typically the second argument to .git\/hooks\/prepare-commit-msg)]:prepare_commit_message_source:" "--prepare-commit-message-source[Source of the commit message]:prepare_commit_message_source:"
"--commit-object-name[Commit object name (typically the third argument to .git\/hooks\/prepare-commit-msg)]:commit_object_name:" "--commit-object-name[Commit object name]:commit_object_name:"
"--remote-name[Remote name used by \`git push\`.]:remote_name:" "--remote-name[Remote name used by 'git push']:remote_name:"
"--remote-url[Remote url used by \`git push\`.]:remote_url:" "--remote-url[Remote url used by 'git push']:remote_url:"
"--checkout-type[Indicates whether the checkout was a branch checkout (changing branches, flag\=1) or a file checkout (retrieving a file from the index, flag\=0).]:checkout_type:" "--checkout-type[Indicates whether the checkout was a branch checkout or a file checkout]:checkout_type:((0\:file\ checkout 1\:branch\ checkout))"
"--is-squash-merge[During a post-merge hook, indicates whether the merge was a squash merge]:is_squash_merge:" "--is-squash-merge[During a post-merge hook, indicates whether the merge was a squash merge]:is_squash_merge:"
"--rewrite-command[During a post-rewrite hook, specifies the command that invoked the rewrite]:rewrite_command:" "--rewrite-command[During a post-rewrite hook, specifies the command that invoked the rewrite]:rewrite_command:"
":Repository to source hooks from.:" ":Repository to source hooks from.:"
@ -151,24 +151,23 @@ _pre_commit_try_repo_options=(
_pre_commit_uninstall_options=( _pre_commit_uninstall_options=(
"(- : *)"{-h,--help}"[show this help message and exit]" "(- : *)"{-h,--help}"[show this help message and exit]"
"--color[Whether to use color in output. Defaults to \`\%(default)s\`.]:color:" "--color[Whether to use color in output. Defaults to 'auto']:color:(auto always never)"
{-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'" {-c,--config}"[Path to alternate config file]:config:_files -g '*.yaml'"
"*"{-t,--hook-type}"[]:hook_types:(pre-commit pre-merge-commit pre-push prepare-commit-msg commit-msg post-commit post-checkout post-merge post-rewrite)" "*"{-t,--hook-type}"[which hook type to uninstall]:hook_types:(pre-commit pre-merge-commit pre-push prepare-commit-msg commit-msg post-commit post-checkout post-merge post-rewrite)"
) )
_pre_commit_validate_config_options=( _pre_commit_validate_config_options=(
"(- : *)"{-h,--help}"[show this help message and exit]" "(- : *)"{-h,--help}"[show this help message and exit]"
"--color[Whether to use color in output. Defaults to \`\%(default)s\`.]:color:" "--color[Whether to use color in output. Defaults to 'auto']:color:(auto always never)"
"(*)::filenames:" "(*)::filenames:_files"
) )
_pre_commit_validate_manifest_options=( _pre_commit_validate_manifest_options=(
"(- : *)"{-h,--help}"[show this help message and exit]" "(- : *)"{-h,--help}"[show this help message and exit]"
"--color[Whether to use color in output. Defaults to \`\%(default)s\`.]:color:" "--color[Whether to use color in output. Defaults to 'auto']:color:(auto always never)"
"(*)::filenames:" "(*)::filenames:_files"
) )
_pre_commit() { _pre_commit() {
local context state line curcontext="$curcontext" one_or_more='(-)*' reminder='(*)' local context state line curcontext="$curcontext" one_or_more='(-)*' reminder='(*)'
@ -201,8 +200,6 @@ _pre_commit() {
esac esac
} }
typeset -A opt_args typeset -A opt_args
_pre_commit "$@" _pre_commit "$@"