release: 0.6.3

Author: joshstoik1

CREDITS.md

@@ -1,6 +1,6 @@
 [package]
 name = "cargo-bashman"
-version = "0.6.2"
+version = "0.6.3"
 license = "WTFPL"
 authors = ["Josh Stoik <[email protected]>"]
 edition = "2021"
@@ -75,7 +75,6 @@ adbyss_psl = "0.14.*"
 dactyl = "0.7.4"
 fyi_msg = "1.1.*"
 oxford_join = "0.4.*"
-serde_json = "1.0.*"
 trimothy = "0.3.*"
 utc2k = "0.11.*"
 write_atomic = "0.5.*"
@@ -92,9 +91,9 @@ features = [ "serde" ]
 version = "1.0.*"
 features = [ "derive" ]
 
-[dependencies.toml]
-version = "0.8.*"
-features = [ "preserve_order" ]
+[dependencies.serde_json]
+version = "1.0.*"
+features = [ "raw_value" ]
 
 [dependencies.url]
 version = "2.5.*"

Cargo.toml

@@ -17,9 +17,11 @@ MAN pages are saved in both plain ("app.1") and GZipped ("app.1.gz") states. Lin
 
 ## Installation
 
+As might be expected, `cargo bashman` requires [`cargo`](https://github.com/rust-lang/cargo). If you don't already have that installed, check out [rustup](https://rustup.rs/) before continuing.
+
 Debian and Ubuntu users can just grab the pre-built `.deb` package from the [latest release](https://github.com/Blobfolio/bashman/releases/latest).
 
-This application is written in [Rust](https://www.rust-lang.org/) and can alternatively be built from source using [Cargo](https://github.com/rust-lang/cargo):
+To build from source:
 
 ```bash
 # Clone the source.
@@ -30,7 +32,7 @@ cd bashman
 
 # Build as usual. Specify additional flags as desired.
 cargo build \
-    --bin bashman \
+    --bin cargo-bashman \
     --release
 ```
 
@@ -52,8 +54,6 @@ 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.
 
-Note that for the `CREDITS.md` feature, [Cargo](https://github.com/rust-lang/cargo) is explicitly required. (It pulls the dependency tree from the `cargo metadata` output.)
-
 
 ## CONFIGURATION
 

README.md

@@ -1,6 +1,6 @@
-.TH "CARGO BASHMAN" "1" "November 2024" "cargo\-bashman v0.6.2" "User Commands"
+.TH "CARGO BASHMAN" "1" "November 2024" "cargo\-bashman v0.6.3" "User Commands"
 .SH NAME
-CARGO BASHMAN \- Manual page for cargo\-bashman v0.6.2.
+CARGO BASHMAN \- Manual page for cargo\-bashman v0.6.3.
 .SH DESCRIPTION
 A Cargo plugin to generate bash completions, man pages, and/or crate credits.
 .SS USAGE:

release/man/cargo-bashman.1

@@ -535,23 +535,3 @@ impl<'a> Subcommand<'a> {
 		out
 	}
 }
-
-
-
-#[cfg(test)]
-mod test {
-	use super::*;
-
-	#[test]
-	fn t_bash() {
-		let manifest = Manifest::from_file("skel/test.toml")
-			.expect("Manifest parsing failed.");
-		let writer = BashWriter::try_from(&manifest)
-			.expect("Man set up failed.");
-
-		assert_eq!(
-			writer.to_string().replace("\n\n", "\n"),
-			include_str!("../skel/test.bash"),
-		);
-	}
-}

src/bash.rs

@@ -44,7 +44,7 @@ pub(super) struct CreditsWriter<'a> {
 	target: Option<TargetTriple>,
 
 	/// # Dependencies.
-	dependencies: Vec<Dependency>,
+	dependencies: &'a [Dependency],
 }
 
 impl<'a> fmt::Display for CreditsWriter<'a> {
@@ -83,28 +83,27 @@ impl<'a> fmt::Display for CreditsWriter<'a> {
 		}
 
 		// There may not be any dependencies.
-		let deps = self.dependencies.as_slice();
-		if deps.is_empty() {
+		if self.dependencies.is_empty() {
 			return f.write_str("This project has no dependencies.\n");
 		}
 
 		// Some dependencies are context dependent; some work is required.
-		if deps.iter().any(Dependency::conditional) {
+		if self.dependencies.iter().any(Dependency::conditional) {
 			f.write_str("| Package | Version | Author(s) | License | Context |\n| ---- | ---- | ---- | ---- | ---- |\n")?;
 
 			// Required first.
-			for dep in deps {
+			for dep in self.dependencies {
 				if ! dep.conditional() { writeln!(f, "{dep} |")?; }
 			}
 			// Now the specific ones.
-			for dep in deps {
+			for dep in self.dependencies {
 				if dep.conditional() { writeln!(f, "{dep} {} |", dep.context())?; }
 			}
 		}
 		// Everything is needed all the time!
 		else {
 			f.write_str("| Package | Version | Author(s) | License |\n| ---- | ---- | ---- | ---- |\n")?;
-			for dep in deps { writeln!(f, "{dep}")?; }
+			for dep in self.dependencies { writeln!(f, "{dep}")?; }
 		}
 
 		Ok(())
@@ -113,22 +112,21 @@ impl<'a> fmt::Display for CreditsWriter<'a> {
 
 impl<'a> CreditsWriter<'a> {
 	/// # New Instance.
-	pub(super) fn new(man: &'a Manifest, target: Option<TargetTriple>)
+	pub(super) fn new(man: &'a Manifest)
 	-> Result<Self, BashManError> {
 		let src = man.src();
 		let dst = man.dir_credits()?.join("CREDITS.md");
 		let cmd = man.main_cmd().ok_or(BashManError::Credits)?;
 		let name = cmd.bin();
-		let dependencies = man.dependencies(target)?;
 
 		// Done!
 		Ok(Self {
 			src,
 			dst,
 			name,
 			version: cmd.version(),
-			target,
-			dependencies,
+			target: man.target(),
+			dependencies: man.dependencies(),
 		})
 	}
 

src/credits.rs

@@ -87,9 +87,6 @@ pub(super) enum BashManError {
 	/// # Cargo Metadata (JSON) Parsing Error.
 	ParseCargoMetadata(String),
 
-	/// # Cargo.toml Parsing Error.
-	ParseToml(String),
-
 	/// # Read Error.
 	Read(String),
 
@@ -140,7 +137,6 @@ impl fmt::Display for BashManError {
 				if s.is_empty() { "Package name cannot be empty." }
 				else { return write!(f, "Invalid package name: {s}"); },
 			Self::ParseCargoMetadata(s) => return write!(f, "Cargo metadata parsing error: {s}"),
-			Self::ParseToml(s) => return write!(f, "Cargo.toml parsing error: {s}"),
 			Self::Read(s) => return write!(f, "Unable to read: {s}"),
 			Self::UnknownCommand(s) => return write!(f, "Unknown (sub)command: {s}"),
 			Self::Write(s) => return write!(f, "Unable to write: {s}"),

src/err.rs

@@ -198,7 +198,7 @@ fn _main() -> Result<(), BashManError> {
 		None => CWD.as_ref()
 			.ok_or_else(|| BashManError::Dir("working", "./".to_owned()))?
 			.join("Cargo.toml"),
-	})?;
+	}, target)?;
 
 	// Set up a shared buffer for whatever we'll be writing to help reduce
 	// allocations.
@@ -235,7 +235,7 @@ fn _main() -> Result<(), BashManError> {
 
 	// Crate Credits.
 	if FLAG_CREDITS == flags & FLAG_CREDITS {
-		match CreditsWriter::new(&manifest, target).and_then(|w| w.write(&mut buf)) {
+		match CreditsWriter::new(&manifest).and_then(|w| w.write(&mut buf)) {
 			Ok(p) => {
 				good.push("credits");
 				files.push(p);

src/main.rs

@@ -570,40 +570,3 @@ fn output_file(dir: &Path, parent_cmd: Option<&str>, cmd: &str) -> PathBuf {
 		}
 	)
 }
-
-
-
-#[cfg(test)]
-mod test {
-	use super::*;
-
-	#[test]
-	fn t_man() {
-		// The date bits will change.
-		let now = Utc2k::now();
-		let date = format!("{} {}", now.month_name(), now.year());
-
-		// The expected output.
-		let expected = [
-			std::fs::read_to_string("skel/test.1")
-				.expect("Missing skel/test.1")
-				.replace("VARIABLEDATE", date.as_str()),
-			std::fs::read_to_string("skel/test-action.1")
-				.expect("Missing skel/test-action.1")
-				.replace("VARIABLEDATE", date.as_str()),
-			std::fs::read_to_string("skel/test-make.1")
-				.expect("Missing skel/test-make.1")
-				.replace("VARIABLEDATE", date.as_str()),
-		];
-
-		let manifest = Manifest::from_file("skel/test.toml")
-			.expect("Manifest parsing failed.");
-		let writer = ManWriter::try_from(&manifest)
-			.expect("Man set up failed.");
-
-		assert_eq!(writer.men.len(), expected.len());
-		for (idx, (a, b)) in writer.men.iter().zip(expected.iter()).enumerate() {
-			assert_eq!(a.to_string(), b.as_str(), "Man page #{idx} differs.");
-		}
-	}
-}