release: 0.6.6

Author: joshstoik1

CREDITS.md

@@ -1,6 +1,6 @@
 [package]
 name = "cargo-bashman"
-version = "0.6.5"
+version = "0.6.6"
 license = "WTFPL"
 authors = ["Josh Stoik <[email protected]>"]
 edition = "2021"

Cargo.toml

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

release/man/cargo-bashman.1

@@ -83,27 +83,28 @@ impl<'a> fmt::Display for CreditsWriter<'a> {
 		}
 
 		// There may not be any dependencies.
-		if self.dependencies.is_empty() {
+		let Some(last) = self.dependencies.last() else {
 			return f.write_str("This project has no dependencies.\n");
+		};
+
+		// Print a header and each dependency.
+		f.write_str("| Package | Version | Author(s) | License |\n| ---- | ---- | ---- | ---- |\n")?;
+		let mut build = false;
+		let mut children = false;
+		for dep in self.dependencies {
+			if dep.build() { build = true; }
+			if ! dep.direct() { children = true; }
+			writeln!(f, "{dep}")?;
 		}
 
-		// Some dependencies are context dependent; some work is required.
-		if self.dependencies.iter().any(Dependency::conditional) {
-			f.write_str("| Package | Version | Author(s) | License | Context |\n| ---- | ---- | ---- | ---- | ---- |\n")?;
-
-			// Required first.
-			for dep in self.dependencies {
-				if ! dep.conditional() { writeln!(f, "{dep} |")?; }
-			}
-			// Now the specific ones.
-			for dep in self.dependencies {
-				if dep.conditional() { writeln!(f, "{dep} {} |", dep.context())?; }
+		// If we have contexts, note them.
+		if build || children || last.conditional() {
+			f.write_str("\n### Legend\n\n")?;
+			if children {
+				f.write_str("* **Direct Dependency**\n* Child Dependency\n")?;
 			}
-		}
-		// Everything is needed all the time!
-		else {
-			f.write_str("| Package | Version | Author(s) | License |\n| ---- | ---- | ---- | ---- |\n")?;
-			for dep in self.dependencies { writeln!(f, "{dep}")?; }
+			if last.conditional() { f.write_str("* _Optional Dependency_\n")?; }
+			if build { f.write_str("* ⚒️ Build-Only\n")?; }
 		}
 
 		Ok(())

skel/metadata.credits

@@ -666,7 +666,9 @@ impl From<RawCredits> for Dependency {
 			license: src.license,
 			authors: src.authors,
 			url: src.repository.map(String::from),
-			context: if src.optional { Self::FLAG_OPTIONAL } else { 0 },
+			context:
+				if src.optional { Self::FLAG_DIRECT | Self::FLAG_OPTIONAL }
+				else { Self::FLAG_DIRECT },
 		}
 	}
 }
@@ -1110,8 +1112,8 @@ fn prune_resolve<'a>(resolve: &'a mut RawResolve, mut used: HashSet<&'a str>) {
 
 	// And with that, let's remove all unused node chains entirely.
 	resolve.nodes.retain(|k, _| used.contains(k));
-	for deps in resolve.nodes.values_mut() {
-		deps.retain(|nd| used.contains(nd.id));
+	for v in resolve.nodes.values_mut() {
+		v.retain(|nd| used.contains(nd.id));
 	}
 
 	// Now let's do something similar, this time building up a list of "normal"
@@ -1163,6 +1165,13 @@ fn prune_resolve<'a>(resolve: &'a mut RawResolve, mut used: HashSet<&'a str>) {
 			}
 		}
 	}
+
+	// Lastly, let's mark direct dependencies.
+	if let Some(v) = resolve.nodes.get_mut(resolve.root) {
+		for nd in v {
+			nd.dep_kinds |= Dependency::FLAG_DIRECT;
+		}
+	}
 }
 
 

src/credits.rs

