fork/cargo

git clone https://git.julia.blue/fork/cargo

Weihang Lofeat (publish): deprecate `--token` option (#16046)8a8ef3e9c

0.93.0
23.9 KiB479 linesraw
1#compdef cargo
2
3autoload -U regexp-replace
4
5_cargo() {
6    local curcontext="$curcontext" ret=1
7    local -a command_scope_spec common parallel features 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                        '--build-plan[output the build plan in JSON]' \
115                        '--ignore-rust-version[Ignore rust-version specification in packages]'
116                        ;;
117
118                check | c)
119                    _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \
120                        '--all-targets[equivalent to specifying --lib --bins --tests --benches --examples]' \
121                        "${command_scope_spec[@]}" \
122                        '(-p --package)'{-p+,--package=}'[specify package to check]:package:_cargo_package_names' \
123                        '--release[check in release mode]' \
124                        '--ignore-rust-version[Ignore rust-version specification in packages]'
125                        ;;
126
127                clean)
128                    _arguments -s -S $common $triple $target $manifest \
129                        '(-p --package)'{-p+,--package=}'[specify package to clean]:package:_cargo_package_names' \
130                        '--release[clean release artifacts]' \
131                        '--doc[clean just the documentation directory]'
132                        ;;
133
134                doc | d)
135                    _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \
136                        '--no-deps[do not build docs for dependencies]' \
137                        '--document-private-items[include non-public items in the documentation]' \
138                        '--open[open docs in browser after the build]' \
139                        '(-p --package)'{-p+,--package=}'[specify package to document]:package:_cargo_package_names' \
140                        '--release[build artifacts in release mode, with optimizations]' \
141                        '--ignore-rust-version[Ignore rust-version specification in packages]'
142                        ;;
143
144                fetch)
145                    _arguments -s -S $common $triple $manifest
146                        ;;
147
148                fix)
149                    _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \
150                        "${command_scope_spec[@]}" \
151                        '--broken-code[fix code even if it already has compiler errors]' \
152                        '--edition[fix in preparation for the next edition]' \
153                        '--edition-idioms[fix warnings to migrate to the idioms of an edition]' \
154                        '--allow-no-vcs[fix code even if a VCS was not detected]' \
155                        '--allow-dirty[fix code even if the working directory is dirty]' \
156                        '--allow-staged[fix code even if the working directory has staged changes]' \
157                        '--ignore-rust-version[Ignore rust-version specification in packages]'
158                ;;
159
160                generate-lockfile)
161                    _arguments -s -S $common $manifest
162                        ;;
163
164                help)
165                    _cargo_cmds
166                        ;;
167                info)
168                    _arguments -s -A "^--" $common $registry \
169                        '--index=[specify registry index]:index' \
170                        '*: :_guard "^-*" "crate"'
171                        ;;
172
173                init)
174                    _arguments -s -S $common $registry \
175                        '--lib[use library template]' \
176                        '--edition=[specify edition to set for the crate generated]:edition:(2015 2018 2021)' \
177                        '--vcs=[initialize a new repo with a given VCS]:vcs:(git hg pijul fossil none)' \
178                        '--name=[set the resulting package name]:name' \
179                        '1:path:_directories'
180                        ;;
181
182                install)
183                    _arguments -s -S $common $parallel $features $triple $registry \
184                        '(-f --force)'{-f,--force}'[force overwriting of existing crates or binaries]' \
185                        '--bin=[only install the specified binary]:binary' \
186                        '--branch=[branch to use when installing from git]:branch' \
187                        '--debug[Build in debug mode (with the "dev" profile) instead of release mode]' \
188                        '--example=[install the specified example instead of binaries]:example:_cargo_example_names' \
189                        '--git=[specify URL from which to install the crate]:url:_urls' \
190                        '--path=[local filesystem path to crate to install]: :_directories' \
191                        '--rev=[specific commit to use when installing from git]:commit' \
192                        '--root=[directory to install packages into]: :_directories' \
193                        '--tag=[tag to use when installing from git]:tag' \
194                        '--version=[version to install from crates.io]:version' \
195                        '--list[list all installed packages and their versions]' \
196                        '--ignore-rust-version[Ignore rust-version specification in packages]' \
197                        '*: :_guard "^-*" "crate"'
198                        ;;
199
200                locate-project)
201                    _arguments -s -S $common $manifest \
202                        '--message-format=[specify output representation]:output representation [json]:(json plain)' \
203                        '--workspace[locate Cargo.toml of the workspace root]'
204                        ;;
205
206                login)
207                    _arguments -s -S $common $registry \
208                        '*: :_guard "^-*" "token"'
209                        ;;
210
211                metadata)
212                    _arguments -s -S $common $features $manifest \
213                        "--no-deps[output information only about the root package and don't fetch dependencies]" \
214                        '--format-version=[specify format version]:version [1]:(1)'
215                        ;;
216
217                new)
218                    _arguments -s -S $common $registry \
219                        '--lib[use library template]' \
220                        '--vcs:initialize a new repo with a given VCS:(git hg none)' \
221                        '--name=[set the resulting package name]'
222                        ;;
223
224                owner)
225                    _arguments -s -S $common $registry \
226                        '(-a --add)'{-a,--add}'[specify name of a user or team to invite as an owner]:name' \
227                        '--index=[specify registry index]:index' \
228                        '(-l --list)'{-l,--list}'[list owners of a crate]' \
229                        '(-r --remove)'{-r,--remove}'[specify name of a user or team to remove as an owner]:name' \
230                        '--token=[specify API token to use when authenticating]:token' \
231                        '*: :_guard "^-*" "crate"'
232                        ;;
233
234                package)
235                    _arguments -s -S $common $parallel $features $triple $target $manifest $registry \
236                        '--index=[specify registry index]:index' \
237                        '(-l --list)'{-l,--list}'[print files included in a package without making one]' \
238                        '--no-metadata[ignore warnings about a lack of human-usable metadata]' \
239                        '--allow-dirty[allow dirty working directories to be packaged]' \
240                        "--no-verify[don't build to verify contents]"
241                        ;;
242
243                pkgid)
244                    _arguments -s -S $common $manifest \
245                        '(-p --package)'{-p+,--package=}'[specify package to get ID specifier for]:package:_cargo_package_names' \
246                        '*: :_guard "^-*" "spec"'
247                        ;;
248
249                publish)
250                    _arguments -s -S $common $parallel $features $triple $target $manifest $registry \
251                        '--index=[specify registry index]:index' \
252                        '--allow-dirty[allow dirty working directories to be packaged]' \
253                        "--no-verify[don't verify the contents by building them]" \
254                        '--dry-run[perform all checks without uploading]'
255                        ;;
256
257                remove | rm)
258                    _arguments -s -A "^--" $common $manifest \
259                        "--dev[remove as a dev dependency]" \
260                        "--build[remove as a build dependency]" \
261                        "--target=[remove as a dependency from the given target platform]" \
262                        "--dry-run[don't actually write the manifest]" \
263                        '(-p --package)'{-p+,--package=}'[package to remove from]:package:_cargo_package_names' \
264                        '1: :_guard "^-*" "crate name"' \
265                        '*:args:_default'
266                        ;;
267
268                run | r)
269                    _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \
270                        '--example=[name of the bin target]:name:_cargo_example_names' \
271                        '--bin=[name of the bin target]:name' \
272                        '(-p --package)'{-p+,--package=}'[specify package with the target to run]:package:_cargo_package_names' \
273                        '--release[build in release mode]' \
274                        '--ignore-rust-version[Ignore rust-version specification in packages]' \
275                        '*: :_default'
276                        ;;
277
278                rustc)
279                    _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \
280                        '(-p --package)'{-p+,--package=}'[specify package to build]:package:_cargo_package_names' \
281                        '--profile=[specify profile to build the selected target for]:profile' \
282                        '--release[build artifacts in release mode, with optimizations]' \
283                        "${command_scope_spec[@]}" \
284                        '--ignore-rust-version[Ignore rust-version specification in packages]' \
285                        '*: : _dispatch rustc rustc -default-'
286                        ;;
287
288                rustdoc)
289                    _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \
290                        '--document-private-items[include non-public items in the documentation]' \
291                        '--open[open the docs in a browser after the operation]' \
292                        '(-p --package)'{-p+,--package=}'[specify package to document]:package:_cargo_package_names' \
293                        '--release[build artifacts in release mode, with optimizations]' \
294                        "${command_scope_spec[@]}" \
295                        '--ignore-rust-version[Ignore rust-version specification in packages]' \
296                        '*: : _dispatch rustdoc rustdoc -default-'
297                        ;;
298
299                search)
300                    _arguments -s -S $common $registry \
301                        '--index=[specify registry index]:index' \
302                        '--limit=[limit the number of results]:results [10]' \
303                        '*: :_guard "^-*" "query"'
304                        ;;
305
306                test | t)
307                    _arguments -s -S $common $jobs $features $msgfmt $triple $target $manifest \
308                        '--test=[test name]: :_cargo_test_names' \
309                        '--no-fail-fast[run all tests regardless of failure]' \
310                        '--no-run[compile but do not run]' \
311                        '(-p --package)'{-p+,--package=}'[package to run tests for]:package:_cargo_package_names' \
312                        '--all[test all packages in the workspace]' \
313                        '--release[build artifacts in release mode, with optimizations]' \
314                        '1: :_cargo_test_names' \
315                        '(--doc --bin --example --test --bench)--lib[only test library]' \
316                        '(--lib --bin --example --test --bench)--doc[only test documentation]' \
317                        '(--lib --doc --example --test --bench)--bin=[binary name]' \
318                        '(--lib --doc --bin --test --bench)--example=[example name]:_cargo_example_names' \
319                        '(--lib --doc --bin --example --bench)--test=[test name]' \
320                        '(--lib --doc --bin --example --test)--bench=[benchmark name]' \
321                        '--ignore-rust-version[Ignore rust-version specification in packages]' \
322                        '*: :_default'
323                        ;;
324
325                tree)
326                    _arguments -s -S $common $features $triple $manifest \
327                        '(-p --package)'{-p+,--package=}'[package to use as the root]:package:_cargo_package_names' \
328                        '(-i --invert)'{-i+,--invert=}'[invert the tree for the given package]:package:_cargo_package_names' \
329                        '--prefix=[line prefix]:prefix:(depth indent none)' \
330                        '--no-dedupe[repeat shared dependencies]' \
331                        '(-d --duplicates)'{-d,--duplicates}'[packages with multiple versions]' \
332                        '--charset=[utf8 or ascii]:charset:(utf8 ascii)' \
333                        '(-f --format)'{-f,--format=}'[format string]:format' \
334                        '(-e --edges)'{-e,--edges=}'[edge kinds]:kind:(features normal build dev all no-dev no-build no-normal)' \
335                        ;;
336
337                uninstall)
338                    _arguments -s -S $common \
339                        '(-p --package)'{-p+,--package=}'[specify package to uninstall]:package:_cargo_package_names' \
340                        '--bin=[only uninstall the specified binary]:name' \
341                        '--root=[directory to uninstall packages from]: :_files -/' \
342                        '*:crate:_cargo_installed_crates -F line'
343                        ;;
344
345                update)
346                    _arguments -s -S $common $manifest \
347                        '--aggressive=[force dependency update]' \
348                        '--recursive=[force dependency update]' \
349                        "--dry-run[don't actually write the lockfile]" \
350                        '(-p --package)'{-p+,--package=}'[specify package to update]:package:_cargo_package_names' \
351                        '--precise=[update single dependency to precise release]:release' \
352                        '*:package:_cargo_package_names'
353                        ;;
354
355                version)
356                    _arguments -s -S $common
357                        ;;
358
359                yank)
360                    _arguments -s -S $common $registry \
361                        '--version=[specify yank version]:version' \
362                        '--undo[undo a yank, putting a version back into the index]' \
363                        '--index=[specify registry index to yank from]:registry index' \
364                        '--token=[specify API token to use when authenticating]:token' \
365                        '*: :_guard "^-*" "crate"'
366                        ;;
367                *)
368                    # allow plugins to define their own functions
369                    if ! _call_function ret _cargo-${words[1]}; then
370                        # fallback on default completion for unknown commands
371                        _default && ret=0
372                    fi
373                    (( ! ret ))
374                ;;
375            esac
376            ;;
377    esac
378}
379
380_cargo_unstable_flags() {
381    local flags
382    flags=( help ${${${(M)${(f)"$(_call_program flags cargo -Z help)"}:#*--*}/ #-- #/:}##*-Z } )
383    _describe -t flags 'unstable flag' flags
384}
385
386_cargo_installed_crates() {
387    local expl
388    _description crates expl 'crate'
389    compadd "$@" "$expl[@]" - ${${${(f)"$(cargo install --list)"}:# *}%% *}
390}
391
392_cargo_cmds() {
393    local -a commands
394    # This uses Parameter Expansion Flags, which are a built-in Zsh feature.
395    # See more: http://zsh.sourceforge.net/Doc/Release/Expansion.html#Parameter-Expansion-Flags
396    # and       http://zsh.sourceforge.net/Doc/Release/Expansion.html#Parameter-Expansion
397    #
398    # # How this work?
399    #
400    # First it splits the result of `cargo --list` at newline, then it removes the first line.
401    # Then it removes indentation (4 whitespaces) before each items. (Note the x## pattern [1]).
402    # Then it replaces those spaces between item and description with a `:`
403    #
404    # [1]: https://github.com/zsh-users/zsh-completions/blob/master/zsh-completions-howto.org#patterns
405    commands=( ${${${(M)"${(f)$(_call_program commands cargo --list)}":#    *}/ ##/}/ ##/:} )
406    _describe -t commands 'command' commands
407}
408
409_cargo_target_triple() {
410    local -a result
411
412    if (( $+commands[rustup] )); then
413        result=( ${(f)"$(rustup target list --installed)"} )
414    else
415        result=( ${(f)"$(rustc --print target-list)"} )
416    fi
417
418    _describe 'target triple' result
419}
420
421#FIXME: Disabled until fixed
422#gets package names from the manifest file
423_cargo_package_names() {
424    _message -e packages package
425}
426
427# Extracts the values of "name" from the array given in $1 and shows them as
428# command line options for completion
429_cargo_names_from_array() {
430    local manifest=$(cargo locate-project --message-format plain)
431    if [[ -z $manifest ]]; then
432        return 0
433    fi
434
435    local last_line
436    local -a names;
437    local in_block=false
438    local block_name=$1
439    names=()
440    while read -r line; do
441        if [[ $last_line == "[[$block_name]]" ]]; then
442            in_block=true
443        else
444            if [[ $last_line =~ '\s*\[\[.*' ]]; then
445                in_block=false
446            fi
447        fi
448
449        if [[ $in_block == true ]]; then
450            if [[ $line =~ '\s*name\s*=' ]]; then
451                regexp-replace line '^\s*name\s*=\s*|"' ''
452                names+=( "$line" )
453            fi
454        fi
455
456        last_line=$line
457    done < "$manifest"
458    _describe "$block_name" names
459
460}
461
462#Gets the test names from the manifest file
463_cargo_test_names() {
464    _cargo_names_from_array "test"
465}
466
467#Gets the bench names from the manifest file
468_cargo_benchmark_names() {
469    _cargo_names_from_array "bench"
470}
471
472_cargo_example_names() {
473    if [[ -d examples ]]; then
474        local -a files=(${(@f)$(echo examples/*.rs(:t:r))})
475        _values 'example' "${files[@]}"
476    fi
477}
478
479_cargo