release: 1.8.0

Author: joshstoik1

CREDITS.md

@@ -1,14 +1,14 @@
 # Project Dependencies
     Package:   fyi
-    Version:   1.7.1
+    Version:   1.8.0
     Target:    x86_64-unknown-linux-gnu
-    Generated: 2025-02-26 03:54:37 UTC
+    Generated: 2025-03-12 03:51:06 UTC
 
 | Package | Version | Author(s) | License |
 | ---- | ---- | ---- | ---- |
-| [**argyle**](https://github.com/Blobfolio/argyle) | 0.11.0 | [Josh Stoik](mailto:josh@blobfolio.com) | WTFPL |
+| [**argyle**](https://github.com/Blobfolio/argyle) | 0.12.0 | [Josh Stoik](mailto:josh@blobfolio.com) | WTFPL |
 | [**dactyl**](https://github.com/Blobfolio/dactyl) | 0.10.0 | [Josh Stoik](mailto:josh@blobfolio.com) | WTFPL |
-| [**fyi_msg**](https://github.com/Blobfolio/fyi) | 1.7.1 | [Josh Stoik](mailto:josh@blobfolio.com) | WTFPL |
+| [**fyi_msg**](https://github.com/Blobfolio/fyi) | 1.8.0 | [Josh Stoik](mailto:josh@blobfolio.com) | WTFPL |
 | [tz-rs](https://github.com/x-hgg-x/tz-rs) | 0.7.0 | x-hgg-x | MIT OR Apache-2.0 |
 | [**utc2k**](https://github.com/Blobfolio/utc2k) | 0.12.0 | [Josh Stoik](mailto:josh@blobfolio.com) | WTFPL |
 

fyi/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "fyi"
-version = "1.7.1"
+version = "1.8.0"
 license = "WTFPL"
 authors = ["Josh Stoik <josh@blobfolio.com>"]
 edition = "2024"
@@ -170,13 +170,13 @@ description = "The message!"
 subcommands = [ "confirm", "print", "crunched", "debug", "done", "error", "info", "notice", "review", "skipped", "success", "task", "warning" ]
 
 [build-dependencies]
-argyle = "0.11.*"
+argyle = "0.12.*"
 
 [build-dependencies.fyi_msg]
 path = "../fyi_msg"
 
 [dependencies]
-argyle = "0.11.*"
+argyle = "0.12.*"
 dactyl = "0.10.*"
 
 [dependencies.fyi_msg]

fyi/build.rs

@@ -2,7 +2,10 @@
 # FYI: Build
 */
 
-use argyle::KeyWordsBuilder;
+use argyle::{
+	FlagsBuilder,
+	KeyWordsBuilder,
+};
 use fyi_msg::{
 	Msg,
 	MsgKind,
@@ -21,13 +24,16 @@ use std::path::{
 ///
 /// It also generates the keywords used for CLI parsing, again to save some
 /// runtime overhead.
-pub fn main() {
+fn main() {
 	println!("cargo:rerun-if-changed=help");
 	println!("cargo:rerun-if-env-changed=CARGO_PKG_VERSION");
 
 	// Build the CLI arguments.
 	write_cli();
 
+	// Build the flags.
+	write_flags();
+
 	// Handle the top.
 	write_help(
 		help_path("top"),
@@ -173,6 +179,16 @@ fn write_cli() {
 	builder.save(out_path("argyle-msg.rs"));
 }
 
+/// # Write flags (program settings bools).
+fn write_flags() {
+	FlagsBuilder::new("Flags")
+		.with_flag("Indent", Some("# Indent Message."))
+		.with_flag("Stderr", Some("# Print to STDERR."))
+		.with_flag("Timestamp", Some("# Timestamp Message."))
+		.with_flag("Yes", Some("# Assume Yes (No Prompt)."))
+		.save(out_path("flags.rs"));
+}
+
 /// # Write file.
 fn write_help<P>(path: P, data: &[u8])
 where P: AsRef<Path> {

fyi/src/cli.rs

@@ -10,6 +10,7 @@ use crate::FyiError;
 use dactyl::traits::BytesToUnsigned;
 use fyi_msg::{
 	Msg,
+	MsgFlags,
 	MsgKind,
 };
 use std::{
@@ -19,76 +20,65 @@ use std::{
 
 
 
+// Flags generated by build.rs.
+include!(concat!(env!("OUT_DIR"), "/flags.rs"));
+
+
+
 #[derive(Debug, Clone, Copy)]
 /// # Message Settings.
 ///
 /// Most of these settings will get embedded into the `Msg` itself, but there
 /// are a couple parts that do not get referenced until print time.
 pub(super) struct Settings {
 	/// # Flags.
-	flags: u8,
+	flags: Flags,
 
 	/// # Exit.
 	exit: ExitCode,
 }
 
 impl Settings {
-	/// # Indent Message.
-	const FLAG_INDENT: u8 =    0b0001;
-
-	/// # Print to STDERR.
-	const FLAG_STDERR: u8 =    0b0010;
-
-	/// # Include Timestamp.
-	const FLAG_TIMESTAMP: u8 = 0b0100;
-
-	/// # Default Yes (for Prompt).
-	const FLAG_YES: u8 =       0b1000;
-
 	/// # Exit Code.
 	pub(super) fn exit(self) -> Result<(), FyiError> {
 		if self.exit == ExitCode::SUCCESS { Ok(()) }
 		else { Err(FyiError::Passthrough(self.exit)) }
 	}
 
 	/// # Stderr?
-	pub(super) const fn stderr(self) -> bool {
-		Self::FLAG_STDERR == self.flags & Self::FLAG_STDERR
-	}
+	pub(super) const fn stderr(self) -> bool { self.flags.contains(Flags::Stderr) }
 
 	/// # Default Yes?
-	pub(super) const fn yes(self) -> bool {
-		Self::FLAG_YES == self.flags & Self::FLAG_YES
-	}
+	pub(super) const fn yes(self) -> bool { self.flags.contains(Flags::Yes) }
 
 	/// # Convert to `Msg` Flags.
-	const fn msg_flags(self) -> u8 {
-		let mut flags: u8 = fyi_msg::FLAG_NEWLINE;
-		if Self::FLAG_INDENT == self.flags & Self::FLAG_INDENT {
-			flags |= fyi_msg::FLAG_INDENT;
+	const fn msg_flags(self) -> MsgFlags {
+		let mut flags = MsgFlags::Newline;
+		if self.flags.contains(Flags::Indent) {
+			flags = flags.with(MsgFlags::Indent);
 		}
-		if Self::FLAG_TIMESTAMP == self.flags & Self::FLAG_TIMESTAMP {
-			flags |= fyi_msg::FLAG_TIMESTAMP;
+		if self.flags.contains(Flags::Timestamp) {
+			flags = flags.with(MsgFlags::Timestamp);
 		}
 		flags
 	}
 
 	/// # New.
 	const fn new() -> Self {
-		Self { flags: 0, exit: ExitCode::SUCCESS }
+		Self { flags: Flags::None, exit: ExitCode::SUCCESS }
 	}
 
 	/// # Set Indent.
-	fn set_indent(&mut self) { self.flags |= Self::FLAG_INDENT; }
+	fn set_indent(&mut self) { self.flags |= Flags::Indent; }
 
 	/// # Set Stderr.
-	fn set_stderr(&mut self) { self.flags |= Self::FLAG_STDERR; }
+	fn set_stderr(&mut self) { self.flags |= Flags::Stderr; }
 
 	/// # Set Timestamp.
-	fn set_timestamp(&mut self) { self.flags |= Self::FLAG_TIMESTAMP; }
+	fn set_timestamp(&mut self) { self.flags |= Flags::Timestamp; }
 
 	/// # Set Yes.
-	fn set_yes(&mut self) { self.flags |= Self::FLAG_YES; }
+	fn set_yes(&mut self) { self.flags |= Flags::Yes; }
 }
 
 

fyi_msg/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "fyi_msg"
-version = "1.7.1"
+version = "1.8.0"
 authors = ["Josh Stoik <josh@blobfolio.com>"]
 edition = "2024"
 rust-version = "1.85"
@@ -17,6 +17,9 @@ features = [ "fitted", "progress", "signals", "timestamps" ]
 default-target = "x86_64-unknown-linux-gnu"
 targets = [ "x86_64-unknown-linux-gnu", "x86_64-apple-darwin" ]
 
+[build-dependencies]
+argyle = "0.12.0"
+
 [dependencies]
 dactyl = "0.10.*"
 

fyi_msg/build.rs

@@ -0,0 +1,50 @@
+/*!
+# FYI: Build
+*/
+
+#![allow(unused_mut, reason = "It is conditionally used.")]
+
+use argyle::FlagsBuilder;
+use std::{
+	fs::File,
+	io::Write,
+	path::PathBuf,
+};
+
+
+
+/// # Build `MsgFlags`.
+fn main() {
+	let mut builder = FlagsBuilder::new("MsgFlags")
+		.public()
+		.with_docs("# Message Flags.
+
+Used by [`Msg::with_flags`] to set multiple properties in one go.")
+		.with_flag("Indent", Some("# Indent Message (four spaces).\n\nEquivalent to passing one to [`Msg::with_indent`]."))
+		.with_flag("Newline", Some("# End Message w/ Line Break.\n\nEquivalent to passing true to [`Msg::with_newline`]."));
+
+	#[cfg(feature = "timestamps")]
+	{
+		builder = builder.with_flag("Timestamp", Some("# Timestamp Message.\n\nEquivalent to passing true to [`Msg::with_timestamp`]."));
+	}
+
+	// Save it manually so we can note the timestamps feature-gate.
+	let out = builder.to_string()
+		.replace(
+			"\t#[doc = \"# Timestamp",
+			"\t#[cfg_attr(docsrs, doc(cfg(feature = \"timestamps\")))]\n\t#[doc = \"# Timestamp",
+		);
+
+	File::create(out_path("msg-flags.rs"))
+		.and_then(|mut f| f.write_all(out.as_bytes()).and_then(|()| f.flush()))
+		.expect("Unable to save msg-flags.rs");
+}
+
+/// # Output Path.
+///
+/// Append the sub-path to OUT_DIR and return it.
+fn out_path(stub: &str) -> PathBuf {
+	std::fs::canonicalize(std::env::var("OUT_DIR").expect("Missing OUT_DIR."))
+		.expect("Missing OUT_DIR.")
+		.join(stub)
+}

fyi_msg/src/lib.rs

@@ -122,8 +122,7 @@ pub use msg::{
 };
 
 pub use msg::{
-	FLAG_INDENT,
-	FLAG_NEWLINE,
+	MsgFlags,
 	kind::MsgKind,
 	Msg,
 };
@@ -147,10 +146,6 @@ pub use progress::{
 #[cfg_attr(docsrs, doc(cfg(feature = "signal-hook")))]
 #[cfg(feature = "signal-hook")] pub use signal_hook;
 
-#[cfg(feature = "timestamps")]
-#[cfg_attr(docsrs, doc(cfg(feature = "timestamps")))]
-pub use msg::FLAG_TIMESTAMP;
-
 #[macro_use]
 /// # Macros.
 mod macros {