@@ -77,6 +77,18 @@ impl Manifest {
 		// Abosrb the extra credits into the real dependencies.
 		deps.extend(credits);
 
+		// Collect into a vec and resort, pushing conditional dependencies to
+		// the end of the list.
+		let mut dependencies: Vec<Dependency> = deps.into_iter().collect();
+		dependencies.sort_by(|a, b| {
+			let a_cond = a.conditional();
+			let b_cond = b.conditional();
+
+			if a_cond == b_cond { a.cmp(b) }
+			else if a_cond { Ordering::Greater }
+			else { Ordering::Less }
+		});
+
 		// Finally!
 		Ok(Self {
 			src,
@@ -86,7 +98,7 @@ impl Manifest {
 			dir,
 			subcommands,
 			target,
-			dependencies: deps.into_iter().collect(),
+			dependencies,
 		})
 	}
 

src/parse/cargo.rs

@@ -67,20 +67,24 @@ impl PartialOrd for Dependency {
 }
 
 impl Dependency {
+	/// # Direct Dependency.
+	pub(super) const FLAG_DIRECT: u8 =     0b0000_0001;
+
 	/// # Feature-Specific.
-	pub(super) const FLAG_OPTIONAL: u8 =   0b0000_0001;
+	pub(super) const FLAG_OPTIONAL: u8 =   0b0000_0010;
 
 	/// # Not Target-Specific.
-	pub(super) const FLAG_TARGET_ANY: u8 = 0b0000_0010;
+	pub(super) const FLAG_TARGET_ANY: u8 = 0b0000_0100;
 
 	/// # Target-Specific.
-	pub(super) const FLAG_TARGET_CFG: u8 = 0b0000_0100;
+	pub(super) const FLAG_TARGET_CFG: u8 = 0b0000_1000;
 
 	/// # Normal Context.
-	pub(super) const FLAG_CTX_NORMAL: u8 = 0b0000_1000;
+	pub(super) const FLAG_CTX_NORMAL: u8 = 0b0001_0000;
 
 	/// # Build Context.
-	pub(super) const FLAG_CTX_BUILD: u8 =  0b0001_0000;
+	pub(super) const FLAG_CTX_BUILD: u8 =  0b0010_0000;
+
 
 	/// # Context Flags.
 	pub(super) const MASK_CTX: u8 =
@@ -108,6 +112,11 @@ impl Dependency {
 	/// # Repository URL.
 	pub(super) fn url(&self) -> Option<&str> { self.url.as_deref() }
 
+	/// # Direct?
+	pub(crate) const fn direct(&self) -> bool {
+		Self::FLAG_DIRECT == self.context & Self::FLAG_DIRECT
+	}
+
 	/// # Optional?
 	pub(crate) const fn optional(&self) -> bool {
 		Self::FLAG_OPTIONAL == self.context & Self::FLAG_OPTIONAL
@@ -127,53 +136,57 @@ impl Dependency {
 	///
 	/// Returns `true` if optional or target specific.
 	pub(crate) const fn conditional(&self) -> bool {
-		self.optional() || self.build() || self.target_specific()
-	}
-
-	/// # Context Flags as String Slice.
-	///
-	/// Return a textual representation of the dependency's context(s). There
-	/// are only a few combinations so this is pretty easy to construct
-	/// manually.
-	pub(crate) const fn context(&self) -> &'static str {
-		match (self.optional(), self.build(), self.target_specific()) {
-			(true, true, true) => "optional, build, target-specific",
-			(true, true, false) => "optional, build",
-			(true, false, true) => "optional, target-specific",
-			(false, true, true) => "build, target-specific",
-			(true, false, false) => "optional",
-			(false, true, false) => "build",
-			(false, false, true) => "target-specific",
-			(false, false, false) => "",
-		}
+		self.optional() || self.target_specific()
 	}
 }
 
 impl fmt::Display for Dependency {
 	/// # Write as Markdown.
 	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-		// The name as a link.
-		if let Some(url) = self.url() {
-			write!(
-				f,
-				"| [{}]({url}) | {} | {} | {} |",
-				self.name,
-				self.version,
-				OxfordJoinFmt::and(self.authors()),
-				self.license().unwrap_or(""),
-			)
+		#[expect(clippy::missing_docs_in_private_items, reason = "Self-Explanatory.")]
+		/// # Name Formatter.
+		///
+		/// This will linkify the name if needed.
+		struct FmtName<'a> {
+			name: &'a str,
+			open: &'a str,
+			close: &'a str,
+			url: Option<&'a str>,
 		}
-		// The name plain.
-		else {
-			write!(
-				f,
-				"| {} | {} | {} | {} |",
-				self.name,
-				self.version,
-				OxfordJoinFmt::and(self.authors()),
-				self.license().unwrap_or(""),
-			)
+		impl<'a> fmt::Display for FmtName<'a> {
+			fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+				if let Some(url) = self.url {
+					write!(f, "[{}{}{}]({url})", self.open, self.name, self.close)
+				}
+				else {
+					write!(f, "{}{}{}", self.open, self.name, self.close)
+				}
+			}
 		}
+
+		// Contextual formatting tags.
+		let (open, close) = match (self.direct(), self.conditional()) {
+			(true, true) => ("**_", "_**"),
+			(true, false) => ("**", "**"),
+			(false, true) => ("_", "_"),
+			(false, false) => ("", ""),
+		};
+
+		// Build "asterisk".
+		let asterisk = if self.build() { " ⚒️" } else { "" };
+
+		write!(
+			f,
+			"| {}{asterisk} | {} | {} | {} |",
+			FmtName {
+				name: self.name.as_str(),
+				open, close,
+				url: self.url(),
+			},
+			self.version,
+			OxfordJoinFmt::and(self.authors()),
+			self.license().unwrap_or(""),
+		)
 	}
 }