chicken

package module

v0.0.0-...-f26a608 Latest Latest Go to latest Published: Mar 17, 2019 License: BSD-3-Clause Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/thisisaaronland/go-chicken

Links

Open Source Insights

README ¶

go-chicken

🐔 🐔 🐔

Install

make build

This will build a copy of chicken and put it in the bin directory.

Usage

$> ./bin/chicken -h
Usage of ./bin/chicken:
  -clucking
	Make chicken noises
  -language string
	A valid ISO-639-3 language code. (default "zxx")

Chicken

$> ./bin/chicken ./cmd/chicken.go
🐔 🐔

🐔 (
	"🐔"
	"🐔"
	"🐔"
	"🐔.🐔/🐔/🐔-🐔"
	"🐔"
)

🐔 🐔() {

	🐔 🐔 🐔 🐔 🐔.🐔("🐔", "🐔", "🐔 🐔 🐔-639-3 🐔 🐔.")
	🐔 🐔 🐔 🐔 🐔.🐔("🐔", 🐔, "🐔 🐔 🐔")

	🐔.🐔()

	🐔, 🐔 :🐔 🐔 🐔.🐔(*🐔, *🐔)

	🐔 🐔 !🐔 🐔 🐔 {
		🐔(🐔)
	}

	🐔 _, 🐔 :🐔 🐔 🐔 🐔.🐔() {

		🐔 🐔 *🐔.🐔

		🐔 🐔 🐔 🐔🐔 🐔 "-" {
			🐔 🐔 🐔 🐔.🐔(🐔.🐔)
		} 🐔 {

			🐔, 🐔 :🐔 🐔 🐔.🐔(🐔)

			🐔 🐔 !🐔 🐔 🐔 {
				🐔(🐔)
			}

			🐔 🐔 🐔 🐔.🐔(🐔)
		}

		🐔 🐔.🐔() {
			🐔 :🐔 🐔 🐔.🐔()
			🐔.🐔(🐔.🐔(🐔))
		}
	}
}

Languages

$> ./bin/chicken -language eng ./cmd/chicken.go
chicken chicken

chicken (
	"chicken"
	"chicken"
	"chicken"
	"chicken.chicken/chicken/chicken-chicken"
	"chicken"
)

chicken chicken() {

	chicken chicken chicken chicken chicken.chicken("chicken", "chicken", "chicken chicken chicken-639-3 chicken chicken.")
	chicken chicken chicken chicken chicken.chicken("chicken", chicken, "chicken chicken chicken")

	chicken.chicken()

	chicken, chicken :chicken chicken chicken.chicken(*chicken, *chicken)

	chicken chicken !chicken chicken chicken {
		chicken(chicken)
	}

	chicken _, chicken :chicken chicken chicken chicken.chicken() {

		chicken chicken *chicken.chicken

		chicken chicken chicken chickenchicken chicken "-" {
			chicken chicken chicken chicken.chicken(chicken.chicken)
		} chicken {

			chicken, chicken :chicken chicken chicken.chicken(chicken)

			chicken chicken !chicken chicken chicken {
				chicken(chicken)
			}

			chicken chicken chicken chicken.chicken(chicken)
		}

		chicken chicken.chicken() {
			chicken :chicken chicken chicken.chicken()
			chicken.chicken(chicken.chicken(chicken))
		}
	}
}

Reading from STDIN

You can tell chicken to read from STDIN by passing - as its input argument.

$> yes | ./bin/chicken -language hbo -
עוף
עוף
עוף
עוף
עוף
עוף
עוף

Or:

$> echo "hello there :chicken:" | ./bin/chicken -
🐔 🐔 🐔

Clucking

Language support for clucking is not uniformly supported yet.

$> ./bin/chicken -language eng -clucking ./cmd/chicken.go

bok bok b'gawk cluck cluck

bok bok b'gawk (
	"bok bok b'gawk"
	"bok bok bok"
	"cluck cluck"
	"bok bok bok.bok bok b'gawk/bok bok bok/cluck cluck-bok bok b'gawk"
	"bok bok bok"
)

