miniansi

README

miniansi

Tricky and fun utilities for Go programs.

---

---

Getting Started

Prerequisites

• Go - I recommend the latest stable release. At least 1.18 is required for generic features.
• Git - I recommend the latest stable release.
• GitHub CLI - you can use git on the command line if you wish, but the github cli is very nice ...

Developed with Go 1.16.4. Updated to Go 1.18. Go is extremely backwards compatible and semver stable. Nearly any v1.x should work fine.

---

Installation

To download the repo and use it as a dependency in your module:

$ go get github.com/skeptycal/miniansi

To build and install this package as a utility (if it has a main package) on your machine so you can use it from the command line:

$ gh repo clone skeptycal/miniansi

$ cd miniansi

# test results and coverage info
$ ./go.test.sh

# build the application with race detection enabled.
$ go build -race

# install as a utility package
$ go install

Use Template

To use this repo as a template for your own project:

$ gh repo create -y --public --template "https://github.com/skeptycal/miniansi"

Contributing

To clone this repo to test and contribute, use git clone or gh repo clone.

$ gh repo clone skeptycal/miniansi

$ cd miniansi

# or choose a name or issue you wish
$ git branch -b dev

Use the Issues and PR templates on the GitHub repo page to contribute.

---

Basic Usage

This is a copy of the example script available in the cmd/example/miniansi folder:

package main

import "github.com/skeptycal/miniansi"

func main() {
    miniansi.Example()
}

To try it out:

# change to the sample folder
$ cd cmd/example/miniansi

# run the main.go program
$ go run ./main.go

---

Code of Conduct and Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us. Please read the Code of Conduct for details before submitting anything.

---

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

---

Contributors and Inspiration

• Michael Treanor (GitHub / Twitter) - Initial work, updates, maintainer
• Francesc Campoy - Inspiration and great YouTube videos!

See also the list of contributors who participated in this project.

---

License

Licensed under the MIT https://opensource.org/licenses/MIT - see the LICENSE file for details.

Documentation

Index

• Constants
• Variables
• func DbEcho(args ...any) (n int, err error)
• func Example()
• func NewAnsiString(in ...any) string
• type AnsiConstraint
• type Ansier
• type Config
• type Stringer
  • func NewAnsi[T constraints.Integer](in T) Stringer

Constants

const (
	NewLine      = "\n"
	InfoColor    = ansiPrefix + "1;34m"
	NoticeColor  = ansiPrefix + "1;36m"
	WarningColor = ansiPrefix + "1;33m"
	ErrorColor   = ansiPrefix + "1;31m"
	DebugColor   = ansiPrefix + "0;36m"
	DbColor      = ansiPrefix + "1;31m" // ANSI dbecho code
	ResetColor   = ansiPrefix + "0m"    // ANSI reset code

)

Variables

var DEBUG bool = true // debug or DEV mode

Functions

func DbEcho

func DbEcho(args ...any) (n int, err error)

dbecho prints to os.Stdout if the global DEBUG is true

func Example

func Example()

func NewAnsiString

func NewAnsiString(in ...any) string

NewAnsi creates a new ansi color code string from components. Each argument is parsed and encoded and wrapped in an ANSI

Types

type AnsiConstraint

type AnsiConstraint interface {
	~string | constraints.Integer // | []byte
}

type Ansier

type Ansier interface {
	String() string
	printer.Fprinter

	// test methods ...
	Fprintf1(w io.Writer, format string, args ...interface{}) (n int, err error)
	Fprintf2(w io.Writer, format string, args ...interface{}) (n int, err error)
	Fprintf3(w io.Writer, format string, args ...interface{}) (n int, err error)
}

type Config

type Config interface {
	SetDebug(debug bool)
	SetEnabled(enabled bool)
	DbPrint(args ...interface{}) (n int, err error)
}

type Stringer

type Stringer interface {
	String() string
}

func NewAnsi

func NewAnsi[T constraints.Integer](in T) Stringer