Ensure CI is satisfied

nhooyr · nhooyr · commit 00ca8feb9176 · 2019-03-29T17:38:58.000-05:00
diff --git a/.github/fmt/entrypoint.sh b/.github/fmt/entrypoint.sh
@@ -8,7 +8,7 @@ gen() {
 	go list ./... > /dev/null
 	go mod tidy
 
-	go install github.com/golang/protobuf/protoc-gen-go
+	go install golang.org/x/tools/cmd/stringer
 	go generate ./...
 }
 
diff --git a/.github/main.workflow b/.github/main.workflow
@@ -1,6 +1,10 @@
 workflow "main" {
   on = "push"
-  resolves = ["fmt", "test"]
+  resolves = ["fmt", "lint", "test"]
+}
+
+action "lint" {
+  uses = "./.github/lint"
 }
 
 action "fmt" {
diff --git a/dataframe_string.go b/dataframe_string.go
diff --git a/datatype.go b/datatype.go
@@ -8,6 +8,7 @@ import (
 //go:generate stringer -type=DataType
 type DataType int
 
+// DataType constants.
 const (
 	Text   DataType = DataType(wscore.OpText)
 	Binary DataType = DataType(wscore.OpBinary)
diff --git a/datatype_string.go b/datatype_string.go
diff --git a/example_test.go b/example_test.go
@@ -8,11 +8,12 @@ import (
 	"time"
 
 	"golang.org/x/time/rate"
+
 	"nhooyr.io/ws"
 	"nhooyr.io/ws/wsjson"
 )
 
-func ExampleEcho() {
+func ExampleAccept_echo() {
 	fn := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		c, err := ws.Accept(w, r,
 			ws.AcceptSubprotocols("echo"),
@@ -85,7 +86,7 @@ func ExampleAccept() {
 		type myJsonStruct struct {
 			MyField string `json:"my_field"`
 		}
-		err = wsjson.Write(c, myJsonStruct{
+		err = wsjson.Write(r.Context(), c, myJsonStruct{
 			MyField: "foo",
 		})
 		if err != nil {
@@ -118,7 +119,7 @@ func ExampleDial() {
 	type myJsonStruct struct {
 		MyField string `json:"my_field"`
 	}
-	err = wsjson.Write(c, myJsonStruct{
+	err = wsjson.Write(ctx, c, myJsonStruct{
 		MyField: "foo",
 	})
 	if err != nil {
diff --git a/go.mod b/go.mod
@@ -6,8 +6,8 @@ require (
 	github.com/golang/protobuf v1.3.1
 	github.com/kr/pretty v0.1.0 // indirect
 	go.coder.com/go-tools v0.0.0-20190317003359-0c6a35b74a16
-	golang.org/x/net v0.0.0-20190311183353-d8887717615a
-	golang.org/x/time v0.0.0-20190308202827-9d24e82272b4 // indirect
-	golang.org/x/tools v0.0.0-20190315191501-e6df0c1bb376
+	golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3
+	golang.org/x/time v0.0.0-20190308202827-9d24e82272b4
+	golang.org/x/tools v0.0.0-20190329215204-73054e8977d1
 	mvdan.cc/sh v2.6.4+incompatible
 )
diff --git a/go.sum b/go.sum
@@ -8,14 +8,17 @@ github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 go.coder.com/go-tools v0.0.0-20190317003359-0c6a35b74a16 h1:3gGa1bM0nG7Ruhu5b7wKnoOOwAD/fJ8iyyAcpOzDG3A=
 go.coder.com/go-tools v0.0.0-20190317003359-0c6a35b74a16/go.mod h1:iKV5yK9t+J5nG9O3uF6KYdPEz3dyfMyB15MN1rbQ8Qw=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3 h1:XQyxROzUlZH+WIQwySDgnISgOivlhjIEwaQaJEJrrN0=
+golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
 golang.org/x/net v0.0.0-20190311183353-d8887717615a h1:oWX7TPOiFAMXLq8o0ikBYfCJVlRHBcsciT5bXOrH628=
 golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/time v0.0.0-20190308202827-9d24e82272b4 h1:SvFZT6jyqRaOeXpc5h/JSfZenJ2O330aBsf7JfSUXmQ=
 golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
-golang.org/x/tools v0.0.0-20190315191501-e6df0c1bb376 h1:GfNg/J4IAJguoN+DWPTZ54ElycoBxtQkpxhrbA5edVA=
-golang.org/x/tools v0.0.0-20190315191501-e6df0c1bb376/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
+golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
+golang.org/x/tools v0.0.0-20190329215204-73054e8977d1 h1:rLRH2E2wN5JjGJSVlBe1ioUkCKgb6eoL9X8bDmtEpsk=
+golang.org/x/tools v0.0.0-20190329215204-73054e8977d1/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
 mvdan.cc/sh v2.6.4+incompatible h1:eD6tDeh0pw+/TOTI1BBEryZ02rD2nMcFsgcvde7jffM=
 mvdan.cc/sh v2.6.4+incompatible/go.mod h1:IeeQbZq+x2SUGBensq/jge5lLQbS3XT2ktyp3wrt4x8=
diff --git a/statuscode_string.go b/statuscode_string.go
diff --git a/tools.go b/tools.go
@@ -5,6 +5,7 @@ package tools
 // See https://github.com/go-modules-by-example/index/blob/master/010_tools/README.md
 import (
 	_ "go.coder.com/go-tools/cmd/goimports"
+	_ "golang.org/x/lint/golint"
 	_ "golang.org/x/tools/cmd/stringer"
 	_ "mvdan.cc/sh/cmd/shfmt"
 )
diff --git a/ws.go b/ws.go
@@ -2,6 +2,7 @@ package ws
 
 import (
 	"context"
+	"net"
 )
 
 const (
@@ -18,6 +19,11 @@ func (c *Conn) Subprotocol() string {
 	panic("TODO")
 }
 
+// NetConn returns the net.Conn underlying the Conn.
+func (c *Conn) NetConn() net.Conn {
+	panic("TODO")
+}
+
 // MessageWriter returns a writer bounded by the context that will write
 // a WebSocket data frame of type dataType to the connection.
 // Ensure you close the MessageWriter once you have written to entire message.
diff --git a/wscore/header.go b/wscore/header.go
@@ -19,10 +19,12 @@ type Header struct {
 	MaskKey [4]byte
 }
 
+// Bytes returns the bytes of the header.
 func (h Header) Bytes() []byte {
 	panic("TODO")
 }
 
-func ReaderHeader(r io.Reader) []byte {
+// ReadHeader reads a header from the reader.
+func ReadHeader(r io.Reader) []byte {
 	panic("TODO")
 }
diff --git a/wscore/opcode.go b/wscore/opcode.go
@@ -4,6 +4,7 @@ package wscore
 //go:generate stringer -type=Opcode
 type Opcode int
 
+// Opcode constants.
 const (
 	OpContinuation Opcode = iota
 	OpText
diff --git a/wscore/opcode_string.go b/wscore/opcode_string.go
diff --git a/wsjson/wsjon.go b/wsjson/wsjon.go
@@ -1,13 +1,17 @@
 package wsjson
 
 import (
+	"context"
+
 	"nhooyr.io/ws"
 )
 
-func Read(c *ws.Conn, v interface{}) error {
+// Read reads a json message from c into v.
+func Read(ctx context.Context, c *ws.Conn, v interface{}) error {
 	panic("TODO")
 }
 
-func Write(c *ws.Conn, v interface{}) error {
+// Write writes the json message v into c.
+func Write(ctx context.Context, c *ws.Conn, v interface{}) error {
 	panic("TODO")
 }
diff --git a/wspb/wspb.go b/wspb/wspb.go
@@ -1,15 +1,19 @@
 package wspb
 
 import (
+	"context"
+
 	"github.com/golang/protobuf/proto"
 
 	"nhooyr.io/ws"
 )
 
-func Read(c *ws.Conn, v proto.Message) error {
+// Read reads a protobuf message from c into v.
+func Read(ctx context.Context, c *ws.Conn, v proto.Message) error {
 	panic("TODO")
 }
 
-func Write(c *ws.Conn, v proto.Message) error {
+// Write writes the protobuf message into c.
+func Write(ctx context.Context, c *ws.Conn, v proto.Message) error {
 	panic("TODO")
 }

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ gen() {`
`8`	`8`	`go list ./... > /dev/null`
`9`	`9`	`go mod tidy`
`10`	`10`
`11`		`- go install github.com/golang/protobuf/protoc-gen-go`
	`11`	`+ go install golang.org/x/tools/cmd/stringer`
`12`	`12`	`go generate ./...`
`13`	`13`	`}`
`14`	`14`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ package tools`
`5`	`5`	`// See https://github.com/go-modules-by-example/index/blob/master/010_tools/README.md`
`6`	`6`	`import (`
`7`	`7`	`_ "go.coder.com/go-tools/cmd/goimports"`
	`8`	`+ _ "golang.org/x/lint/golint"`
`8`	`9`	`_ "golang.org/x/tools/cmd/stringer"`
`9`	`10`	`_ "mvdan.cc/sh/cmd/shfmt"`
`10`	`11`	`)`
Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,12 @@ type Header struct {`
`19`	`19`	`MaskKey [4]byte`
`20`	`20`	`}`
`21`	`21`
	`22`	`+// Bytes returns the bytes of the header.`
`22`	`23`	`func (h Header) Bytes() []byte {`
`23`	`24`	`panic("TODO")`
`24`	`25`	`}`
`25`	`26`
`26`		`-func ReaderHeader(r io.Reader) []byte {`
	`27`	`+// ReadHeader reads a header from the reader.`
	`28`	`+func ReadHeader(r io.Reader) []byte {`
`27`	`29`	`panic("TODO")`
`28`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,17 @@`
`1`	`1`	`package wsjson`
`2`	`2`
`3`	`3`	`import (`
	`4`	`+ "context"`
	`5`	`+`
`4`	`6`	`"nhooyr.io/ws"`
`5`	`7`	`)`
`6`	`8`
`7`		`-func Read(c *ws.Conn, v interface{}) error {`
	`9`	`+// Read reads a json message from c into v.`
	`10`	`+func Read(ctx context.Context, c *ws.Conn, v interface{}) error {`
`8`	`11`	`panic("TODO")`
`9`	`12`	`}`
`10`	`13`
`11`		`-func Write(c *ws.Conn, v interface{}) error {`
	`14`	`+// Write writes the json message v into c.`
	`15`	`+func Write(ctx context.Context, c *ws.Conn, v interface{}) error {`
`12`	`16`	`panic("TODO")`
`13`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,15 +1,19 @@`
`1`	`1`	`package wspb`
`2`	`2`
`3`	`3`	`import (`
	`4`	`+ "context"`
	`5`	`+`
`4`	`6`	`"github.com/golang/protobuf/proto"`
`5`	`7`
`6`	`8`	`"nhooyr.io/ws"`
`7`	`9`	`)`
`8`	`10`
`9`		`-func Read(c *ws.Conn, v proto.Message) error {`
	`11`	`+// Read reads a protobuf message from c into v.`
	`12`	`+func Read(ctx context.Context, c *ws.Conn, v proto.Message) error {`
`10`	`13`	`panic("TODO")`
`11`	`14`	`}`
`12`	`15`
`13`		`-func Write(c *ws.Conn, v proto.Message) error {`
	`16`	`+// Write writes the protobuf message into c.`
	`17`	`+func Write(ctx context.Context, c *ws.Conn, v proto.Message) error {`
`14`	`18`	`panic("TODO")`
`15`	`19`	`}`