programmer/intermodal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix Z Shell completions

Browse Source 
The clap-generated zsh completion scripts use unescaped double-quoted
strings for the subocommand description text, which causes backtick
characters to be evaluated.

Remove backticks from the subcommand descriptions, to un-break the zsh
completion scripts.

type: fixed
pr: https://github.com/casey/intermodal/pull/365
This commit is contained in:
Casey Rodarmor 2020-04-11 04:17:09 -07:00
parent f05807290b
commit 727d5c1028
No known key found for this signature in database
GPG Key ID: 556186B153EC6FE0
22 changed files with 47 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -4,7 +4,8 @@ Changelog
UNRELEASED - 2020-04-11 UNRELEASED - 2020-04-11
----------------------- -----------------------
- :books: [`xxxxxxxxxxxx`](https://github.com/casey/intermodal/commits/master) Render command help text in book to avoid wrapping ([#364](https://github.com/casey/intermodal/pull/364)) - _Casey Rodarmor <casey@rodarmor.com>_ - :bug: [`xxxxxxxxxxxx`](https://github.com/casey/intermodal/commits/master) Fix Z Shell completions ([#365](https://github.com/casey/intermodal/pull/365)) - _Casey Rodarmor <casey@rodarmor.com>_
- :books: [`f05807290b31`](https://github.com/casey/intermodal/commit/f05807290b314cd68e8679a9aba92e5cd3c5403d) Render command help text in book to avoid wrapping ([#364](https://github.com/casey/intermodal/pull/364)) - _Casey Rodarmor <casey@rodarmor.com>_
- :books: [`ed34ff48a740`](https://github.com/casey/intermodal/commit/ed34ff48a7406adb8b4cdb523b5dc1bf9435e1bc) Add `fuchsi/maketorrent` to prior art table ([#362](https://github.com/casey/intermodal/pull/362)) - _Casey Rodarmor <casey@rodarmor.com>_ - :books: [`ed34ff48a740`](https://github.com/casey/intermodal/commit/ed34ff48a7406adb8b4cdb523b5dc1bf9435e1bc) Add `fuchsi/maketorrent` to prior art table ([#362](https://github.com/casey/intermodal/pull/362)) - _Casey Rodarmor <casey@rodarmor.com>_
- :books: [`a3f46187229f`](https://github.com/casey/intermodal/commit/a3f46187229f499e7a13ec5ce656408ba95d1dcc) Rename distributing large datasets ([#361](https://github.com/casey/intermodal/pull/361)) - _Casey Rodarmor <casey@rodarmor.com>_ - :books: [`a3f46187229f`](https://github.com/casey/intermodal/commit/a3f46187229f499e7a13ec5ce656408ba95d1dcc) Rename distributing large datasets ([#361](https://github.com/casey/intermodal/pull/361)) - _Casey Rodarmor <casey@rodarmor.com>_
- :books: [`1c9ff0cde491`](https://github.com/casey/intermodal/commit/1c9ff0cde4910f369e75930257ce92a8cf4c6cd5) Add suggestions for distributing large datasets to book ([#360](https://github.com/casey/intermodal/pull/360)) - _Casey Rodarmor <casey@rodarmor.com>_ - :books: [`1c9ff0cde491`](https://github.com/casey/intermodal/commit/1c9ff0cde4910f369e75930257ce92a8cf4c6cd5) Add suggestions for distributing large datasets to book ([#360](https://github.com/casey/intermodal/pull/360)) - _Casey Rodarmor <casey@rodarmor.com>_

2
book/src/commands/imdl-torrent-create.md
View File

@ -1,7 +1,7 @@
# `imdl torrent create` # `imdl torrent create`
``` ```
imdl-torrent-create 0.1.4 imdl-torrent-create 0.1.4
Create a `.torrent` file. Create a .torrent file.
USAGE: USAGE:
imdl torrent create [FLAGS] [OPTIONS] --input <PATH> imdl torrent create [FLAGS] [OPTIONS] --input <PATH>

2
book/src/commands/imdl-torrent-link.md
View File

@ -1,7 +1,7 @@
# `imdl torrent link` # `imdl torrent link`
``` ```
imdl-torrent-link 0.1.4 imdl-torrent-link 0.1.4
Generate a magnet link from a `.torrent` file. Generate a magnet link from a .torrent file.
USAGE: USAGE:
imdl torrent link [FLAGS] [OPTIONS] --input <METAINFO> imdl torrent link [FLAGS] [OPTIONS] --input <METAINFO>

2
book/src/commands/imdl-torrent-show.md
View File

@ -1,7 +1,7 @@
# `imdl torrent show` # `imdl torrent show`
``` ```
imdl-torrent-show 0.1.4 imdl-torrent-show 0.1.4
Display information about a `.torrent` file. Display information about a .torrent file.
USAGE: USAGE:
imdl torrent show --input <PATH> imdl torrent show --input <PATH>

2
book/src/commands/imdl-torrent-stats.md
View File

@ -1,7 +1,7 @@
# `imdl torrent stats` # `imdl torrent stats`
``` ```
imdl-torrent-stats 0.1.4 imdl-torrent-stats 0.1.4
Show statistics about a collection of `.torrent` files. Show statistics about a collection of .torrent files.
USAGE: USAGE:
imdl torrent stats [FLAGS] [OPTIONS] --input <PATH> imdl torrent stats [FLAGS] [OPTIONS] --input <PATH>

2
book/src/commands/imdl-torrent-verify.md
View File

@ -1,7 +1,7 @@
# `imdl torrent verify` # `imdl torrent verify`
``` ```
imdl-torrent-verify 0.1.4 imdl-torrent-verify 0.1.4
Verify files against a `.torrent` file. Verify files against a .torrent file.
USAGE: USAGE:
imdl torrent verify [OPTIONS] --input <METAINFO> imdl torrent verify [OPTIONS] --input <METAINFO>

10
book/src/commands/imdl-torrent.md
View File

@ -11,14 +11,14 @@ FLAGS:
-V, --version Print version number. -V, --version Print version number.
SUBCOMMANDS: SUBCOMMANDS:
create Create a `.torrent` file. create Create a .torrent file.
help Prints this message or the help of the given help Prints this message or the help of the given
subcommand(s) subcommand(s)
link Generate a magnet link from a `.torrent` file. link Generate a magnet link from a .torrent file.
piece-length Display information about automatic piece length piece-length Display information about automatic piece length
selection. selection.
show Display information about a `.torrent` file. show Display information about a .torrent file.
stats Show statistics about a collection of `.torrent` files. stats Show statistics about a collection of .torrent files.
verify Verify files against a `.torrent` file. verify Verify files against a .torrent file.
``` ```

10
completions/imdl.elvish
View File

@ -30,12 +30,12 @@ edit:completion:arg-completer[imdl] = [@words]{
cand --help 'Print help message.' cand --help 'Print help message.'
cand -V 'Print version number.' cand -V 'Print version number.'
cand --version 'Print version number.' cand --version 'Print version number.'
cand create 'Create a `.torrent` file.' cand create 'Create a .torrent file.'
cand link 'Generate a magnet link from a `.torrent` file.' cand link 'Generate a magnet link from a .torrent file.'
cand piece-length 'Display information about automatic piece length selection.' cand piece-length 'Display information about automatic piece length selection.'
cand show 'Display information about a `.torrent` file.' cand show 'Display information about a .torrent file.'
cand stats 'Show statistics about a collection of `.torrent` files.' cand stats 'Show statistics about a collection of .torrent files.'
cand verify 'Verify files against a `.torrent` file.' cand verify 'Verify files against a .torrent file.'
cand help 'Prints this message or the help of the given subcommand(s)' cand help 'Prints this message or the help of the given subcommand(s)'
} }
&'imdl;torrent;create'= { &'imdl;torrent;create'= {

10
completions/imdl.fish
View File

@ -7,12 +7,12 @@ complete -c imdl -n "__fish_use_subcommand" -f -a "completions" -d 'Print shell
complete -c imdl -n "__fish_use_subcommand" -f -a "help" -d 'Prints this message or the help of the given subcommand(s)' complete -c imdl -n "__fish_use_subcommand" -f -a "help" -d 'Prints this message or the help of the given subcommand(s)'
complete -c imdl -n "__fish_seen_subcommand_from torrent" -s h -l help -d 'Print help message.' complete -c imdl -n "__fish_seen_subcommand_from torrent" -s h -l help -d 'Print help message.'
complete -c imdl -n "__fish_seen_subcommand_from torrent" -s V -l version -d 'Print version number.' complete -c imdl -n "__fish_seen_subcommand_from torrent" -s V -l version -d 'Print version number.'
complete -c imdl -n "__fish_seen_subcommand_from torrent" -f -a "create" -d 'Create a `.torrent` file.' complete -c imdl -n "__fish_seen_subcommand_from torrent" -f -a "create" -d 'Create a .torrent file.'
complete -c imdl -n "__fish_seen_subcommand_from torrent" -f -a "link" -d 'Generate a magnet link from a `.torrent` file.' complete -c imdl -n "__fish_seen_subcommand_from torrent" -f -a "link" -d 'Generate a magnet link from a .torrent file.'
complete -c imdl -n "__fish_seen_subcommand_from torrent" -f -a "piece-length" -d 'Display information about automatic piece length selection.' complete -c imdl -n "__fish_seen_subcommand_from torrent" -f -a "piece-length" -d 'Display information about automatic piece length selection.'
complete -c imdl -n "__fish_seen_subcommand_from torrent" -f -a "show" -d 'Display information about a `.torrent` file.' complete -c imdl -n "__fish_seen_subcommand_from torrent" -f -a "show" -d 'Display information about a .torrent file.'
complete -c imdl -n "__fish_seen_subcommand_from torrent" -f -a "stats" -d 'Show statistics about a collection of `.torrent` files.' complete -c imdl -n "__fish_seen_subcommand_from torrent" -f -a "stats" -d 'Show statistics about a collection of .torrent files.'
complete -c imdl -n "__fish_seen_subcommand_from torrent" -f -a "verify" -d 'Verify files against a `.torrent` file.' complete -c imdl -n "__fish_seen_subcommand_from torrent" -f -a "verify" -d 'Verify files against a .torrent file.'
complete -c imdl -n "__fish_seen_subcommand_from torrent" -f -a "help" -d 'Prints this message or the help of the given subcommand(s)' complete -c imdl -n "__fish_seen_subcommand_from torrent" -f -a "help" -d 'Prints this message or the help of the given subcommand(s)'
complete -c imdl -n "__fish_seen_subcommand_from create" -s a -l announce -d 'Use `URL` as the primary tracker announce URL. To supply multiple announce URLs, also use `--announce-tier`.' complete -c imdl -n "__fish_seen_subcommand_from create" -s a -l announce -d 'Use `URL` as the primary tracker announce URL. To supply multiple announce URLs, also use `--announce-tier`.'
complete -c imdl -n "__fish_seen_subcommand_from create" -s A -l allow -d 'Allow `LINT`. Lints check for conditions which, although permitted, are not usually desirable. For example, piece length can be any non-zero value, but probably shouldn\'t be below 16 KiB. The lint `small-piece-size` checks for this, and `--allow small-piece-size` can be used to disable this check.' -r -f -a "private-trackerless small-piece-length uneven-piece-length" complete -c imdl -n "__fish_seen_subcommand_from create" -s A -l allow -d 'Allow `LINT`. Lints check for conditions which, although permitted, are not usually desirable. For example, piece length can be any non-zero value, but probably shouldn\'t be below 16 KiB. The lint `small-piece-size` checks for this, and `--allow small-piece-size` can be used to disable this check.' -r -f -a "private-trackerless small-piece-length uneven-piece-length"

10
completions/imdl.powershell
View File

@ -36,12 +36,12 @@ Register-ArgumentCompleter -Native -CommandName 'imdl' -ScriptBlock {
[CompletionResult]::new('--help', 'help', [CompletionResultType]::ParameterName, 'Print help message.') [CompletionResult]::new('--help', 'help', [CompletionResultType]::ParameterName, 'Print help message.')
[CompletionResult]::new('-V', 'V', [CompletionResultType]::ParameterName, 'Print version number.') [CompletionResult]::new('-V', 'V', [CompletionResultType]::ParameterName, 'Print version number.')
[CompletionResult]::new('--version', 'version', [CompletionResultType]::ParameterName, 'Print version number.') [CompletionResult]::new('--version', 'version', [CompletionResultType]::ParameterName, 'Print version number.')
[CompletionResult]::new('create', 'create', [CompletionResultType]::ParameterValue, 'Create a `.torrent` file.') [CompletionResult]::new('create', 'create', [CompletionResultType]::ParameterValue, 'Create a .torrent file.')
[CompletionResult]::new('link', 'link', [CompletionResultType]::ParameterValue, 'Generate a magnet link from a `.torrent` file.') [CompletionResult]::new('link', 'link', [CompletionResultType]::ParameterValue, 'Generate a magnet link from a .torrent file.')
[CompletionResult]::new('piece-length', 'piece-length', [CompletionResultType]::ParameterValue, 'Display information about automatic piece length selection.') [CompletionResult]::new('piece-length', 'piece-length', [CompletionResultType]::ParameterValue, 'Display information about automatic piece length selection.')
[CompletionResult]::new('show', 'show', [CompletionResultType]::ParameterValue, 'Display information about a `.torrent` file.') [CompletionResult]::new('show', 'show', [CompletionResultType]::ParameterValue, 'Display information about a .torrent file.')
[CompletionResult]::new('stats', 'stats', [CompletionResultType]::ParameterValue, 'Show statistics about a collection of `.torrent` files.') [CompletionResult]::new('stats', 'stats', [CompletionResultType]::ParameterValue, 'Show statistics about a collection of .torrent files.')
[CompletionResult]::new('verify', 'verify', [CompletionResultType]::ParameterValue, 'Verify files against a `.torrent` file.') [CompletionResult]::new('verify', 'verify', [CompletionResultType]::ParameterValue, 'Verify files against a .torrent file.')
[CompletionResult]::new('help', 'help', [CompletionResultType]::ParameterValue, 'Prints this message or the help of the given subcommand(s)') [CompletionResult]::new('help', 'help', [CompletionResultType]::ParameterValue, 'Prints this message or the help of the given subcommand(s)')
break break
} }

10
completions/imdl.zsh
View File

@ -314,12 +314,12 @@ _imdl__torrent__stats_commands() {
(( $+functions[_imdl__torrent_commands] )) || (( $+functions[_imdl__torrent_commands] )) ||
_imdl__torrent_commands() { _imdl__torrent_commands() {
local commands; commands=( local commands; commands=(
"create:Create a `.torrent` file." \ "create:Create a .torrent file." \
"link:Generate a magnet link from a `.torrent` file." \ "link:Generate a magnet link from a .torrent file." \
"piece-length:Display information about automatic piece length selection." \ "piece-length:Display information about automatic piece length selection." \
"show:Display information about a `.torrent` file." \ "show:Display information about a .torrent file." \
"stats:Show statistics about a collection of `.torrent` files." \ "stats:Show statistics about a collection of .torrent files." \
"verify:Verify files against a `.torrent` file." \ "verify:Verify files against a .torrent file." \
"help:Prints this message or the help of the given subcommand(s)" \ "help:Prints this message or the help of the given subcommand(s)" \
) )
_describe -t commands 'imdl torrent commands' commands "$@" _describe -t commands 'imdl torrent commands' commands "$@"

2
man/imdl-torrent-create.1
View File

@ -2,7 +2,7 @@
.TH IMDL-TORRENT-CREATE "1" "April 2020" "Intermodal v0.1.4" "Intermodal Manual" .TH IMDL-TORRENT-CREATE "1" "April 2020" "Intermodal v0.1.4" "Intermodal Manual"
.SH NAME .SH NAME
\fBimdl\ torrent\ create\fR \fBimdl\ torrent\ create\fR
- Create a `.torrent` file. - Create a .torrent file.
.SH "SYNOPSIS:" .SH "SYNOPSIS:"
.IP .IP
imdl torrent create [FLAGS] [OPTIONS] \fB\-\-input\fR <PATH> imdl torrent create [FLAGS] [OPTIONS] \fB\-\-input\fR <PATH>

2
man/imdl-torrent-link.1
View File

@ -2,7 +2,7 @@
.TH IMDL-TORRENT-LINK "1" "April 2020" "Intermodal v0.1.4" "Intermodal Manual" .TH IMDL-TORRENT-LINK "1" "April 2020" "Intermodal v0.1.4" "Intermodal Manual"
.SH NAME .SH NAME
\fBimdl\ torrent\ link\fR \fBimdl\ torrent\ link\fR
- Generate a magnet link from a `.torrent` file. - Generate a magnet link from a .torrent file.
.SH "SYNOPSIS:" .SH "SYNOPSIS:"
.IP .IP
imdl torrent link [FLAGS] [OPTIONS] \fB\-\-input\fR <METAINFO> imdl torrent link [FLAGS] [OPTIONS] \fB\-\-input\fR <METAINFO>

2
man/imdl-torrent-show.1
View File

@ -2,7 +2,7 @@
.TH IMDL-TORRENT-SHOW "1" "April 2020" "Intermodal v0.1.4" "Intermodal Manual" .TH IMDL-TORRENT-SHOW "1" "April 2020" "Intermodal v0.1.4" "Intermodal Manual"
.SH NAME .SH NAME
\fBimdl\ torrent\ show\fR \fBimdl\ torrent\ show\fR
- Display information about a `.torrent` file. - Display information about a .torrent file.
.SH "SYNOPSIS:" .SH "SYNOPSIS:"
.IP .IP
imdl torrent show \fB\-\-input\fR <PATH> imdl torrent show \fB\-\-input\fR <PATH>

2
man/imdl-torrent-stats.1
View File

@ -2,7 +2,7 @@
.TH IMDL-TORRENT-STATS "1" "April 2020" "Intermodal v0.1.4" "Intermodal Manual" .TH IMDL-TORRENT-STATS "1" "April 2020" "Intermodal v0.1.4" "Intermodal Manual"
.SH NAME .SH NAME
\fBimdl\ torrent\ stats\fR \fBimdl\ torrent\ stats\fR
- Show statistics about a collection of `.torrent` files. - Show statistics about a collection of .torrent files.
.SH "SYNOPSIS:" .SH "SYNOPSIS:"
.IP .IP
imdl torrent stats [FLAGS] [OPTIONS] \fB\-\-input\fR <PATH> imdl torrent stats [FLAGS] [OPTIONS] \fB\-\-input\fR <PATH>

2
man/imdl-torrent-verify.1
View File

@ -2,7 +2,7 @@
.TH IMDL-TORRENT-VERIFY "1" "April 2020" "Intermodal v0.1.4" "Intermodal Manual" .TH IMDL-TORRENT-VERIFY "1" "April 2020" "Intermodal v0.1.4" "Intermodal Manual"
.SH NAME .SH NAME
\fBimdl\ torrent\ verify\fR \fBimdl\ torrent\ verify\fR
- Verify files against a `.torrent` file. - Verify files against a .torrent file.
.SH "SYNOPSIS:" .SH "SYNOPSIS:"
.IP .IP
imdl torrent verify [OPTIONS] \fB\-\-input\fR <METAINFO> imdl torrent verify [OPTIONS] \fB\-\-input\fR <METAINFO>

10
man/imdl-torrent.1
View File

@ -16,22 +16,22 @@ Print version number.
.SH "SUBCOMMANDS:" .SH "SUBCOMMANDS:"
.TP .TP
create create
Create a `.torrent` file. Create a .torrent file.
.TP .TP
help help
Prints this message or the help of the given subcommand(s) Prints this message or the help of the given subcommand(s)
.TP .TP
link link
Generate a magnet link from a `.torrent` file. Generate a magnet link from a .torrent file.
.TP .TP
piece\-length piece\-length
Display information about automatic piece length selection. Display information about automatic piece length selection.
.TP .TP
show show
Display information about a `.torrent` file. Display information about a .torrent file.
.TP .TP
stats stats
Show statistics about a collection of `.torrent` files. Show statistics about a collection of .torrent files.
.TP .TP
verify verify
Verify files against a `.torrent` file. Verify files against a .torrent file.

2
src/subcommand/torrent/create.rs
View File

@ -9,7 +9,7 @@ mod create_step;
#[structopt( #[structopt(
help_message(consts::HELP_MESSAGE), help_message(consts::HELP_MESSAGE),
version_message(consts::VERSION_MESSAGE), version_message(consts::VERSION_MESSAGE),
about("Create a `.torrent` file.") about("Create a .torrent file.")
)] )]
pub(crate) struct Create { pub(crate) struct Create {
#[structopt( #[structopt(

2
src/subcommand/torrent/link.rs
View File

@ -4,7 +4,7 @@ use crate::common::*;
#[structopt( #[structopt(
help_message(consts::HELP_MESSAGE), help_message(consts::HELP_MESSAGE),
version_message(consts::VERSION_MESSAGE), version_message(consts::VERSION_MESSAGE),
about("Generate a magnet link from a `.torrent` file.") about("Generate a magnet link from a .torrent file.")
)] )]
pub(crate) struct Link { pub(crate) struct Link {
#[structopt( #[structopt(

2
src/subcommand/torrent/show.rs
View File

@ -4,7 +4,7 @@ use crate::common::*;
#[structopt( #[structopt(
help_message(consts::HELP_MESSAGE), help_message(consts::HELP_MESSAGE),
version_message(consts::VERSION_MESSAGE), version_message(consts::VERSION_MESSAGE),
about("Display information about a `.torrent` file.") about("Display information about a .torrent file.")
)] )]
pub(crate) struct Show { pub(crate) struct Show {
#[structopt( #[structopt(

2
src/subcommand/torrent/stats.rs
View File

@ -4,7 +4,7 @@ use crate::common::*;
#[structopt( #[structopt(
help_message(consts::HELP_MESSAGE), help_message(consts::HELP_MESSAGE),
version_message(consts::VERSION_MESSAGE), version_message(consts::VERSION_MESSAGE),
about("Show statistics about a collection of `.torrent` files.") about("Show statistics about a collection of .torrent files.")
)] )]
pub(crate) struct Stats { pub(crate) struct Stats {
#[structopt( #[structopt(

2
src/subcommand/torrent/verify.rs
View File

@ -7,7 +7,7 @@ mod verify_step;
#[structopt( #[structopt(
help_message(consts::HELP_MESSAGE), help_message(consts::HELP_MESSAGE),
version_message(consts::VERSION_MESSAGE), version_message(consts::VERSION_MESSAGE),
about("Verify files against a `.torrent` file.") about("Verify files against a .torrent file.")
)] )]
pub(crate) struct Verify { pub(crate) struct Verify {
#[structopt( #[structopt(