cowsay

README

Neo Cowsay

Neo Cowsay is written in Go. This cowsay is extended the original cowsay. added fun more options, and you can be used as a library.

for GitHub Actions users: Code-Hex/neo-cowsay-action

 ______________
< I'm Neo cows >
 --------------
       \   ^__^
        \  (oo)\_______
           (__)\       )\/\
               ||----w |
               ||     ||

About cowsay

According to the original original manual.

cowsay is a configurable talking cow, written in Perl. It operates
much as the figlet program does, and it written in the same spirit
of silliness.

This is also supported COWPATH env. Please read more details in #33 if you want to use this.

What makes it different from the original?

• fast
• utf8 is supported
• new some cowfiles is added
• cowfiles in binary
• random pickup cowfile option
• provides command-line fuzzy finder to search any cows with -f - #39
• coloring filter options
• super mode

Movies for new options 🐮

Random

Rainbow and Aurora, Bold

And, Super Cows mode

https://user-images.githubusercontent.com/6500104/140379043-53e44994-b1b0-442e-bda7-4f7ab3aedf01.mov

Usage

As command

cow{say,think} version 2.0.0, (c) 2021 codehex
Usage: cowsay [-bdgpstwy] [-h] [-e eyes] [-f cowfile] [--random]
      [-l] [-n] [-T tongue] [-W wrapcolumn]
      [--bold] [--rainbow] [--aurora] [--super] [message]

Original Author: (c) 1999 Tony Monroe
Repository: https://github.com/Code-Hex/Neo-cowsay

Normal

$ cowsay Hello
 _______
< Hello >
 -------
       \   ^__^
        \  (oo)\_______
           (__)\       )\/\
               ||----w |
               ||     ||

Borg mode

$ cowsay -b Hello
 _______
< Hello >
 -------
       \   ^__^
        \  (==)\_______
           (__)\       )\/\
               ||----w |
               ||     ||

As library

package main

import (
	"fmt"

	cowsay "github.com/Code-Hex/Neo-cowsay/v2"
)

func main() {
	say, err := cowsay.Say(
		"Hello",
		cowsay.Type("default"),
		cowsay.BallonWidth(40),
	)
	if err != nil {
		panic(err)
	}
	fmt.Println(say)
}

Examples or GoDoc

Install

Mac and Linux users via Homebrew

$ brew update
$ brew install Code-Hex/tap/neo-cowsay

Binary

You can download from here

library

$ go get github.com/Code-Hex/Neo-cowsay/v2

Go

cowsay

$ go install github.com/Code-Hex/Neo-cowsay/cmd/v2/cowsay@latest

cowthink

$ go install github.com/Code-Hex/Neo-cowsay/cmd/v2/cowthink@latest

License

cowsay license

==============
cowsay License
==============

cowsay is distributed under the same licensing terms as Perl: the
Artistic License or the GNU General Public License.  If you don't
want to track down these licenses and read them for yourself, use
the parts that I'd prefer:

(0) I wrote it and you didn't.

(1) Give credit where credit is due if you borrow the code for some
other purpose.

(2) If you have any bugfixes or suggestions, please notify me so
that I may incorporate them.

(3) If you try to make money off of cowsay, you suck.

===============
cowsay Legalese
===============

(0) Copyright (c) 1999 Tony Monroe.  All rights reserved.  All
lefts may or may not be reversed at my discretion.

(1) This software package can be freely redistributed or modified
under the terms described above in the "cowsay License" section
of this file.

(2) cowsay is provided "as is," with no warranties whatsoever,
expressed or implied.  If you want some implied warranty about
merchantability and/or fitness for a particular purpose, you will
not find it here, because there is no such thing here.

(3) I hate legalese.

(The Artistic License or The GNU General Public License)

Author

Neo Cowsay: codehex
Original: (c) 1999 Tony Monroe

Documentation

Index

• func Asset(path string) ([]byte, error)
• func AssetNames() []string
• func CowsInBinary() []string
• func Say(phrase string, options ...Option) (string, error)
• type Cow
  • func New(options ...Option) (*Cow, error)
  • func (cow *Cow) Balloon(phrase string) string
  • func (cow *Cow) Clone(options ...Option) (*Cow, error)
  • func (cow *Cow) GetCow() (string, error)
  • func (cow *Cow) Say(phrase string) (string, error)
