fork/cargo
git clone https://git.julia.blue/fork/cargo
4aac07d01
master
1#compdef cargo 2 3autoload -U regexp-replace 4 5_cargo() { 6 local curcontext="$curcontext" ret=1 7 local -a command_scope_spec common jobs parallel features manifest msgfmt triple target registry 8 local -a state line state_descr # These are set by _arguments 9 typeset -A opt_args 10 11 common=( 12 '(-q --quiet)*'{-v,--verbose}'[use verbose output]' 13 '(-q --quiet -v --verbose)'{-q,--quiet}'[no output printed to stdout]' 14 '-Z+[pass unstable (nightly-only) flags to cargo]: :_cargo_unstable_flags' 15 '--offline[run without accessing the network]' 16 '--frozen[require that Cargo.lock and cache are up-to-date]' 17 '--locked[require that Cargo.lock is up-to-date]' 18 '--color=[specify colorization option]:coloring:(auto always never)' 19 '(- 1 *)'{-h,--help}'[show help message]' 20 ) 21 22 # leading items in parentheses are an exclusion list for the arguments following that arg 23 # See: http://zsh.sourceforge.net/Doc/Release/Completion-System.html#Completion-Functions 24 # - => exclude all other options 25 # 1 => exclude positional arg 1 26 # * => exclude all other args 27 # +blah => exclude +blah 28 _arguments -s -S -C $common \ 29 '(- 1 *)--list[list installed commands]' \ 30 '(- 1 *)--explain=[provide a detailed explanation of an error message]:error code' \ 31 '(- 1 *)'{-V,--version}'[show version information]' \ 32 '(+beta +nightly)+stable[use the stable toolchain]' \ 33 '(+stable +nightly)+beta[use the beta toolchain]' \ 34 '(+stable +beta)+nightly[use the nightly toolchain]' \ 35 '1: :_cargo_cmds' \ 36 '*:: :->args' 37 38 # These flags are mutually exclusive specifiers for the scope of a command; as 39 # they are used in multiple places without change, they are expanded into the 40 # appropriate command's `_arguments` where appropriate. 41 command_scope_spec=( 42 '(--bin --example --test --lib)--bench=[specify benchmark name]: :_cargo_benchmark_names' 43 '(--bench --bin --test --lib)--example=[specify example name]:example name:_cargo_example_names' 44 '(--bench --example --test --lib)--bin=[specify binary name]:binary name' 45 '(--bench --bin --example --test)--lib=[specify library name]:library name' 46 '(--bench --bin --example --lib)--test=[specify test name]:test name' 47 ) 48 49 jobs=( 50 '(-j --jobs)'{-j+,--jobs=}'[specify number of parallel jobs]:jobs [# of CPUs]' 51 ) 52 53 parallel=( 54 "${jobs[@]}" 55 '--keep-going[do not abort build on first build error]' 56 ) 57 58 features=( 59 '(--all-features)'{-F+,--features=}'[specify features to activate]:feature' 60 '(--features -F)--all-features[activate all available features]' 61 "--no-default-features[don't build the default features]" 62 ) 63 64 msgfmt='--message-format=[specify error format]:error format [human]:(human json short)' 65 triple='--target=[specify target triple]:target triple:_cargo_target_triple' 66 target='--target-dir=[specify directory for all generated artifacts]:directory:_directories' 67 manifest='--manifest-path=[specify path to manifest]:path:_directories' 68 registry='--registry=[specify registry to use]:registry' 69 70 case $state in 71 args) 72 curcontext="${curcontext%:*}-${words[1]}:" 73 case ${words[1]} in 74 add) 75 _arguments -s -A "^--" $common $manifest $registry \ 76 {-F+,--features=}'[specify features to activate]:feature' \ 77 "--default-features[enable the default features]" \ 78 "--no-default-features[don't enable the default features]" \ 79 "--optional[mark the dependency as optional]" \ 80 "--no-optional[mark the dependency as required]" \ 81 "--dev[add as a dev dependency]" \ 82 "--build[add as a build dependency]" \ 83 "--target=[add as a dependency to the given target platform]" \ 84 "--rename=[rename the dependency]" \ 85 "--dry-run[don't actually write the manifest]" \ 86 '--branch=[branch to use when adding from git]:branch' \ 87 '--git=[specify URL from which to add the crate]:url:_urls' \ 88 '--path=[local filesystem path to crate to add]: :_directories' \ 89 '--rev=[specific commit to use when adding from git]:commit' \ 90 '--tag=[tag to use when adding from git]:tag' \ 91 '--ignore-rust-version[Ignore rust-version specification in packages]' \ 92 '1: :_guard "^-*" "crate name"' \ 93 '*:args:_default' 94 ;; 95 bench) 96 _arguments -s -A "^--" $common $jobs $features $msgfmt $triple $target $manifest \ 97 "${command_scope_spec[@]}" \ 98 '--all-targets[benchmark all targets]' \ 99 "--no-run[compile but don't run]" \ 100 '(-p --package)'{-p+,--package=}'[specify package to run benchmarks for]:package:_cargo_package_names' \ 101 '--exclude=[exclude packages from the benchmark]:spec' \ 102 '--no-fail-fast[run all benchmarks regardless of failure]' \ 103 '--ignore-rust-version[Ignore rust-version specification in packages]' \ 104 '1: :_guard "^-*" "bench name"' \ 105 '*:args:_default' 106 ;; 107 108 build | b) 109 _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \ 110 '--all-targets[equivalent to specifying --lib --bins --tests --benches --examples]' \ 111 "${command_scope_spec[@]}" \ 112 '(-p --package)'{-p+,--package=}'[specify package to build]:package:_cargo_package_names' \ 113 '--release[build in release mode]' \ 114 '--ignore-rust-version[Ignore rust-version specification in packages]' 115 ;; 116 117 check | c) 118 _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \ 119 '--all-targets[equivalent to specifying --lib --bins --tests --benches --examples]' \ 120 "${command_scope_spec[@]}" \ 121 '(-p --package)'{-p+,--package=}'[specify package to check]:package:_cargo_package_names' \ 122 '--release[check in release mode]' \ 123 '--ignore-rust-version[Ignore rust-version specification in packages]' 124 ;; 125 126 clean) 127 _arguments -s -S $common $triple $target $manifest \ 128 '(-p --package)'{-p+,--package=}'[specify package to clean]:package:_cargo_package_names' \ 129 '--release[clean release artifacts]' \ 130 '--doc[clean just the documentation directory]' 131 ;; 132 133 doc | d) 134 _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \ 135 '--no-deps[do not build docs for dependencies]' \ 136 '--document-private-items[include non-public items in the documentation]' \ 137 '--open[open docs in browser after the build]' \ 138 '(-p --package)'{-p+,--package=}'[specify package to document]:package:_cargo_package_names' \ 139 '--release[build artifacts in release mode, with optimizations]' \ 140 '--ignore-rust-version[Ignore rust-version specification in packages]' 141 ;; 142 143 fetch) 144 _arguments -s -S $common $triple $manifest 145 ;; 146 147 fix) 148 _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \ 149 "${command_scope_spec[@]}" \ 150 '--broken-code[fix code even if it already has compiler errors]' \ 151 '--edition[fix in preparation for the next edition]' \ 152 '--edition-idioms[fix warnings to migrate to the idioms of an edition]' \ 153 '--allow-no-vcs[fix code even if a VCS was not detected]' \ 154 '--allow-dirty[fix code even if the working directory is dirty]' \ 155 '--allow-staged[fix code even if the working directory has staged changes]' \ 156 '--ignore-rust-version[Ignore rust-version specification in packages]' 157 ;; 158 159 generate-lockfile) 160 _arguments -s -S $common $manifest 161 ;; 162 163 help) 164 _cargo_cmds 165 ;; 166 info) 167 _arguments -s -A "^--" $common $registry \ 168 '--index=[specify registry index]:index' \ 169 '*: :_guard "^-*" "crate"' 170 ;; 171 172 init) 173 _arguments -s -S $common $registry \ 174 '--lib[use library template]' \ 175 '--edition=[specify edition to set for the crate generated]:edition:(2015 2018 2021)' \ 176 '--vcs=[initialize a new repo with a given VCS]:vcs:(git hg pijul fossil none)' \ 177 '--name=[set the resulting package name]:name' \ 178 '1:path:_directories' 179 ;; 180 181 install) 182 _arguments -s -S $common $parallel $features $triple $registry \ 183 '(-f --force)'{-f,--force}'[force overwriting of existing crates or binaries]' \ 184 '--bin=[only install the specified binary]:binary' \ 185 '--branch=[branch to use when installing from git]:branch' \ 186 '--debug[Build in debug mode (with the "dev" profile) instead of release mode]' \ 187 '--example=[install the specified example instead of binaries]:example:_cargo_example_names' \ 188 '--git=[specify URL from which to install the crate]:url:_urls' \ 189 '--path=[local filesystem path to crate to install]: :_directories' \ 190 '--rev=[specific commit to use when installing from git]:commit' \ 191 '--root=[directory to install packages into]: :_directories' \ 192 '--tag=[tag to use when installing from git]:tag' \ 193 '--version=[version to install from crates.io]:version' \ 194 '--list[list all installed packages and their versions]' \ 195 '--ignore-rust-version[Ignore rust-version specification in packages]' \ 196 '*: :_guard "^-*" "crate"' 197 ;; 198 199 locate-project) 200 _arguments -s -S $common $manifest \ 201 '--message-format=[specify output representation]:output representation [json]:(json plain)' \ 202 '--workspace[locate Cargo.toml of the workspace root]' 203 ;; 204 205 login) 206 _arguments -s -S $common $registry \ 207 '*: :_guard "^-*" "token"' 208 ;; 209 210 metadata) 211 _arguments -s -S $common $features $manifest \ 212 "--no-deps[output information only about the root package and don't fetch dependencies]" \ 213 '--format-version=[specify format version]:version [1]:(1)' 214 ;; 215 216 new) 217 _arguments -s -S $common $registry \ 218 '--lib[use library template]' \ 219 '--vcs:initialize a new repo with a given VCS:(git hg none)' \ 220 '--name=[set the resulting package name]' 221 ;; 222 223 owner) 224 _arguments -s -S $common $registry \ 225 '(-a --add)'{-a,--add}'[specify name of a user or team to invite as an owner]:name' \ 226 '--index=[specify registry index]:index' \ 227 '(-l --list)'{-l,--list}'[list owners of a crate]' \ 228 '(-r --remove)'{-r,--remove}'[specify name of a user or team to remove as an owner]:name' \ 229 '--token=[specify API token to use when authenticating]:token' \ 230 '*: :_guard "^-*" "crate"' 231 ;; 232 233 package) 234 _arguments -s -S $common $parallel $features $triple $target $manifest $registry \ 235 '--index=[specify registry index]:index' \ 236 '(-l --list)'{-l,--list}'[print files included in a package without making one]' \ 237 '--no-metadata[ignore warnings about a lack of human-usable metadata]' \ 238 '--allow-dirty[allow dirty working directories to be packaged]' \ 239 "--no-verify[don't build to verify contents]" 240 ;; 241 242 pkgid) 243 _arguments -s -S $common $manifest \ 244 '(-p --package)'{-p+,--package=}'[specify package to get ID specifier for]:package:_cargo_package_names' \ 245 '*: :_guard "^-*" "spec"' 246 ;; 247 248 publish) 249 _arguments -s -S $common $parallel $features $triple $target $manifest $registry \ 250 '--index=[specify registry index]:index' \ 251 '--allow-dirty[allow dirty working directories to be packaged]' \ 252 "--no-verify[don't verify the contents by building them]" \ 253 '--dry-run[perform all checks without uploading]' 254 ;; 255 256 remove | rm) 257 _arguments -s -A "^--" $common $manifest \ 258 "--dev[remove as a dev dependency]" \ 259 "--build[remove as a build dependency]" \ 260 "--target=[remove as a dependency from the given target platform]" \ 261 "--dry-run[don't actually write the manifest]" \ 262 '(-p --package)'{-p+,--package=}'[package to remove from]:package:_cargo_package_names' \ 263 '1: :_guard "^-*" "crate name"' \ 264 '*:args:_default' 265 ;; 266 267 run | r) 268 _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \ 269 '--example=[name of the bin target]:name:_cargo_example_names' \ 270 '--bin=[name of the bin target]:name' \ 271 '(-p --package)'{-p+,--package=}'[specify package with the target to run]:package:_cargo_package_names' \ 272 '--release[build in release mode]' \ 273 '--ignore-rust-version[Ignore rust-version specification in packages]' \ 274 '*: :_default' 275 ;; 276 277 rustc) 278 _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \ 279 '(-p --package)'{-p+,--package=}'[specify package to build]:package:_cargo_package_names' \ 280 '--profile=[specify profile to build the selected target for]:profile' \ 281 '--release[build artifacts in release mode, with optimizations]' \ 282 "${command_scope_spec[@]}" \ 283 '--ignore-rust-version[Ignore rust-version specification in packages]' \ 284 '*: : _dispatch rustc rustc -default-' 285 ;; 286 287 rustdoc) 288 _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \ 289 '--document-private-items[include non-public items in the documentation]' \ 290 '--open[open the docs in a browser after the operation]' \ 291 '(-p --package)'{-p+,--package=}'[specify package to document]:package:_cargo_package_names' \ 292 '--release[build artifacts in release mode, with optimizations]' \ 293 "${command_scope_spec[@]}" \ 294 '--ignore-rust-version[Ignore rust-version specification in packages]' \ 295 '*: : _dispatch rustdoc rustdoc -default-' 296 ;; 297 298 search) 299 _arguments -s -S $common $registry \ 300 '--index=[specify registry index]:index' \ 301 '--limit=[limit the number of results]:results [10]' \ 302 '*: :_guard "^-*" "query"' 303 ;; 304 305 test | t) 306 _arguments -s -S $common $jobs $features $msgfmt $triple $target $manifest \ 307 '--test=[test name]: :_cargo_test_names' \ 308 '--no-fail-fast[run all tests regardless of failure]' \ 309 '--no-run[compile but do not run]' \ 310 '(-p --package)'{-p+,--package=}'[package to run tests for]:package:_cargo_package_names' \ 311 '--all[test all packages in the workspace]' \ 312 '--release[build artifacts in release mode, with optimizations]' \ 313 '1: :_cargo_test_names' \ 314 '(--doc --bin --example --test --bench)--lib[only test library]' \ 315 '(--lib --bin --example --test --bench)--doc[only test documentation]' \ 316 '(--lib --doc --example --test --bench)--bin=[binary name]' \ 317 '(--lib --doc --bin --test --bench)--example=[example name]:_cargo_example_names' \ 318 '(--lib --doc --bin --example --bench)--test=[test name]' \ 319 '(--lib --doc --bin --example --test)--bench=[benchmark name]' \ 320 '--ignore-rust-version[Ignore rust-version specification in packages]' \ 321 '*: :_default' 322 ;; 323 324 tree) 325 _arguments -s -S $common $features $triple $manifest \ 326 '(-p --package)'{-p+,--package=}'[package to use as the root]:package:_cargo_package_names' \ 327 '(-i --invert)'{-i+,--invert=}'[invert the tree for the given package]:package:_cargo_package_names' \ 328 '--prefix=[line prefix]:prefix:(depth indent none)' \ 329 '--no-dedupe[repeat shared dependencies]' \ 330 '(-d --duplicates)'{-d,--duplicates}'[packages with multiple versions]' \ 331 '--charset=[utf8 or ascii]:charset:(utf8 ascii)' \ 332 '(-f --format)'{-f,--format=}'[format string]:format' \ 333 '(-e --edges)'{-e,--edges=}'[edge kinds]:kind:(features normal build dev all no-dev no-build no-normal)' \ 334 ;; 335 336 uninstall) 337 _arguments -s -S $common \ 338 '(-p --package)'{-p+,--package=}'[specify package to uninstall]:package:_cargo_package_names' \ 339 '--bin=[only uninstall the specified binary]:name' \ 340 '--root=[directory to uninstall packages from]: :_files -/' \ 341 '*:crate:_cargo_installed_crates -F line' 342 ;; 343 344 update) 345 _arguments -s -S $common $manifest \ 346 '--aggressive=[force dependency update]' \ 347 '--recursive=[force dependency update]' \ 348 "--dry-run[don't actually write the lockfile]" \ 349 '(-p --package)'{-p+,--package=}'[specify package to update]:package:_cargo_package_names' \ 350 '--precise=[update single dependency to precise release]:release' \ 351 '*:package:_cargo_package_names' 352 ;; 353 354 version) 355 _arguments -s -S $common 356 ;; 357 358 yank) 359 _arguments -s -S $common $registry \ 360 '--version=[specify yank version]:version' \ 361 '--undo[undo a yank, putting a version back into the index]' \ 362 '--index=[specify registry index to yank from]:registry index' \ 363 '--token=[specify API token to use when authenticating]:token' \ 364 '*: :_guard "^-*" "crate"' 365 ;; 366 *) 367 # allow plugins to define their own functions 368 if ! _call_function ret _cargo-${words[1]}; then 369 # fallback on default completion for unknown commands 370 _default && ret=0 371 fi 372 (( ! ret )) 373 ;; 374 esac 375 ;; 376 esac 377} 378 379_cargo_unstable_flags() { 380 local flags 381 flags=( help ${${${(M)${(f)"$(_call_program flags cargo -Z help)"}:#*--*}/ #-- #/:}##*-Z } ) 382 _describe -t flags 'unstable flag' flags 383} 384 385_cargo_installed_crates() { 386 local expl 387 _description crates expl 'crate' 388 compadd "$@" "$expl[@]" - ${${${(f)"$(cargo install --list)"}:# *}%% *} 389} 390 391_cargo_cmds() { 392 local -a commands 393 # This uses Parameter Expansion Flags, which are a built-in Zsh feature. 394 # See more: http://zsh.sourceforge.net/Doc/Release/Expansion.html#Parameter-Expansion-Flags 395 # and http://zsh.sourceforge.net/Doc/Release/Expansion.html#Parameter-Expansion 396 # 397 # # How this work? 398 # 399 # First it splits the result of `cargo --list` at newline, then it removes the first line. 400 # Then it removes indentation (4 whitespaces) before each items. (Note the x## pattern [1]). 401 # Then it replaces those spaces between item and description with a `:` 402 # 403 # [1]: https://github.com/zsh-users/zsh-completions/blob/master/zsh-completions-howto.org#patterns 404 commands=( ${${${(M)"${(f)$(_call_program commands cargo --list)}":# *}/ ##/}/ ##/:} ) 405 _describe -t commands 'command' commands 406} 407 408_cargo_target_triple() { 409 local -a result 410 411 if (( $+commands[rustup] )); then 412 result=( ${(f)"$(rustup target list --installed)"} ) 413 else 414 result=( ${(f)"$(rustc --print target-list)"} ) 415 fi 416 417 _describe 'target triple' result 418} 419 420#FIXME: Disabled until fixed 421#gets package names from the manifest file 422_cargo_package_names() { 423 _message -e packages package 424} 425 426# Extracts the values of "name" from the array given in $1 and shows them as 427# command line options for completion 428_cargo_names_from_array() { 429 local manifest=$(cargo locate-project --message-format plain) 430 if [[ -z $manifest ]]; then 431 return 0 432 fi 433 434 local last_line 435 local -a names; 436 local in_block=false 437 local block_name=$1 438 names=() 439 while read -r line; do 440 if [[ $last_line == "[[$block_name]]" ]]; then 441 in_block=true 442 else 443 if [[ $last_line =~ '\s*\[\[.*' ]]; then 444 in_block=false 445 fi 446 fi 447 448 if [[ $in_block == true ]]; then 449 if [[ $line =~ '\s*name\s*=' ]]; then 450 regexp-replace line '^\s*name\s*=\s*|"' '' 451 names+=( "$line" ) 452 fi 453 fi 454 455 last_line=$line 456 done < "$manifest" 457 _describe "$block_name" names 458 459} 460 461#Gets the test names from the manifest file 462_cargo_test_names() { 463 _cargo_names_from_array "test" 464} 465 466#Gets the bench names from the manifest file 467_cargo_benchmark_names() { 468 _cargo_names_from_array "bench" 469} 470 471_cargo_example_names() { 472 if [[ -d examples ]]; then 473 local -a files=(${(@f)$(echo examples/*.rs(:t:r))}) 474 _values 'example' "${files[@]}" 475 fi 476} 477 478_cargo