release: 0.1.1

Author: joshstoik1

README.md

@@ -2,6 +2,8 @@
 
 `BashMan` is a Cargo plugin that helps you generate BASH completions and/or MAN pages for your Rust apps using metadata from your projects' `Cargo.toml` manifests. It pairs well with the (unaffiliated) [cargo-deb](https://github.com/mmstick/cargo-deb).
 
+(This can technically be used for non-Rust apps. It just parses the data out of a [TOML](https://en.wikipedia.org/wiki/TOML) file. Any TOML'll do.)
+
 BASH completions are sub-command aware — one level deep — and avoid making duplicate suggestions. For example, if the line already has `-h`, it will not suggest `-h` or its long variant `--help`.
 
 MAN pages are automatically populated with the primary sections — `NAME`, `DESCRIPTION`, `USAGE`, `SUBCOMMANDS`, `FLAGS`, `OPTIONS`, `ARGUMENTS` — and the top level page can be extended with additional arbitrary sections as needed. If subcommands are defined, additional pages for each are generated, showing their particular usage, flags, etc.
@@ -52,8 +54,8 @@ For everything else, start by adding a section to your `Cargo.toml` manifest lik
 ```toml
 [package.metadata.bashman]
 name = "Cargo BashMan"
-bash-dir = "../release/bash_completion.d"
-man-dir = "../release/man1"
+bash-dir = "../release/completions"
+man-dir = "../release/man"
 ```
 
 | Key | Type | Description | Default |
@@ -207,10 +209,17 @@ items = [
 
 Taking `BashMan` as an example, the `Cargo.toml` will end up containing something like:
 ```toml
+[package]
+name = "cargo-bashman"
+version = "0.1.0"
+description = "BashMan is a Cargo plugin that helps you generate BASH completions and/or MAN pages for your Rust project."
+
+...
+
 [package.metadata.bashman]
 name = "Cargo BashMan"
-bash-dir = "../release/bash_completion.d"
-man-dir = "../release/man1"
+bash-dir = "../release/completions"
+man-dir = "../release/man"
 
 [[package.metadata.bashman.switches]]
 short = "-h"

bashman/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cargo-bashman"
-version = "0.1.0"
+version = "0.1.1"
 license = "WTFPL"
 authors = ["Josh Stoik <[email protected]>"]
 edition = "2018"
@@ -16,33 +16,33 @@ depends = "$auto"
 section = "utility"
 assets = [
     ["../target/x86_64-unknown-linux-gnu/release/cargo-bashman", "usr/bin/", "755"],
-    ["../release/bash_completion.d/cargo-bashman.bash", "etc/bash_completion.d/", "644"],
-    ["../release/man1/cargo-bashman.1.gz", "usr/share/man/man1/", "644"],
+    ["../release/completions/cargo-bashman.bash", "etc/bash_completion.d/", "644"],
+    ["../release/man/cargo-bashman.1.gz", "usr/share/man/man1/", "644"],
 ]
 
 [package.metadata.bashman]
 name = "Cargo BashMan"
-bash-dir = "../release/bash_completion.d"
-man-dir = "../release/man1"
+bash-dir = "../release/completions"
+man-dir = "../release/man"
 
 [[package.metadata.bashman.switches]]
 short = "-h"
 long = "--help"
 description = "Print help information."
 subcommands = [ "", "sub" ]
 
+[[package.metadata.bashman.switches]]
+short = "-V"
+long = "--version"
+description = "Print application version."
+
 [[package.metadata.bashman.options]]
 short = "-m"
 long = "--manifest-path"
 description = "Path to the Cargo.toml file to use."
 label = "<Cargo.toml>"
 path = true
 
-[[package.metadata.bashman.switches]]
-short = "-V"
-long = "--version"
-description = "Print application version."
-
 [dependencies]
 chrono = "0.4.*"
 indexmap = "1.6.*"

bashman/help.txt

@@ -310,11 +310,19 @@ fn helper(_: Option<&str>) {
    \_/;-.,____,.-;\_/
 ======(_(_(==)_)_)======
 
-{}
+USAGE:
+    cargo bashman [FLAGS] [OPTIONS]
+
+FLAGS:
+    -h, --help                  Prints help information.
+    -V, --version               Prints version information.
+
+OPTIONS:
+    -m, --manifest-path <FILE>  Read file paths from this list.
+
 ",
         "\x1b[38;5;199mCargo BashMan\x1b[0;38;5;69m v",
         env!("CARGO_PKG_VERSION"),
         "\x1b[0m",
-        include_str!("../help.txt")
     )).print();
 }

bashman/src/main.rs

@@ -41,7 +41,7 @@ rustflags   := "-C link-arg=-s"
 
 # Build Debian package!
 @build-deb: build
-	# Do completions.
+	# Do completions/man.
 	{{ cargo_bin }} -m "{{ pkg_dir1 }}/Cargo.toml"
 
 	# cargo-deb doesn't support target_dir flags yet.

justfile

@@ -1,6 +1,6 @@
-.TH "CARGO BASHMAN" "1" "November 2020" "Cargo BashMan v0.1.0" "User Commands"
+.TH "CARGO BASHMAN" "1" "November 2020" "Cargo BashMan v0.1.1" "User Commands"
 .SH NAME
-Cargo BashMan \- Manual page for cargo\-bashman v0.1.0.
+Cargo BashMan \- Manual page for cargo\-bashman v0.1.1.
 .SH DESCRIPTION
 BashMan is a Cargo plugin that helps you generate BASH completions and/or MAN pages for your Rust project.
 .SS USAGE: