Thanks to visit codestin.com
Credit goes to github.com

Skip to content

yyle88/eroticgo

Repository files navigation

GitHub Workflow Status (branch) GoDoc Coverage Status Supported Go Versions GitHub Release Go Report Card

eroticgo

eroticgo is a simple Go package to add vibrant colors to console output with an extensive palette and simple API.


CHINESE README

中文说明

Main Features

🌈 Extensive Palette: Elegant colors including basic colors, bright variants, and unique tones ⚡ Simple API: Sprint method to handle simple string coloring and ShowMessage to show highlighted output 🔧 Custom Colors: NewCOLOR function to create custom tint configurations 📝 Multi-line Support: Automatic handling of multi-line text with consistent coloring 🎨 Rich Palette: From basic RED, GREEN, BLUE to exotic CORAL, TEAL, VIOLET

Installation

go get github.com/yyle88/eroticgo

Usage

Basic Usage

package main

import (
	"fmt"

	"github.com/yyle88/eroticgo"
)

func main() {
	fmt.Println(eroticgo.RED.Sprint("print RED text"))
	fmt.Println(eroticgo.GREEN.Sprint("print GREEN text"))
	fmt.Println(eroticgo.BLUE.Sprint("print BLUE text"))
	fmt.Println(eroticgo.ORANGE.Sprint("print ORANGE text"))
	fmt.Println(eroticgo.VIOLET.Sprint("print VIOLET text"))
	fmt.Println(eroticgo.TEAL.Sprint("print TEAL text"))
}

Show Highlighted Messages

package main

import (
	"github.com/yyle88/eroticgo"
)

func main() {
	// Show important messages with borders
	eroticgo.CYAN.ShowMessage("Important notification message")
	eroticgo.YELLOW.ShowMessage("Warning message")
	eroticgo.RED.ShowMessage("Problem message")
}

Custom Colors

package main

import (
	"fmt"
	"github.com/yyle88/eroticgo"
)

func main() {
	// Create custom tint with ANSI codes
	customColor := eroticgo.NewCOLOR("\033[102m%s\033[0m") // Green background
	fmt.Println(customColor.Sprint("Custom colored text"))
}

API Reference

COLOR Type Methods

  • Sprint(args ...interface{}) string - Format arguments with tint
  • ShowMessage(msgs ...any) - Show message with decorative borders

Examples

Check out the TEST-FILE to see more usage examples and tint demonstrations.

📄 License

MIT License. See LICENSE.


🤝 Contributing

Contributions are welcome! Report bugs, suggest features, and contribute code:

  • 🐛 Found a bug? Open an issue on GitHub with reproduction steps
  • 💡 Have a feature idea? Create an issue to discuss the suggestion
  • 📖 Documentation confusing? Report it so we can improve
  • 🚀 Need new features? Share the use cases to help us understand requirements
  • Performance issue? Help us optimize through reporting slow operations
  • 🔧 Configuration problem? Ask questions about complex setups
  • 📢 Follow project progress? Watch the repo to get new releases and features
  • 🌟 Success stories? Share how this package improved the workflow
  • 💬 Feedback? We welcome suggestions and comments

🔧 Development

New code contributions, follow this process:

  1. Fork: Fork the repo on GitHub (using the webpage UI).
  2. Clone: Clone the forked project (git clone https://github.com/yourname/repo-name.git).
  3. Navigate: Navigate to the cloned project (cd repo-name)
  4. Branch: Create a feature branch (git checkout -b feature/xxx).
  5. Code: Implement the changes with comprehensive tests
  6. Testing: (Golang project) Ensure tests pass (go test ./...) and follow Go code style conventions
  7. Documentation: Update documentation to support client-facing changes and use significant commit messages
  8. Stage: Stage changes (git add .)
  9. Commit: Commit changes (git commit -m "Add feature xxx") ensuring backward compatible code
  10. Push: Push to the branch (git push origin feature/xxx).
  11. PR: Open a pull request on GitHub (on the GitHub webpage) with detailed description.

Please ensure tests pass and include relevant documentation updates.


🌟 Support

Welcome to contribute to this project via submitting merge requests and reporting issues.

Project Support:

  • Give GitHub stars if this project helps you
  • 🤝 Share with teammates and (golang) programming friends
  • 📝 Write tech blogs about development tools and workflows - we provide content writing support
  • 🌟 Join the ecosystem - committed to supporting open source and the (golang) development scene

Have Fun Coding with this package! 🎉


GitHub Stars

Stargazers

About

eroticgo is a simple Go package for adding color to your console screen.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published