Commit graph

1445 commits

Author SHA1 Message Date
Kevin K
934094d7c5 tests: updates tests for new help wrapping rules 2016-09-07 08:42:42 -04:00
Kevin K
c5a2b352ca docs(Help Wrapping): removes the verbage about using '{n}' to insert newlines in help text 2016-09-07 08:42:10 -04:00
Kevin K
c76785239f imp(Help Wrapping): clap now ignores hard newlines in help messages and properly re-aligns text, but still wraps if the term width is too small
Prior to this commit, clap would mangle help messages with hard newlines
(see #617). After this commit, clap will ignore hard newlines and treat
them like an inserted newline, properly wrapping and aligning text and
then restarting it's count until the next newline should be inserted.

This commit also removes the need for using `{n}` to insert a newline in
help text, now the traditional `\n` can be used. For backwards
compatibility, the `{n}` still works.

Closes #617
2016-09-07 08:38:26 -04:00
Kevin K
0d503504d2 Merge branch 'master' of github.com:kbknapp/clap-rs 2016-09-05 22:12:12 -04:00
Homu
fa5f853469 Auto merge of #648 - kbknapp:help-imps, r=kbknapp
Help imps
2016-09-06 10:29:18 +09:00
Kevin K
60de29a7ef tests: updates test to new help improvements 2016-09-05 20:46:18 -04:00
Kevin K
e4f194c82b chore: increase version 2016-09-05 20:16:09 -04:00
Kevin K
5658b117ae imp(Help Wrapping): makes some minor changes to when next line help is automatically used 2016-09-05 20:14:05 -04:00
Kevin K
01cae7990a imp(Help Wrapping): makes some minor changes to when next line help is automatically used 2016-09-05 19:51:14 -04:00
Homu
7e21b443ba Auto merge of #647 - kbknapp:issue-638, r=kbknapp
Issue 638
2016-09-06 06:39:58 +09:00
Kevin K
3617a1d493 test: updates app_settings tests for new bug fixes 2016-09-05 17:16:40 -04:00
Kevin K
c28d093076 chore: increase version 2016-09-05 17:06:41 -04:00
Kevin K
df06ea61ee chore: updates ansi_term dep 2016-09-05 17:04:32 -04:00
Kevin K
b246be1a4b style: rustfmt run 2016-09-05 17:03:45 -04:00
Kevin K
b3efc10751 fix(Settings): fixes an issue where settings weren't propogated down through grand-child subcommands
In some cases settings were only propogated down one level deep, this
commit ensures settings are propogated down through all subcommands
recursively.

Closes #638
2016-09-05 17:01:22 -04:00
Homu
48bc038e5a Auto merge of #646 - kbknapp:vks-custom-error, r=kbknapp
Vks custom error
2016-09-06 04:57:40 +09:00
Kevin K
07e6e8ea31 style: rustfmt run 2016-09-05 15:29:40 -04:00
Kevin K
c6219ec5ed chore: re-establish beta and udpate clippy nightly pin 2016-09-05 15:16:17 -04:00
Kevin K
956965cc94 chore: clippy run 2016-09-05 15:14:47 -04:00
Kevin K
24a6c61cf8 chore: updates term_size dep 2016-09-05 14:54:52 -04:00
Vinzent Steinberg
58512f2fcb feat(Errors): Errors with custom description
This is useful if a more meaningful message can be displayed to the
user with `Error::exit`. For example, if a file is not found, the
converted `io::Error` will give a message like:

    "error: entity not found"

With this, it is possible to replace this message with a more useful
one, like for instance:

    "error: configuration file not found"

Coloring is respected. Some duplication in the `From::from` impls was
reduced.
2016-09-05 14:54:14 -04:00
Homu
26d5207728 Auto merge of #639 - nabijaczleweli:improvement/help/wrap-use-term_size, r=kbknapp
Use term_size instead of home-grown solution

Ref: #631
2016-09-06 00:18:42 +09:00
nabijaczleweli
fc7327e9dc
imp(help): use term_size instead of home-grown solution 2016-08-29 07:36:06 +02:00
Kevin K
b7793a2f4d Issues rollup (#637)
* feat: adds App::with_defaults to automatically use crate_authors! and crate_version! macros

One can now use

```rust
let a = App::with_defaults("My Program");

// same as
let a2 = App::new("My Program")
	.version(crate_version!())
	.author(crate_authors!());
```

Closes #600

* imp(YAML Errors): vastly improves error messages when using YAML

When errors are made while developing, the panic error messages have
been improved instead of relying on the default panic message which is
extremely unhelpful.

Closes #574

* imp(Completions): uses standard conventions for bash completion files, namely '{bin}.bash-completion'

Closes #567

* imp(Help): automatically moves help text to the next line and wraps when term width is determined to be too small, or help text is too long

Now `clap` will check if it should automatically place long help
messages on the next line after the flag/option. This is determined by
checking to see if the space taken by flag/option plus spaces and values
doesn't leave enough room for the entirety of the help message, with the
single exception of of if the flag/option/spaces/values is less than 25%
of the width.

Closes #597

* tests: updates help tests to new forced new line rules

* fix(Groups): fixes some usage strings that contain both args in groups and ones that conflict with each other

Args that conflict *and* are in a group will now only display in the
group and not in the usage string itself.

Closes #616

* chore: updates dep graph

Closes #633

* chore: clippy run

* style: changes debug header to match other Rust projects

* chore: increase version
2016-08-27 23:42:31 -04:00
Homu
13fe03b033 Auto merge of #635 - kbknapp:issue-634, r=kbknapp
docs: moves docs to docs.rs

Closes #634
2016-08-28 03:14:45 +09:00
Kevin K
03209d5e13 docs: moves docs to docs.rs
Closes #634
2016-08-27 11:16:35 -04:00
Homu
485d993bfd Auto merge of #631 - nabijaczleweli:feature/windows/console-wrap, r=kbknapp
Add support for wrapping help at console width on windows

Had to revert many formatting changes, which means your code is unformatted despite the presence of `rustfmt.toml` at repo root, you should global format.

Closes #455
2016-08-27 00:47:17 +09:00
nabijaczleweli
85999ea7ad
docs(app): document that Windooze supports term width detection now 2016-08-26 17:18:24 +02:00
nabijaczleweli
0d93d9b953
feat(help): support wrapping help at console width on windows
Closes #455
2016-08-26 17:18:24 +02:00
Jędrzej
853a90de01 docs(app): fix documentation formatting for App::template() (#632) 2016-08-26 11:16:32 -04:00
Homu
c95b0c62ab Auto merge of #630 - nabijaczleweli:docs/arggroup/example-2-fix, r=kbknapp
Fix ArgGroup example not formatted as code

Before:
![before image](https://cloud.githubusercontent.com/assets/6709544/18002834/a7516e88-6b8a-11e6-9212-4488e447ce61.png)

After:
![after image](https://cloud.githubusercontent.com/assets/6709544/18002850/bdc0a80a-6b8a-11e6-8887-c5cd882a0b10.png)
2016-08-26 22:44:21 +09:00
nabijaczleweli
ecfda7d434
docs(arggroup): fix example not formatted as code 2016-08-26 12:40:38 +02:00
Homu
2df109a428 Auto merge of #629 - kbknapp:issue-626, r=kbknapp
Issue 626
2016-08-26 08:45:37 +09:00
Kevin K
f7c787c1ce chore: increase version 2016-08-25 18:52:15 -04:00
Kevin K
cdb9037c15 tests: updates tests to account for variable term widths and non-english chars 2016-08-25 18:50:48 -04:00
Kevin K
d0b442c7be fix(Help Wrapping): fixes a bug where help is wrapped incorrectly and causing a panic with some non-English characters
Closes #626
2016-08-25 18:50:13 -04:00
Homu
bd704e0d4f Auto merge of #628 - kbknapp:issues-625,626, r=kbknapp
Issues 625,626
2016-08-25 11:23:26 +09:00
Kevin K
57690b2af1 chore: allows wrapping help on windows 2016-08-24 22:04:19 -04:00
Kevin K
84ad746ee5 chore: increase version 2016-08-24 21:55:01 -04:00
Kevin K
763a5c920e fix(Unicode): fixes two bugs where non-English characters were stripped or caused a panic with help wrapping
Closes #626
2016-08-24 21:50:27 -04:00
Kevin K
881a647ee9 tests: adds tests to prevent issue 626 2016-08-24 21:50:20 -04:00
Kevin K
00b8205d22 docs(Term Width): adds details about set_term_width(0) 2016-08-24 19:39:31 -04:00
Kevin K
7558261c88 tests: adds tests for ignoring term width with set_term_width(0) 2016-08-24 19:39:31 -04:00
Kevin K
7dfdaf200e feat(Help): adds new short hand way to use source formatting and ignore term width in help messages
Prior to this commit if one wished to use source formatting and ignore
term width they could do `App::set_term_width(usize::MAX)` now one can
also use `App::set_term_width(0)` which does the same thing.

Closes #625
2016-08-24 19:39:31 -04:00
Homu
0bda63a492 Auto merge of #627 - dguo:patch-1, r=kbknapp
chore: update dep

Fixes a panic when Jaro is called with strings each with a length of one. A `clap` user discovered this: dguo/strsim-rs#5
2016-08-25 08:12:26 +09:00
Danny Guo
bb23284056 chore: update dep
Fixes a panic when Jaro is called with strings each with a length of one
2016-08-23 23:19:26 -04:00
Homu
0ca6f851df Auto merge of #624 - kbknapp:issue-623, r=kbknapp
Issue 623
2016-08-22 10:11:49 +09:00
Kevin K
8ecb02d0b4 chore: increase version 2016-08-21 20:46:57 -04:00
Kevin K
a643fb283a fix: fixes a bug where the help is printed twice
Closes #623
2016-08-21 20:45:12 -04:00
Homu
b4869959c6 Auto merge of #621 - kbknapp:v2.10.1, r=kbknapp
chore: increase version
2016-08-21 13:51:29 +09:00