Merge pull request #15 from Syaw0/develop

Merge develop into main for version 0.1.0

Author: Syaw0

.github/workflows/rust.yml

@@ -0,0 +1,21 @@
+name: Rust
+
+on:
+  push:
+    branches: ["develop"]
+  pull_request:
+    branches: ["develop"]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build
+        run: cargo build --verbose
+      - name: Run tests
+        run: cargo test --verbose

.gitignore

@@ -3,19 +3,12 @@
 debug/
 target/
 
-# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
-# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-Cargo.lock
-
 # These are backup files generated by rustfmt
 **/*.rs.bk
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
 
-# RustRover
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+# Added by cargo
+
+/target

Cargo.lock

@@ -0,0 +1,13 @@
+[package]
+name = "term_tools"
+version = "0.1.0"
+edition = "2021"
+description = "Colorize Your Terminal with Term-Tools: A Rust-powered Formatting Tool"
+authors = ["Siavash Siamhb7@protonmail.com"]
+homepage = "https://crates.io/crates/term_tools"
+repository = "https://github.com/Syaw0/term_tools"
+license-file = "./LICENSE"
+keywords = ["cli","terminal","rust","tool","coloize","formatter"]
+categories = ["terminal","cli","command-line-utilitise","term-style", "terminal style"]
+
+[dependencies]

Cargo.toml

@@ -1,2 +1,135 @@
-# Vitalux
-Colorize Your Terminal with Vitalux: A Rust-powered Formatting Tool 
+# **term_tools: Rich API for Colorizing Terminal**
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FSyaw0%2Fterm_tools%2Frefs%2Fheads%2Fdevelop%2FCargo.toml&query=package.version&label=Version&color=red)](https://crates.io/term_tools)
+
+## **Overview**
+
+term_tools is a Rust library that provides a rich API for colorizing terminal output. It allows you to create styled text strings with various colors, effects, and formatters.
+
+## **Features**
+
+- **Colors**: Supports 16 basic colors, 256 palette colors, and RGB colors.
+- **Effects**: Supports slow blink and rapid blink.
+- **Formatters**: Supports reset, bold, faint, italic, underline, and overline formatters.
+- **Easy to use**: Simple and intuitive API for creating styled text strings.
+
+## **Usage**
+
+To use term_tools, simply add the following line to your `Cargo.toml` file:
+
+```toml
+[dependencies]
+term_tools = "0.1.0"
+```
+
+Then, import the library in your Rust code:
+
+```rust
+use term_tools::styled;
+```
+
+Create a styled text string using the `styled` function:
+
+```rust
+let styled_text = styled("Hello, World!")
+    .red()
+    .bold()
+    .underline()
+    .paint();
+println!("{}", styled_text);
+```
+
+## **Sequence of Styles**
+
+The sequence of styles is important when using the `fg` and `bg` methods. These methods set the foreground and background colors, respectively, for all subsequent styles.
+
+When you call `fg` or `bg`, all styles that come before it will be applied to the foreground or background, respectively.
+
+Here's an example:
+
+```rust
+let styled_text = styled("Hello, World!")
+    .red() // applies to foreground
+    .fg() // sets foreground color to red
+    .blue() // applies to background
+    .bg() // sets background color to blue
+    .paint();
+```
+
+In this example, the `red` style is applied to the foreground, and the `blue` style is applied to the background.
+
+if there is only one call of `fg` or `bg` whole colors applied that `PaintType` for example:
+
+```rust
+let styled_text = styled("Hello, World!")
+    .red() // red color
+    .blue() // blue color
+    .bg() // apply background color
+    .magenta() // magenta color
+    .paint();
+```
+
+in this example `paint` method will apply the background color of all colors.
+
+if there is not any `fg` or `bg` call , the default paint type assume as `Foreground` for example:
+
+```rust
+let styled_text = styled("Hello, World!")
+    .red() // red color
+    .blue() // blue color
+    .paint();
+```
+
+in this example the `paint` method will use foreground color of the colors.
+
+## **Examples**
+
+Here are some examples of using term_tools:
+
+- **Basic colors**:
+
+```rust
+let styled_text = styled("Hello, World!")
+    .red()
+    .paint();
+println!("{}", styled_text);
+```
+
+- **RGB colors**:
+
+```rust
+let styled_text = styled("Hello, World!")
+    .rgb(255, 0, 0)
+    .paint();
+println!("{}", styled_text);
+```
+
+- **Effects**:
+
+```rust
+let styled_text = styled("Hello, World!")
+    .bold()
+    .underline()
+    .paint();
+println!("{}", styled_text);
+```
+
+- **Formatters**:
+
+```rust
+let styled_text = styled("Hello, World!")
+    .reset()
+    .bold()
+    .paint();
+println!("{}", styled_text);
+```
+
+## **License**
+
+term_tools is licensed under the MIT License.
+
+## **Contributing**
+
+Contributions are welcome If you'd like to contribute to term_tools, please fork the repository and submit a pull request.
+
+I hope this helps Let me know if you'd like me to make any changes.

README.md

@@ -0,0 +1,51 @@
+/// A module for creating ansi escape code.
+///
+/// This module provides an struct `ANSIEscapeCode`
+/// that represents ansi escape code, with `parameter` field.
+/// It also implements the `ANSIEscapeCode`, with `new` and `code` method
+/// which allows for generating anis escape code and getting a code.
+
+// =======================================================================
+
+/// An struct representing ansi escape code.
+///
+/// This struct has 1 field: `parameter` , which represent String of the ansi code.
+pub struct ANSIEscapeCode {
+    parameter: String,
+}
+impl ANSIEscapeCode {
+    /// Returns a ANSIEscapeCode instance with parameter .
+    pub fn new(parameter: &str) -> Self {
+        ANSIEscapeCode { parameter: parameter.to_string() }
+    }
+
+    /// Returns a String that represent the ansi code.
+    pub fn code(&self) -> String {
+        format!("\x1b[{}m", self.parameter)
+    }
+}
+
+// =======================================================================
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn create_simple_ansi_code() {
+        let p = ANSIEscapeCode::new("33");
+        assert_eq!(p.code(), "\x1b[33m")
+    }
+
+    #[test]
+    fn create_reset_ansi_code() {
+        let reset_ansi = ANSIEscapeCode::new("0");
+        assert_eq!("\x1b[0m", reset_ansi.code());
+    }
+
+    #[test]
+    fn create_bright_cyan_ansi_code() {
+        let reset_ansi = ANSIEscapeCode::new("96");
+        assert_eq!("\x1b[96m", reset_ansi.code());
+    }
+}