Skip to content

Automatically doc-test stylize functions #1018

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gavincrawford wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Automatically doc-test stylize functions #1018

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 52 additions & 4 deletions src/style/stylize.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,19 @@ macro_rules! stylize_method {
stringify!($attribute),
"`](Attribute::",
stringify!($attribute),
") attribute to the text.",
") attribute to the text.\n\n",
"# Example\n\n",
"```\n",
"# use crossterm::style::{Attribute, ContentStyle, Stylize};\n",
"let styled = \"",
stringify!($method_name),
"\".",
stringify!($method_name),
"();\n",
"# assert!(styled.style().attributes.has(Attribute::",
stringify!($attribute),
"));\n",
"```",
)]
fn $method_name(self) -> Self::Styled {
self.attribute(Attribute::$attribute)
Expand All @@ -24,7 +36,19 @@ macro_rules! stylize_method {
stringify!($color),
"`](Color::",
stringify!($color),
")."
").\n\n",
"# Example\n\n",
"```\n",
"# use crossterm::style::{ContentStyle, Stylize, Color};\n",
"let styled = \"",
stringify!($method_name_fg),
"\".",
stringify!($method_name_fg),
"();\n",
"# assert_eq!(styled.style().foreground_color, Some(Color::",
stringify!($color),
"));\n",
"```",
)]
fn $method_name_fg(self) -> Self::Styled {
self.with(Color::$color)
Expand All @@ -35,7 +59,19 @@ macro_rules! stylize_method {
stringify!($color),
"`](Color::",
stringify!($color),
")."
").\n\n",
"# Example\n\n",
"```\n",
"# use crossterm::style::{ContentStyle, Stylize, Color};\n",
"let styled = \"",
stringify!($method_name_bg),
"\".",
stringify!($method_name_bg),
"();\n",
"# assert_eq!(styled.style().background_color, Some(Color::",
stringify!($color),
"));\n",
"```",
)]
fn $method_name_bg(self) -> Self::Styled {
self.on(Color::$color)
Expand All @@ -46,7 +82,19 @@ macro_rules! stylize_method {
stringify!($color),
"`](Color::",
stringify!($color),
")."
").\n\n",
"# Example\n\n",
"```\n",
"# use crossterm::style::{ContentStyle, Stylize, Color};\n",
"let styled = \"",
stringify!($method_name_ul),
"\".",
stringify!($method_name_ul),
"();\n",
"# assert_eq!(styled.style().underline_color, Some(Color::",
stringify!($color),
"));\n",
"```",
)]
fn $method_name_ul(self) -> Self::Styled {
self.underline(Color::$color)
Expand Down
1 change: 1 addition & 0 deletions src/style/types/colored.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,7 @@ mod tests {

#[test]
fn test_parse_ansi_bg() {
// BUG: hey, this should be `BackgroundColor`!
test_parse_ansi(Colored::ForegroundColor)
}

Expand Down
Loading