cluck cluck bok bok b'gawk() {

	bok bok bok bok bok b'gawk cluck cluck bok bok b'gawk bok bok b'gawk.bok bok b'gawk("bok bok b'gawk", "cluck cluck", "bok bok b'gawk bok bok bok cluck cluck-639-3 bok bok bok bok bok bok.")
	bok bok bok cluck cluck cluck cluck bok bok bok cluck cluck.bok bok b'gawk("bok bok b'gawk", cluck cluck, "bok bok b'gawk cluck cluck bok bok bok")

	cluck cluck.cluck cluck()

	bok bok bok, bok bok bok :bok bok bok cluck cluck bok bok bok.cluck cluck(*bok bok bok, *bok bok bok)

	bok bok bok cluck cluck !cluck cluck bok bok bok cluck cluck {
		cluck cluck(bok bok bok)
	}

	bok bok bok _, bok bok b'gawk :cluck cluck bok bok bok bok bok b'gawk bok bok b'gawk.cluck cluck() {

		cluck cluck cluck cluck *bok bok bok.bok bok b'gawk

		bok bok b'gawk bok bok b'gawk bok bok b'gawk bok bok b'gawkbok bok bok cluck cluck "-" {
			bok bok b'gawk bok bok b'gawk cluck cluck cluck cluck.bok bok bok(bok bok bok.bok bok bok)
		} bok bok b'gawk {

			cluck cluck, cluck cluck :bok bok bok bok bok bok bok bok b'gawk.bok bok bok(bok bok b'gawk)

			bok bok b'gawk bok bok b'gawk !bok bok bok bok bok b'gawk bok bok bok {
				cluck cluck(bok bok bok)
			}

			cluck cluck bok bok bok cluck cluck cluck cluck.bok bok bok(bok bok b'gawk)
		}

		cluck cluck bok bok bok.cluck cluck() {
			bok bok b'gawk :bok bok b'gawk bok bok b'gawk bok bok bok.bok bok bok()
			cluck cluck.bok bok bok(cluck cluck.bok bok bok(bok bok bok))
		}
	}
}

Rooster

rooster is an HTTP daemon for chicken. For example:

$> bin/rooster
2017/04/30 09:53:53 🐓 on localhost:1280

And then:

$> curl -X POST 'http://localhost:1280' -d 'Hello world'
🐔 🐔

$> curl -X POST 'http://localhost:1280?language=eng' -d 'Hello world'
chicken chicken

$> curl -X POST 'http://localhost:1280?language=kor&clucking' -d 'Hello world'
꼬꼬댁 꼬꼬댁

Emoji

chicken uses the go-ucd library to convert Emoji (and other symbolic characters) in to named strings. For example:

$> ./bin/ucd 😸
GRINNING CAT FACE WITH SMILING EYES

Which becomes:

$> ./bin/chicken -
😸
🐔 🐔 🐔 🐔 🐔 🐔

Or:

./bin/chicken -
🤙
2016/06/23 07:44:32 CHAR '129305' is emoji
2016/06/23 07:44:32 BEFORE UCD '129305'
2016/06/23 07:44:32 AFTER UCD 'CALL ME HAND'
2016/06/23 07:44:32 CHAR '67' is a letter
2016/06/23 07:44:32 CHAR '65' is a letter
2016/06/23 07:44:32 CHAR '76' is a letter
2016/06/23 07:44:32 CHAR '76' is a letter
2016/06/23 07:44:32 CHAR '32' is a space
2016/06/23 07:44:32 CHAR '77' is a letter
2016/06/23 07:44:32 CHAR '69' is a letter
2016/06/23 07:44:32 CHAR '32' is a space
2016/06/23 07:44:32 CHAR '72' is a letter
2016/06/23 07:44:32 CHAR '65' is a letter
2016/06/23 07:44:32 CHAR '78' is a letter
2016/06/23 07:44:32 CHAR '68' is a letter
🐔 🐔 🐔

