release: 0.3.0

Author: joshstoik1

CREDITS.md

@@ -3,7 +3,7 @@
 [![Build Status](https://github.com/Blobfolio/bashman/workflows/Build/badge.svg)](https://github.com/Blobfolio/bashman/actions)
 [![Dependency Status](https://deps.rs/repo/github/blobfolio/bashman/status.svg)](https://deps.rs/repo/github/blobfolio/bashman)
 
-`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).
+`BashMan` is a Cargo plugin that helps you generate BASH completions, MAN pages, and/or a `CREDITS.md` page 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.)
 
@@ -48,12 +48,14 @@ cargo build \
 
 ```bash
 # Generate the stuff for the thing:
-cargo bashman [-m/--manifest-path] /path/to/Cargo.toml
+cargo bashman [--manifest-path /path/to/Cargo.toml]
 
 # You can also pull up help via:
 cargo bashman [-h/--help]
 ```
 
+The flags `--no-bash`, `--no-man`, and `--no-credits` can be used to skip the generation of BASH completions, MAN pages, and/or `CREDITS.md` respectively.
+
 
 ## CONFIGURATION
 
@@ -66,19 +68,24 @@ For everything else, start by adding a section to your `Cargo.toml` manifest lik
 name = "Cargo BashMan"
 bash-dir = "../release/completions"
 man-dir = "../release/man"
+credits-dir = "../"
 ```
 
 | Key | Type | Description | Default |
 | --- | ---- | ----------- | ------- |
 | name | *string* | The proper name of your application. | If not provided, the binary name is used. |
 | bash-dir | *directory* | The output directory for BASH completions. This can be an absolute path, or a path relative to the manifest. | If not provided, the manifest's parent directory is used. |
+| credits-dir | *directory* | The output directory for the `CREDITS.md` dependency list. This can be an absolute path, or a path relative to the manifest. | If not provided, the manifest's parent directory is used. |
 | man-dir | *directory* | The output directory for MAN page(s). This can be an absolute path, or a path relative to the manifest. | If not provided, the manifest's parent directory is used. |
 | subcommands | *array* | An array of your app's subcommands, if any. | |
 | switches | *array* | An array of your app's true/false flags, if any. | |
 | options | *array* | An array of your app's key=value options, if any. | |
 | arguments | *array* | An array of any trailing arguments expected by your app. | |
 | sections | *array* | Arbitrary sections to append to the MAN page. | |
 
+While `bash-dir`, `man-dir`, and `credits-dir` are required, the actual content generation can be skipped by using the CLI flags `--no-bash`, `--no-man`, and/or `--no-credits` respectively.
+
+
 ### SUBCOMMANDS
 
 When adding subcommands, each entry requires the following fields:
@@ -99,6 +106,7 @@ cmd="whale"
 description="Print an underwater message."
 ```
 
+
 ### SWITCHES
 
 A "switch" is a CLI flag that either is or isn't. It can be a short key, like `-h`, or a long key like `--help`, or both. The value is implicitly `true` if the flag is present, or `false` if not.
@@ -126,6 +134,7 @@ description = "Print help information."
 subcommands = [ "call", "text", "" ]
 ```
 
+
 ### OPTIONS
 
 An "option" is exactly like a "switch", except it takes a value. As such, they have a couple more fields:
@@ -156,6 +165,7 @@ label = "<NUM>"
 subcommands = [ "print", "echo" ]
 ```
 
+
 ### ARGUMENTS
 
 A trailing argument is what comes after everything else.
@@ -174,6 +184,7 @@ description = "Files and directories to search."
 subcommands = [ "search" ]
 ```
 
+
 ### SECTIONS
 
 `BashMan` will automatically generate manual sections for:
@@ -215,6 +226,7 @@ items = [
 ]
 ```
 
+
 ### ALL TOGETHER NOW
 
 Taking `BashMan` as an example, the `Cargo.toml` will end up containing something like:
@@ -230,6 +242,7 @@ description = "BashMan is a Cargo plugin that helps you generate BASH completion
 name = "Cargo BashMan"
 bash-dir = "../release/completions"
 man-dir = "../release/man"
+credits-dir = "../"
 
 [[package.metadata.bashman.switches]]
 short = "-h"

README.md

@@ -1,6 +1,6 @@
 [package]
 name = "cargo-bashman"
-version = "0.2.9"
+version = "0.3.0"
 license = "WTFPL"
 authors = ["Josh Stoik <[email protected]>"]
 edition = "2021"
@@ -26,12 +26,24 @@ assets = [
 name = "Cargo BashMan"
 bash-dir = "../release/completions"
 man-dir = "../release/man"
+credits-dir = "../"
 
 [[package.metadata.bashman.switches]]
 short = "-h"
 long = "--help"
 description = "Print help information."
-subcommands = [ "", "sub" ]
+
+[[package.metadata.bashman.switches]]
+long = "--no-bash"
+description = "Do not generate BASH completions."
+
+[[package.metadata.bashman.switches]]
+long = "--no-credits"
+description = "Do not generate CREDITS.md."
+
+[[package.metadata.bashman.switches]]
+long = "--no-man"
+description = "Do not generate MAN page(s)."
 
 [[package.metadata.bashman.switches]]
 short = "-V"

about.toml

@@ -51,12 +51,14 @@ For everything else, start by adding a section to your `Cargo.toml` manifest lik
 name = "Cargo BashMan"
 bash-dir = "../release/bash_completion.d"
 man-dir = "../release/man1"
+credits-dir = "../"
 ```
 
 | Key | Type | Description | Default |
 | --- | ---- | ----------- | ------- |
 | name | *string* | The proper name of your application. | If not provided, the binary name is used. |
 | bash-dir | *directory* | The output directory for BASH completions. This can be an absolute path, or a path relative to the manifest. | If not provided, the manifest's parent directory is used. |
+| credits-dir | *directory* | The output directory for the `CREDITS.md` dependency list. This can be an absolute path, or a path relative to the manifest. | If not provided, the manifest's parent directory is used. |
 | man-dir | *directory* | The output directory for MAN page(s). This can be an absolute path, or a path relative to the manifest. | If not provided, the manifest's parent directory is used. |
 | subcommands | *array* | An array of your app's subcommands, if any. | |
 | switches | *array* | An array of your app's true/false flags, if any. | |
@@ -256,7 +258,13 @@ path = true
 #![allow(clippy::module_name_repetitions)]
 
 
-use bashman_core::BashManError;
+use bashman_core::{
+	BashManError,
+	FLAG_ALL,
+	FLAG_BASH,
+	FLAG_CREDITS,
+	FLAG_MAN,
+};
 use argyle::{
 	Argue,
 	ArgyleError,
@@ -294,6 +302,17 @@ fn _main() -> Result<(), BashManError> {
 	// Parse CLI arguments.
 	let args = Argue::new(FLAG_HELP | FLAG_VERSION).map_err(BashManError::Argue)?;
 
+	let mut flags: u8 = FLAG_ALL;
+	if args.switch(b"--no-bash") {
+		flags &= ! FLAG_BASH;
+	}
+	if args.switch(b"--no-credits") {
+		flags &= ! FLAG_CREDITS;
+	}
+	if args.switch(b"--no-man") {
+		flags &= ! FLAG_MAN;
+	}
+
 	bashman_core::parse(
 		args.option2(b"-m", b"--manifest-path")
 			.map_or_else(
@@ -303,7 +322,8 @@ fn _main() -> Result<(), BashManError> {
 				}),
 				|b| Some(PathBuf::from(OsStr::from_bytes(b)))
 			)
-			.ok_or(BashManError::InvalidManifest)?
+			.ok_or(BashManError::InvalidManifest)?,
+		flags,
 	)?;
 
 	Ok(())
@@ -334,6 +354,9 @@ USAGE:
 
 FLAGS:
     -h, --help                  Prints help information.
+        --no-bash               Do not generate BASH completions.
+        --no-credits            Do not generate CREDITS.md.
+        --no-man                Do not generate MAN page(s).
     -V, --version               Prints version information.
 
 OPTIONS:

bashman/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bashman_core"
-version = "0.2.9"
+version = "0.3.0"
 license = "WTFPL"
 authors = ["Josh Stoik <[email protected]>"]
 edition = "2021"
@@ -11,9 +11,12 @@ publish = false
 
 [dependencies]
 argyle = "0.5.*"
+cargo-license = "0.4.*"
+cargo_metadata = "0.14.*"
 fyi_msg = "0.9.*"
 indexmap = "1.7.*"
 libdeflater = "0.7.*"
+regex = "1.5.*"
 utc2k = "0.3.*"
 
 [dependencies.serde]

bashman/src/main.rs

@@ -5,19 +5,22 @@ This module contains the [`Command`] and related data structures produced from
 [`Raw`]. See that module for more information on why all the windiness.
 */
 
+use cargo_metadata::MetadataCommand;
 use crate::BashManError;
 use fyi_msg::Msg;
 use libdeflater::{
 	CompressionLvl,
 	Compressor,
 };
+use regex::Regex;
 use std::{
 	ffi::OsStr,
 	fs::File,
 	io::Write,
 	os::unix::ffi::OsStrExt,
 	path::Path,
 };
+use utc2k::Utc2k;
 
 
 
@@ -505,6 +508,101 @@ impl<'a> Command<'a> {
 	}
 }
 
+/// # Credits.
+impl<'a> Command<'a> {
+	/// # Write Bash.
+	pub(crate) fn write_credits(&self, manifest: &Path, path: &Path, buf: &mut Vec<u8>) -> Result<(), BashManError> {
+		let re: Regex = Regex::new(r"([^\|]+?) <([^>]+)>").unwrap();
+
+		let meta = {
+			let mut tmp = MetadataCommand::new();
+			tmp.manifest_path(&manifest);
+			tmp
+		};
+
+		let mut raw: Vec<(String, String)> = cargo_license::get_dependencies_from_cargo_lock(
+			meta,
+			true,
+			true,
+		)
+			.map_err(|_| BashManError::InvalidManifest)?
+			.into_iter()
+			.filter_map(|x| {
+				let name = x.name.replace("|", "");
+				if name == self.bin {
+					return None;
+				}
+
+				let version = x.version.to_string().replace("|", "");
+				let author = x.authors.map_or_else(
+					String::new,
+					|y| {
+						let y = y.replace(" <>", "");
+						let z = re.replace_all(&y, "[$1](mailto:$2)");
+						z.replace("|", "; ")
+					},
+				);
+				let license = x.license.map_or_else(
+					|| String::from("Unknown"),
+					|y| y.replace("|", ""),
+				);
+
+				let line = x.repository.map_or_else(
+					|| format!(
+							"\n| {} | {} | {} | {} |",
+							name,
+							version,
+							author,
+							license,
+						),
+					|y| format!(
+							"\n| [{}]({}) | {} | {} | {} |",
+							name,
+							y.replace("|", ""),
+							version,
+							author,
+							license,
+						)
+				);
+
+				Some((name.to_ascii_lowercase(), line))
+			})
+			.collect();
+
+		// Write the header.
+		buf.extend_from_slice(format!(
+			"# Project Dependencies\n    Package:   {}\n    Version:   {}\n    Generated: {} UTC\n",
+			self.bin,
+			self.version,
+			Utc2k::now().to_string(),
+		).as_bytes());
+
+		if raw.is_empty() {
+			buf.extend_from_slice(b"This package has no dependencies.\n");
+		}
+		else {
+			buf.extend_from_slice(b"\n| Package | Version | Author(s) | License |\n| ---- | ---- | ---- | ---- |");
+			raw.sort_by(|a, b| a.0.cmp(&b.0));
+			for (_, line) in raw {
+				buf.extend_from_slice(line.as_bytes());
+			}
+
+			buf.push(b'\n');
+		}
+
+		let mut out = path.to_path_buf();
+		out.push("CREDITS.md");
+
+		// Write plain.
+		File::create(&out)
+			.and_then(|mut f| f.write_all(buf).and_then(|_| f.flush()))
+			.map_err(|_| BashManError::WriteCredits)?;
+
+		Msg::success(format!("Credits written to: {:?}", out)).print();
+		Ok(())
+	}
+}
+
 
 
 #[derive(Debug, Clone)]