Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/deinsoftware/colorify

Colorify - C# .Net Console Library with Text Format: colors, alignment and lot more [ Win+Mac+Linux ]
https://github.com/deinsoftware/colorify
alignment colorify colors csharp dotnet dotnet-core dotnet-framework dotnet-standard format-library hacktoberfest library linux macos theme windows
Last synced: about 1 month ago
JSON representation
Colorify - C# .Net Console Library with Text Format: colors, alignment and lot more [ Win+Mac+Linux ]
Host: GitHub
URL: https://github.com/deinsoftware/colorify
Owner: deinsoftware
License: mit
Created: 2017-12-24T08:04:29.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2022-12-14T22:51:35.000Z (about 2 years ago)
Last Synced: 2024-12-13T07:09:36.408Z (about 1 month ago)
Topics: alignment, colorify, colors, csharp, dotnet, dotnet-core, dotnet-framework, dotnet-standard, format-library, hacktoberfest, library, linux, macos, theme, windows
Language: C#
Homepage: https://www.nuget.org/packages/dein.Colorify
Size: 2.83 MB
Stars: 65
Watchers: 4
Forks: 6
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project

README

        # dein Colorify [ Win+Mac+Linux ]

[![github-actions-build](https://github.com/deinsoftware/colorify/workflows/build/badge.svg?branch=master)](https://github.com/deinsoftware/colorify/actions?query=workflow%3Abuild)

[![github-actions-pack](https://github.com/deinsoftware/colorify/workflows/pack/badge.svg)](https://github.com/deinsoftware/colorify/actions?query=workflow%3Apack)

[![nuget-version](https://img.shields.io/nuget/v/dein.Colorify.svg)](https://www.nuget.org/packages/dein.Colorify/)

[![nuget-download](https://img.shields.io/nuget/dt/dein.Colorify.svg)](https://www.nuget.org/packages/dein.Colorify/)

[![Sonar-reliability](https://sonarcloud.io/api/project_badges/measure?project=dein%3Acolorify&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=dein%3Acolorify)

[![sonar-security](https://sonarcloud.io/api/project_badges/measure?project=dein%3Acolorify&metric=security_rating)](https://sonarcloud.io/dashboard?id=dein%3Acolorify)

[![sonar-maintainability](https://sonarcloud.io/api/project_badges/measure?project=dein%3Acolorify&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=dein%3Acolorify)

[![license](https://img.shields.io/github/license/deinsoftware/colorify)](LICENSE.md)

![Colorify](.github/social/preview.png "Colorify")

**Colorify** was created to simplify and automate tasks related to .Net console formatting. Was born in [HardHat](https://github.com/deinsoftware/hardhat/) project as a Class. Now grown up as a library and can be used by other console applications.

> The Code is Dark and Full of Errors!

> Console is your friend ... don't be afraid!

## Menu

- [Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

    - [Recommended Dependencies](#recommended-dependencies)

    - [Add As Package](#add-as-package)

    - [Add As Reference](#add-as-reference)

  - [Instantiate Library](#instantiate-library)

- [Usage](#usage)

  - [Colors](#colors)

  - [Write](#write)

  - [WriteLine](#writeline)

  - [WordWrap](#wordwrap)

  - [Align](#align)

  - [BlankLines](#blanklines)

  - [DivisionLine](#divisionline)

- [About](#about)

  - [Built With](#built-with)

  - [Contributing](#contributing)

  - [Versioning](#versioning)

  - [Authors](#authors)

  - [Sponsors](#sponsors)

  - [License](#license)

  - [Acknowledgments](#acknowledgments)

---

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

What things you need to install?

- [.Net SDK](https://www.microsoft.com/net/download)

**Colorify** supports `netstandard2.1`, `netcoreapp3.1`, `net5.0`, `net6.0` and `net7.0` target frameworks.

### Installing

**Colorify** is available as [project](https://github.com/deinsoftware/colorify/) or [package](https://www.nuget.org/packages/dein.Colorify). We strong recommend add as a NuGet package if don't need make modifications directly on the source code library.

Follow these instructions to add **Colorify** in your project.

#### Recommended Dependencies

- [dein.ToolBox](https://www.nuget.org/packages/dein.ToolBox) Library

#### Add As Package

In your project folder, where is located .csproj file run this command on terminal:

```terminal

dotnet add package dein.Colorify

```

If you want to use OS class highly recommend use [ToolBox](https://github.com/deinsoftware/toolbox/) project.

```terminal

dotnet add package dein.ToolBox

```

Official documentation: [dotnet add package](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-add-package)

#### Add As Reference

Clone **Colorify** from GitHub on _recommended_ path. Using this command on terminal:

| OS  | Command                                                                                      |

| --- | -------------------------------------------------------------------------------------------- |

| win | `git clone https://github.com/deinsoftware/colorify.git "D:\Developer\DEIN\Projects\_devCC"` |

| mac | `git clone https://github.com/deinsoftware/colorify.git ~/Developer/DEIN/Projects/_devCC`    |

In your project folder, where is located .csproj file run this command on terminal:

| OS  | Command                                                                             |

| --- | ----------------------------------------------------------------------------------- |

| win | `dotnet add reference "D:\Developer\DEIN\Projects\_devCC\Colorify\Colorify.csproj"` |

| mac | `dotnet add reference ~/Developer/DEIN/Projects/_devCC/Colorify/Colorify.csproj`    |

Official documentation: [dotnet add reference](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-add-reference)

### Instantiate Library

On the main class Program, add a static property Format and inside the Main method create an instance of the library according the Operative System.

```csharp

class Program

{

    public static Format _colorify {get; set;}

    static void Main(string[] args)

    {

        switch (OS.GetCurrent())

        {

            case "win":

            case "gnu":

                _colorify = new Format(Theme.Dark);

                break;

            case "mac":

                _colorify = new Format(Theme.Light);

                break;

        }

        //Foo()

        //Bar()

        _colorify.ResetColor();

        _colorify.Clear();

    }

}

```

Take note that `_colorify.ResetColor();` command is important in order to reset default terminal colors when programs finish.

If you want use themes with current user color use `_colorify = new Format(new ThemeLight());` or `_colorify = new Format(new ThemeDark());`

If you want to use `_colorify` in other class, add a static using to `Program` class:

```csharp

using static Namesapace.Program;

```

replace Namespace with a defined namespace in your project.

⇧ [Back to menu](#menu)

---

## Usage

Keep calm, you are almost done. Review this usage steps and enjoy life.

To understand how this library works, take a look inside [Sample](https://github.com/deinsoftware/colorify/tree/master/Sample) folder. Better easy to use a guide than words.

Just go to `Sample` project folder and run this command on terminal:

```terminal

cd Sample

dotnet run

```

### Colors

**Colorify** colors was created inspired on [Bootstrap colors](https://getbootstrap.com/docs/4.0/utilities/colors/) a list whit a meaning easy to remember.

```csharp

_colorify.WriteLine("Text Default", Colors.txtDefault);

_colorify.WriteLine("Text Muted", Colors.txtMuted);

_colorify.WriteLine("Text Primary", Colors.txtPrimary);

_colorify.WriteLine("Text Success", Colors.txtSuccess);

_colorify.WriteLine("Text Info", Colors.txtInfo);

_colorify.WriteLine("Text Warning", Colors.txtWarning);

_colorify.WriteLine("Text Danger", Colors.txtDanger);

_colorify.WriteLine("Background Default", Colors.bgDefault);

_colorify.WriteLine("Background Muted", Colors.bgMuted);

_colorify.WriteLine("Background Primary", Colors.bgPrimary);

_colorify.WriteLine("Background Success", Colors.bgSuccess);

_colorify.WriteLine("Background Info", Colors.bgInfo);

_colorify.WriteLine("Background Warning", Colors.bgWarning);

_colorify.WriteLine("Background Danger", Colors.bgDanger);

```

**Light (for macOS):**

![Light](Sample/images/colors-mac.png "Colors for macOS")

**Dark (for Windows and Linux):**

![Dark](Sample/images/colors-win.png "Colors for Window and Linux")

Colors are defined on [Theme](https://github.com/deinsoftware/colorify/tree/master/Colorify/Theme) folder. There is two themes Light (for macOS) and Dark (for Windows and Linux). You can edit the `ThemeLight.cs` or `ThemeDark.cs` files or create a new one implementing the `ITheme` interface.

Take a look on official documentation: [ConsoleColor Enumeration](https://msdn.microsoft.com/en-us/library/system.consolecolor)

### Write

`_colorify.Write` work like `Console.Write` but wrapped with colors. If you don't specify a color will use the `Colors.txtDefault` by default.

```csharp

_colorify.Write("Text");

```

```csharp

_colorify.Write("Text", Colors.bgDefault);

```

You can stack a multiple `_colorify.Write`, just remember define the last one as WriteLine.

```csharp

_colorify.Write(" Default ", Colors.bgDefault);

_colorify.Write(" Muted   ", Colors.bgMuted);

_colorify.Write(" Primary ", Colors.bgPrimary);

_colorify.Write(" Success ", Colors.bgSuccess);

_colorify.Write(" Info    ", Colors.bgInfo);

_colorify.Write(" Warning ", Colors.bgWarning);

_colorify.WriteLine(" Danger  ", Colors.bgDanger);

```

![Write](Sample/images/write.png "Write")

### WriteLine

`_colorify.WriteLine` work like `Console.WriteLine` with a line terminator after the text but wrapped with colors. If you don't specify a color will use the `Colors.txtDefault` by default.

```csharp

_colorify.WriteLine("Text with line terminator");

```

```csharp

_colorify.WriteLine("Text with line terminator", Colors.bgDefault);

```

```csharp

_colorify.Write("Short Text at First Preceded with a ", Colorify.Colors.bgInfo);

_colorify.WriteLine(" Long Multi line text with Line Wrap that bring a new line", Colorify.Colors.bgSuccess);

```

![WriteLine](Sample/images/writeline.png "WriteLine")

### Word Wrap

`_colorify.Wrap` works like `Console.WriteLine` with a line terminator after the text but wrapped with colors. If you don't specify a color then it will use the `Colors.txtDefault` by default.

```csharp

_colorify.Wrap("Very long text with gentle word wrapping at the end of console");

```

```csharp

_colorify.Wrap("Very long text with gentle word wrapping at the end of console", Colors.bgDefault);

```

Automatic line wrap or word wrap with long text:

```csharp

_colorify.Wrap("Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer sed turpis in ligula aliquet ornare tristique sed ante. Nam pretium ullamcorper condimentum. Aliquam quis sodales ex, vitae gravida metus. Suspendisse potenti. Maecenas nunc sapien, semper vel tincidunt sed, scelerisque ut est. Nunc eu venenatis libero. Nulla consectetur pretium leo. Nullam suscipit scelerisque neque fringilla volutpat. Aliquam condimentum, neque quis malesuada ultrices, mauris velit tincidunt arcu, vel sodales tortor felis quis velit. Aliquam tempus ullamcorper orci, vitae pretium leo maximus ut. Aliquam iaculis leo sed tempor mattis.", bgWarning);

```

![WordWrap](Sample/images/wordwrap.png "WordWrap")

### Align

All the align methods (Center/Left/Right) works like `Console.WriteLine` but with align operation and wrapped with colors. If you don't specify a color will use the `Colors.txtDefault` by default.

```csharp

_colorify.AlignCenter("Text Aligned to Center");

_colorify.AlignRight("Text Aligned to Right");

_colorify.AlignLeft("Text Aligned to Left");

```

```csharp

_colorify.AlignCenter("Text Aligned to Center", Colors.bgInfo);

_colorify.AlignRight("Text Aligned to Right", Colors.txtDefault);

_colorify.AlignLeft("Text Aligned to Left", Colors.txtDanger);

```

`AlignSplit` is the way to show two values on the same line. The text will be split with pipe `|` character, the first element will be aligned to left and second aligned to right.

```csharp

_colorify.AlignSplit("<-Text to Left| Text to Right->");

```

```csharp

_colorify.AlignSplit("<-Text to Left| Text to Right->", Colors.bgSuccess);

```

![Align](Sample/images/align.png "Align")

### BlankLines

`_colorify.BlankLines` works like `Console.WriteLine` but without text. You can combine the amount of lines and colors. Default values will be `1` line and `Colors.txtDefault`.

```csharp

_colorify.BlankLines();

_colorify.BlankLines(Colorify.Colors.bgDanger);

```

![BlankLines](Sample/images/lines.png "BlankLines")

```csharp

_colorify.BlankLines(3);

_colorify.BlankLines(3, Colors.bgSuccess);

```

![BlankLines x 3](Sample/images/lines-3.png "BlankLines x 3")

### DivisionLine

`_colorify.DivisionLine` works like `Console.WriteLine` but without the same character as full-width text. If you don't specify a color will use the `Colors.txtDefault` by default.

```csharp

_colorify.DivisionLine('-', Colors.bgDefault);

_colorify.DivisionLine('+', Colors.bgMuted);

_colorify.DivisionLine('~', Colors.bgPrimary);

_colorify.DivisionLine('=', Colors.bgSuccess);

_colorify.DivisionLine('-', Colors.bgInfo);

_colorify.DivisionLine('*', Colors.bgWarning);

_colorify.DivisionLine('.', Colors.bgDanger);

```

![DivisionLine](Sample/images/division.png "DivisionLine")

⇧ [Back to menu](#menu)

---

## About

### Built With

- [.Net](https://dotnet.github.io/) - .Net is a free and open-source web framework, developed by Microsoft and the community.

- [VS Code](https://code.visualstudio.com/) - Code editing redefined.

- [SonarQube](https://sonarcloud.io/) - Continuous code quality.

### Contributing

Please read [CONTRIBUTING](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

### Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [Colorify](https://github.com/deinsoftware/colorify/tags) on GitHub.

### Authors

- **Camilo Martinez** [[Equiman](http://github.com/equiman)]

See also the list of [contributors](https://github.com/deinsoftware/colorify/contributors) who participated in this project.

### Sponsors

If this project help you reduce time to develop, you can give me a cup of coffee.

[![GitHub Sponsors](https://img.shields.io/badge/-GitHub%20Sponsors-gray?style=flat&labelColor=171515&logo=github&logoColor=white&link=https://github.com/sponsors/deinsoftware)](https://github.com/sponsors/deinsoftware)

[![paypal](https://img.shields.io/badge/-PayPal-gray?style=flat&labelColor=00457C&logo=paypal&logoColor=white&link=https://paypal.me/equiman/3)](https://paypal.me/equiman/3)

No sponsors yet! Will you be the first?

### License

This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.

### Acknowledgments

- [StackOverflow](http://stackoverflow.com): The largest online community for programmers.

- [Dot Net Perls](https://www.dotnetperls.com/console-color): C# Console Color, Text and BackgroundColor.

⇧ [Back to menu](#menu)