Refactors

[TimonPost]

• Moved documentation from book to lib.rs
• Fixed and added examples to docstrings
• Forbids unused_must_use warning -> error
• Added unit tests
• mod objectstyle -> private
• mod styledobject -> private
• Fixed bug with SetBg command, WinApi logic (crossterm-style Command for SetBg bug? crossterm#261)
• Fixed bug with StyledObject, used stdout for resetting terminal color
• Introduced ResetColor command

[zrzka]

Please, change the ColorType back to color. No matter what name we do use internally the public one must be clear.

set_fg(ColorType::Blue)?;

I'm setting color with ColorType::Blue instead of Color::Blue. Sounds a bit weird for the crate user. Checking the code to think / propose another name.

[zrzka]

Here's my take on it ...

• TerminalColor is fine
• ColorType should be Color

... and now the ...

pub(crate) trait Color : Sync + Send {
    /// Set the foreground color to the given color.
    fn set_fg(&self, fg_color: ColorType) -> Result<()>;
    /// Set the background color to the given color.
    fn set_bg(&self, fg_color: ColorType) -> Result<()>;
    /// Reset the terminal color to default.
    fn reset(&self) -> Result<()>;
}

This trait is internal, which means that it can have any name. Is the Color right name? For Color, I'd expect color manipulation methods (set R, G, B, get R, G, B, set / get alpha, ...). But these methods do not manipulate with color properties.

As we're in the -style module, so, let's follow my -cursor refactoring here.

• src/color.rs -> src/style.rs (Color -> Style)
• src/color -> src/style (AnsiColor -> AnsiStyle, etc.)

[TimonPost]

Okay I agree and I prefer Color as well, I want to make sure that your okay with having twice the name name as well.

[zrzka]

I want to make sure that your okay with having twice the name name as well.

Why twice? As I mentioned, we should rename the trait Color to trait Style (+ module) or any other name.

[zrzka]

Try to learn to write a changelog entry in PR. Then you wont be forced to recreate them, go through changes, etc.

[zrzka]

I think it can be merged (except the unused_imports which should be fixed).

I'll sync & improve the documentation once this one is merged - to follow the style of the -cursor & -terminal & others. Started adding comments, but there were lot of them, so, I trashed them and will do a PR.