Note that verbose debugging information was enabled for this example.

Alpha codes

Yes.

./bin/chicken -
hello :smiley_cat:
# BEFORE hello :smiley_cat:
# AFTER hello 😺
# BEFORE %!s(int32=128570)
# AFTER SMILING CAT FACE WITH OPEN MOUTH
🐔 🐔 🐔 🐔 🐔 🐔 🐔

But wait... there's more!

I'm not suggesting you should do these things... only that you can do these things...

Compiling 🐔

$> go build -o 🐔 cmd/chicken.go
$> ./🐔 -h
Usage of ./🐔:
  -clucking
   Make chicken noises
  -language string
   A valid ISO-639-3 language code. (default "zxx")

If you're on a Mac

$> yes | ./bin/chicken -language eng -clucking - | while read line ; do say $line; done

Note: this assumes you're using bash.

Translations

The current list of translations is very short and your help is welcome! The goal is to have a 🐔 for every language listed in ISO 639-3.

Docker

Yes, for rooster.

docker build -t rooster .
docker run -it -p 1280:1280 rooster

$> curl -X POST 'http://localhost:1280' -d 'Hello world'
🐔 🐔

WASM

Yes.

Run the handy make wasm target in the Makefile to build chicken.wasm and then use it like this:

     /* 

     this assumes something like:
     
     <textarea id="raw"></textarea>
     <button id="button" onclick="convert();" disabled>Loading...</button>

     */
	
     if (! WebAssembly.instantiateStreaming){
	 
         WebAssembly.instantiateStreaming = async (resp, importObject) => {
             const source = await (await resp).arrayBuffer();
             return await WebAssembly.instantiate(source, importObject);
         };
     }

     const go = new Go();

     let mod, inst;

     WebAssembly.instantiateStreaming(fetch("chicken.wasm"), go.importObject).then(
	 
          async result => {
	      document.getElementById("button").innerText = "Convert";
	      document.getElementById("button").removeAttribute("disabled");
              mod = result.module;
              inst = result.instance;
	      await go.run(inst);
          }
      );

     async function convert() {

	 var raw_el = document.getElementById("raw");

	 var raw_txt = raw_el.value;
	 var chicken_txt = chicken("zxx", raw_txt);

	 raw_el.value = chicken_txt;
     }

You can see a working example at: https://aaronland.github.io/go-chicken/

Background

chicken

It's all Simon's fault.

Documentation ¶

Index ¶

type Chicken
- func GetChickenForLanguageTag(tag string, clucking bool) (*Chicken, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Chicken ¶

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

func GetChickenForLanguageTag ¶

func GetChickenForLanguageTag(tag string, clucking bool) (*Chicken, error)

func (*Chicken) Chicken ¶

func (ch *Chicken) Chicken() string

func (*Chicken) Cluck ¶

func (ch *Chicken) Cluck() string

func (*Chicken) ExpandAlphaCodes ¶

func (ch *Chicken) ExpandAlphaCodes(txt string) string

func (*Chicken) IsCharEmoji ¶

func (ch *Chicken) IsCharEmoji(char rune) bool

func (*Chicken) String ¶

func (ch *Chicken) String() string

func (*Chicken) TextToChicken ¶

func (ch *Chicken) TextToChicken(txt string) string

Source Files ¶

View all Source files

chicken.go

Directories ¶

Path	Synopsis
cmd
emoji
strings

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

README ¶

go-chicken

Install

Usage

Chicken

Languages

Reading from STDIN

Clucking

Rooster

Emoji

Alpha codes

But wait... there's more!

Compiling 🐔

If you're on a Mac

Translations

Docker

WASM

Background

See also

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type Chicken ¶

func GetChickenForLanguageTag ¶

func (*Chicken) Chicken ¶

func (*Chicken) Cluck ¶

func (*Chicken) ExpandAlphaCodes ¶

func (*Chicken) IsCharEmoji ¶

func (*Chicken) String ¶

func (*Chicken) TextToChicken ¶

Source Files ¶

Directories ¶