• type CowFile
  • func (c *CowFile) ReadAll() ([]byte, error)
• type CowPath
  • func Cows() ([]*CowPath, error)
  • func (c *CowPath) Lookup(target string) (*CowFile, bool)
• type LocationType
• type NotFound
  • func (n *NotFound) Error() string
• type Option
  • func BallonWidth(size uint) Option
  • func DisableWordWrap() Option
  • func Eyes(s string) Option
  • func Random() Option
  • func Thinking() Option
  • func Thoughts(thoughts rune) Option
  • func Tongue(s string) Option
  • func Type(s string) Option

Functions

func Asset

func Asset(path string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the list of filename of the assets.

func CowsInBinary

func CowsInBinary() []string

CowsInBinary returns the list of cowfiles which are in binary. the list is memoized.

func Say

func Say(phrase string, options ...Option) (string, error)

Say to return cowsay string.

Types

type Cow

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

Cow struct!!

func New

func New(options ...Option) (*Cow, error)

New returns pointer of Cow struct that made by options

func (*Cow) Balloon

func (cow *Cow) Balloon(phrase string) string

Balloon to get the balloon and the string entered in the balloon.

func (*Cow) Clone

func (cow *Cow) Clone(options ...Option) (*Cow, error)

Clone returns a copy of cow.

If any options are specified, they will be reflected.

func (*Cow) GetCow

func (cow *Cow) GetCow() (string, error)

GetCow to get cow's ascii art

func (*Cow) Say

func (cow *Cow) Say(phrase string) (string, error)

Say returns string that said by cow

type CowFile

type CowFile struct {
	// Name is name of the cowfile.
	Name string
	// BasePath is the path which the cowpath is in.
	BasePath string
	// LocationType is the type of COWPATH
	LocationType LocationType
}

CowFile is information of the cowfile.

func (*CowFile) ReadAll

func (c *CowFile) ReadAll() ([]byte, error)

ReadAll reads the cowfile content. If LocationType is InBinary, the file read from binary. otherwise reads from file system.

type CowPath

type CowPath struct {
	// Name is name of the COWPATH.
	// If you specified `COWPATH=/foo/bar`, Name is `/foo/bar`.
	Name string
	// CowFiles are name of the cowfile which are trimmed ".cow" suffix.
	CowFiles []string
	// LocationType is the type of COWPATH
	LocationType LocationType
}

CowPath is information of the COWPATH.

func Cows

func Cows() ([]*CowPath, error)

Cows to get list of cows

func (*CowPath) Lookup

func (c *CowPath) Lookup(target string) (*CowFile, bool)

Lookup will look for the target cowfile in the specified path. If it exists, it returns the cowfile information and true value.

type LocationType

type LocationType int

LocationType indicates the type of COWPATH.

const (
	// InBinary indicates the COWPATH in binary.
	InBinary LocationType = iota

	// InDirectory indicates the COWPATH in your directory.
	InDirectory
)

type NotFound

type NotFound struct {
	Cowfile string
}

NotFound is indicated not found the cowfile.

func (*NotFound) Error

func (n *NotFound) Error() string

type Option

type Option func(*Cow) error

Option defined for Options

func BallonWidth

func BallonWidth(size uint) Option

BallonWidth specifies ballon size

func DisableWordWrap

func DisableWordWrap() Option

DisableWordWrap disables word wrap. Ignoring width of the ballon.

func Eyes

func Eyes(s string) Option

Eyes specifies eyes The specified string will always be adjusted to be equal to two characters.

func Random

func Random() Option

Random specifies something .cow from cows directory

func Thinking

func Thinking() Option

Thinking enables thinking mode

func Thoughts

func Thoughts(thoughts rune) Option

Thoughts Thoughts allows you to specify the rune that will be drawn between the speech bubbles and the cow

func Tongue

func Tongue(s string) Option

Tongue specifies tongue The specified string will always be adjusted to be less than or equal to two characters.

func Type

func Type(s string) Option

Type specify name of the cowfile