prints

README

Prints

Usage

package main

import (
	"fmt"
	"time"

	"github.com/go-kratos-ecosystem/components/v2/prints"
)

func main() {
	// basic
	fmt.Println("Hello World!", "Hello Go!")
	prints.Line("Line: Hello World!", "Hello Go!")              
	prints.Linef("Linef: %s %s\n", "Hello World!", "Hello Go!") 
	prints.NewLine()                                            
	println("----------------------------------------")
	prints.NewLine(0) 
	println("----------------------------------------")
	prints.NewLine(1) 
	println("----------------------------------------")
	prints.NewLine(2) 
	println("----------------------------------------")
	prints.NewLine(3)                                                 
	prints.Info("Info: Hello World!", "Hello Go!")                    
	prints.Infof("Infof: %s %s\n", "Hello World!", "Hello Go!")       
	prints.Comment("Comment: Hello World!", "Hello Go!")              
	prints.Commentf("Commentf: %s %s\n", "Hello World!", "Hello Go!") 
	prints.Error("Error: Hello World!", "Hello Go!")                  
	prints.Errorf("Errorf: %s %s\n", "Hello World!", "Hello Go!")     
	prints.Warn("Warn: Hello World!", "Hello Go!")                    
	prints.Warnf("Warnf: %s %s\n", "Hello World!", "Hello Go!")       
	prints.Alert("Alert: Hello World!", "Hello Go!")                  
	prints.Alertf("Alertf: %s %s\n", "Hello World!", "Hello Go!")     

	// prompt
	r1, _ := prints.Ask("What is your name?", "FLC") 
	if r1 == "FLC" {
		prints.Warn("You are FLC!") 
	} else {
		prints.Infof("You are %s!\n", r1) 
	}
	r2, _ := prints.Ask("What is your name?") 
	prints.Info(r2)

	// secret
	r3, _ := prints.Secret("What is your password?", "123456")
	prints.Info("The password is " + r3)

	// progress bar
	bar := prints.NewProgressBar(100, prints.WithTemplate(prints.Full))
	for i := 1; i <= 100; i++ {
		time.Sleep(time.Millisecond * 100)
		bar.Increment()
	}

	bar.Finish()
}

Output:

Thanks

• https://github.com/fatih/color
• https://github.com/cheggaaa/pb

Documentation

Index

• Variables
• func Alert(a ...any) (int, error)
• func Alertf(format string, a ...any) (int, error)
• func Ask(question string, defaults ...string) (string, error)
• func Comment(a ...any) (int, error)
• func Commentf(format string, a ...any) (int, error)
• func Error(a ...any) (int, error)
• func Errorf(format string, a ...any) (int, error)
• func Info(a ...any) (int, error)
• func Infof(format string, a ...any) (int, error)
• func Line(a ...any) (int, error)
• func Linef(format string, a ...any) (int, error)
• func NewLine(length ...int) (int, error)
• func Secret(question string, defaults ...string) (string, error)
• func Success(a ...any) (int, error)
• func Successf(format string, a ...any) (int, error)
• func Warn(a ...any) (int, error)
• func Warnf(format string, a ...any) (int, error)
• func WithProgressBar(total int, fc func(bar *ProgressBar), opts ...ProgressBarOption)
• type ProgressBar
  • func NewProgressBar(total int, opts ...ProgressBarOption) *ProgressBar
• type ProgressBarOption
  • func WithTemplate(template pb.ProgressBarTemplate) ProgressBarOption
• type Prompt
  • func NewPrompt(question string, opts ...PromptOption) *Prompt
  • func (p *Prompt) Ask() (string, error)
• type PromptOption
  • func WithDefaultAnswer(defaultAnswer string) PromptOption
  • func WithSecret() PromptOption
  • func WithTrimSpace(flag bool) PromptOption

Variables

var (
	Full    = pb.Full
	Default = pb.Default
	Simple  = pb.Simple

	FullTemplate    = WithTemplate(Full)
	DefaultTemplate = WithTemplate(Default)
	SimpleTemplate  = WithTemplate(Simple)
)

Functions

func Alert

func Alert(a ...any) (int, error)

func Alertf

func Alertf(format string, a ...any) (int, error)

func Ask

func Ask(question string, defaults ...string) (string, error)

func Comment

func Comment(a ...any) (int, error)

func Commentf

func Commentf(format string, a ...any) (int, error)

func Error

func Error(a ...any) (int, error)

func Errorf

func Errorf(format string, a ...any) (int, error)

func Info

func Info(a ...any) (int, error)

func Infof

func Infof(format string, a ...any) (int, error)

func Line

func Line(a ...any) (int, error)

func Linef

func Linef(format string, a ...any) (int, error)

func NewLine

func NewLine(length ...int) (int, error)

func Secret

func Secret(question string, defaults ...string) (string, error)

func Success

func Success(a ...any) (int, error)

func Successf

func Successf(format string, a ...any) (int, error)

func Warn

func Warn(a ...any) (int, error)

func Warnf

func Warnf(format string, a ...any) (int, error)

func WithProgressBar

func WithProgressBar(total int, fc func(bar *ProgressBar), opts ...ProgressBarOption)

Types

type ProgressBar

type ProgressBar struct {
	*pb.ProgressBar
	// contains filtered or unexported fields
}

func NewProgressBar

func NewProgressBar(total int, opts ...ProgressBarOption) *ProgressBar

type ProgressBarOption

type ProgressBarOption func(*ProgressBar)

func WithTemplate

func WithTemplate(template pb.ProgressBarTemplate) ProgressBarOption

type Prompt

type Prompt struct {
	// contains filtered or unexported fields
}

func NewPrompt

func NewPrompt(question string, opts ...PromptOption) *Prompt

func (*Prompt) Ask

func (p *Prompt) Ask() (string, error)

type PromptOption

type PromptOption func(*Prompt)

func WithDefaultAnswer

func WithDefaultAnswer(defaultAnswer string) PromptOption

func WithSecret

func WithSecret() PromptOption

func WithTrimSpace

func WithTrimSpace(flag bool) PromptOption