Fix stuttering names

bryphe-coder · bryphe-coder · commit 1a7393b68264 · 2022-02-15T23:10:05.000Z
diff --git a/console/console.go b/console/console.go
@@ -31,17 +31,17 @@ import (
 // input back on it's tty. Console can also multiplex other sources of input
 // and multiplex its output to other writers.
 type Console struct {
-	opts       ConsoleOpts
+	opts       Opts
 	pty        pty.Pty
 	runeReader *bufio.Reader
 	closers    []io.Closer
 }
 
-// ConsoleOpt allows setting Console options.
-type ConsoleOpt func(*ConsoleOpts) error
+// Opt allows setting Console options.
+type Opt func(*Opts) error
 
-// ConsoleOpts provides additional options on creating a Console.
-type ConsoleOpts struct {
+// Opts provides additional options on creating a Console.
+type Opts struct {
 	Logger          *log.Logger
 	Stdouts         []io.Writer
 	ExpectObservers []Observer
@@ -62,33 +62,33 @@ type Observer func(matchers []Matcher, buf string, err error)
 // last writer, writing to it's internal buffer for matching expects.
 // If a listed writer returns an error, that overall write operation stops and
 // returns the error; it does not continue down the list.
-func WithStdout(writers ...io.Writer) ConsoleOpt {
-	return func(opts *ConsoleOpts) error {
+func WithStdout(writers ...io.Writer) Opt {
+	return func(opts *Opts) error {
 		opts.Stdouts = append(opts.Stdouts, writers...)
 		return nil
 	}
 }
 
 // WithLogger adds a logger for Console to log debugging information to. By
 // default Console will discard logs.
-func WithLogger(logger *log.Logger) ConsoleOpt {
-	return func(opts *ConsoleOpts) error {
+func WithLogger(logger *log.Logger) Opt {
+	return func(opts *Opts) error {
 		opts.Logger = logger
 		return nil
 	}
 }
 
 // WithExpectObserver adds an ExpectObserver to allow monitoring Expect operations.
-func WithExpectObserver(observers ...Observer) ConsoleOpt {
-	return func(opts *ConsoleOpts) error {
+func WithExpectObserver(observers ...Observer) Opt {
+	return func(opts *Opts) error {
 		opts.ExpectObservers = append(opts.ExpectObservers, observers...)
 		return nil
 	}
 }
 
 // NewConsole returns a new Console with the given options.
-func NewConsole(opts ...ConsoleOpt) (*Console, error) {
-	options := ConsoleOpts{
+func NewConsole(opts ...Opt) (*Console, error) {
+	options := Opts{
 		Logger: log.New(ioutil.Discard, "", 0),
 	}
 
diff --git a/console/expect.go b/console/expect.go
@@ -40,8 +40,8 @@ func (c *Console) ExpectString(s string) (string, error) {
 // expecting input yet, it will be blocked. Sends are queued up in tty's
 // internal buffer so that the next Expect will read the remaining bytes (i.e.
 // rest of prompt) as well as its conditions.
-func (c *Console) Expect(opts ...Opt) (string, error) {
-	var options Opts
+func (c *Console) Expect(opts ...ExpectOpt) (string, error) {
+	var options ExpectOpts
 	for _, opt := range opts {
 		if err := opt(&options); err != nil {
 			return "", err
diff --git a/console/expect_opt.go b/console/expect_opt.go
@@ -20,22 +20,22 @@ import (
 	"time"
 )
 
-// Opt allows settings Expect options.
-type Opt func(*Opts) error
+// ExpectOpt allows settings Expect options.
+type ExpectOpt func(*ExpectOpts) error
 
-// ConsoleCallback is a callback function to execute if a match is found for
+// Callback is a callback function to execute if a match is found for
 // the chained matcher.
-type ConsoleCallback func(buf *bytes.Buffer) error
+type Callback func(buf *bytes.Buffer) error
 
-// Opts provides additional options on Expect.
-type Opts struct {
+// ExpectOpts provides additional options on Expect.
+type ExpectOpts struct {
 	Matchers    []Matcher
 	ReadTimeout *time.Duration
 }
 
 // Match sequentially calls Match on all matchers in ExpectOpts and returns the
 // first matcher if a match exists, otherwise nil.
-func (eo Opts) Match(v interface{}) Matcher {
+func (eo ExpectOpts) Match(v interface{}) Matcher {
 	for _, matcher := range eo.Matchers {
 		if matcher.Match(v) {
 			return matcher
@@ -83,7 +83,7 @@ func (sm *stringMatcher) Criteria() interface{} {
 // allMatcher fulfills the Matcher interface to match a group of ExpectOpt
 // against any value.
 type allMatcher struct {
-	options Opts
+	options ExpectOpts
 }
 
 func (am *allMatcher) Match(v interface{}) bool {
@@ -109,9 +109,9 @@ func (am *allMatcher) Criteria() interface{} {
 
 // All adds an Expect condition to exit if the content read from Console's tty
 // matches all of the provided ExpectOpt, in any order.
-func All(expectOpts ...Opt) Opt {
-	return func(opts *Opts) error {
-		var options Opts
+func All(expectOpts ...ExpectOpt) ExpectOpt {
+	return func(opts *ExpectOpts) error {
+		var options ExpectOpts
 		for _, opt := range expectOpts {
 			if err := opt(&options); err != nil {
 				return err
@@ -127,8 +127,8 @@ func All(expectOpts ...Opt) Opt {
 
 // String adds an Expect condition to exit if the content read from Console's
 // tty contains any of the given strings.
-func String(strs ...string) Opt {
-	return func(opts *Opts) error {
+func String(strs ...string) ExpectOpt {
+	return func(opts *ExpectOpts) error {
 		for _, str := range strs {
 			opts.Matchers = append(opts.Matchers, &stringMatcher{
 				str: str,
diff --git a/console/expect_opt_test.go b/console/expect_opt_test.go
@@ -28,7 +28,7 @@ func TestExpectOptString(t *testing.T) {
 
 	tests := []struct {
 		title    string
-		opt      Opt
+		opt      ExpectOpt
 		data     string
 		expected bool
 	}{
@@ -63,7 +63,7 @@ func TestExpectOptString(t *testing.T) {
 		t.Run(test.title, func(t *testing.T) {
 			t.Parallel()
 
-			var options Opts
+			var options ExpectOpts
 			err := test.opt(&options)
 			require.Nil(t, err)
 
@@ -86,7 +86,7 @@ func TestExpectOptAll(t *testing.T) {
 
 	tests := []struct {
 		title    string
-		opt      Opt
+		opt      ExpectOpt
 		data     string
 		expected bool
 	}{
@@ -144,7 +144,7 @@ func TestExpectOptAll(t *testing.T) {
 		test := test
 		t.Run(test.title, func(t *testing.T) {
 			t.Parallel()
-			var options Opts
+			var options ExpectOpts
 			err := test.opt(&options)
 			require.Nil(t, err)
 
diff --git a/console/expect_test.go b/console/expect_test.go
@@ -71,14 +71,14 @@ func Prompt(in io.Reader, out io.Writer) error {
 	return nil
 }
 
-func newTestConsole(t *testing.T, opts ...ConsoleOpt) (*Console, error) {
-	opts = append([]ConsoleOpt{
+func newTestConsole(t *testing.T, opts ...Opt) (*Console, error) {
+	opts = append([]Opt{
 		expectNoError(t),
 	}, opts...)
 	return NewConsole(opts...)
 }
 
-func expectNoError(t *testing.T) ConsoleOpt {
+func expectNoError(t *testing.T) Opt {
 	return WithExpectObserver(
 		func(matchers []Matcher, buf string, err error) {
 			if err == nil {
