lint: fix issues

Fixes mostly missing periods at the end of sentences (in
comments of globals) and misspellings.

It also adds t.Parallel() to test files (where appropriate).

Author: dmke

at.go

@@ -129,7 +129,7 @@ func (d *Device) sendInteractive(part1, part2 string, prompt byte) (err error) {
 		exitInteractive()
 		return
 	}
-	return
+	return nil
 }
 
 // sanityCheck checks whether ports are opened and (if requested) that the initialization
@@ -217,7 +217,7 @@ func (d *Device) Send(req string) (reply string, err error) {
 			t.Reset(Timeout)
 		}
 	}
-	return
+	return reply, err
 }
 
 // Watch starts a monitoring process that will wait for events
@@ -357,7 +357,7 @@ func (d *Device) handleReport(str string) (err error) {
 			return errors.New("at: unknown report: " + str)
 		}
 	}
-	return
+	return nil
 }
 
 // Open is used to open serial ports of the device. This should be used first.

commands.go

@@ -167,7 +167,7 @@ func (b *bootHandshakeReport) Parse(str string) (err error) {
 	return
 }
 
-// Ussd type represents the USSD query string
+// Ussd type represents the USSD query string.
 type Ussd string
 
 // Encode converts the query string into bytes according to the
@@ -278,7 +278,7 @@ func (p *DefaultProfile) CNMI(mode, mt, bm, ds, bfr int) (err error) {
 }
 
 // CMGF sends AT+CMGF with the given value to the device. It toggles
-// the mode of message handling betwen PDU and TEXT.
+// the mode of message handling between PDU and TEXT.
 //
 // Note, that the at package works only in PDU mode.
 func (p *DefaultProfile) CMGF(text bool) (err error) {
@@ -292,7 +292,7 @@ func (p *DefaultProfile) CMGF(text bool) (err error) {
 }
 
 // CMGL sends AT+CMGL with the given filtering flag to the device and then parses
-// the list of received messages that match ther filter. See MessageFlags for the
+// the list of received messages that match their filter. See MessageFlags for the
 // list of supported filters.
 func (p *DefaultProfile) CMGL(flag Opt) (octets map[uint64][]byte, err error) {
 	req := fmt.Sprintf(`AT+CMGL=%d`, flag.ID)
@@ -381,7 +381,7 @@ func (s *SystemInfoReport) Parse(str string) (err error) {
 		if n, err := strconv.ParseUint(str, 10, 8); err != nil {
 			return err
 		} else if opt := resolver(int(n)); opt == UnknownOpt {
-			return errors.New("resolver: unknwon opt")
+			return errors.New("resolver: unknown opt")
 		} else {
 			*field = opt
 			return nil
@@ -406,7 +406,7 @@ func (s *SystemInfoReport) Parse(str string) (err error) {
 	if err = fetch(fields[6], &s.SystemSubmode, SystemSubmodes.Resolve); err != nil {
 		return ErrParseReport
 	}
-	return
+	return nil
 }
 
 // SYSINFO sends AT^SYSINFO to the device and parses the output.
@@ -421,7 +421,7 @@ func (p *DefaultProfile) SYSINFO() (info *SystemInfoReport, err error) {
 }
 
 // COPS sends AT+COPS to the device with parameters that define autosearch and
-// the operator's name representation. The default represenation is numerical.
+// the operator's name representation. The default representation is numerical.
 func (p *DefaultProfile) COPS(auto bool, text bool) (err error) {
 	var a, t int
 	if !auto {

doc.go

@@ -1,16 +1,20 @@
-// Package at is a framework for communication with AT-compatible devices like Huawei modems via serial port.
-// Currently this package is well-suited for Huawei devices and since AT-commands set may vary from device
-// to device, sometimes you'll be forced to implement some logic by yourself.
+// Package at is a framework for communication with AT-compatible devices
+// like Huawei modems via serial port. Currently this package is well-suited
+// for Huawei devices and since AT-commands set may vary from device to
+// device, sometimes you'll be forced to implement some logic by yourself.
 //
 // Framework
 //
-// This framework includes facilities for device monitoring, sending and receiving AT-commands, encoding and decoding SMS
-// messages from or to PDU octet representation (as specified in 3GPP TS 23.040). An example of incoming SMS monitor application is given.
+// This framework includes facilities for device monitoring, sending and
+// receiving AT-commands, encoding and decoding SMS messages from or to PDU
+// octet representation (as specified in 3GPP TS 23.040). An example of
+// incoming SMS monitor application is given.
 //
 // Device-specific config
 //
-// In order to introduce your own logic (i.e. custom modem Init function), you should derive your profile from
-// the default DeviceProfile and override its methods.
+// In order to introduce your own logic (i.e. custom modem Init function),
+// you should derive your profile from the default DeviceProfile and
+// override its methods.
 //
 // About
 //

opts.go

@@ -24,16 +24,18 @@ var UnknownOpt = Opt{ID: -1, Description: "-"}
 // UnknownStringOpt represents a string option that was parsed incorrectly or was not parsed at all.
 var UnknownStringOpt = StringOpt{ID: "nil", Description: "Unknown"}
 
-// KillCmd is an artifical AT command that may be successfully sent to device in order
-// to emulate the responce from it. In other words, if a connection with device stalled and
+// KillCmd is an artificial AT command that may be successfully sent to device in order
+// to emulate the response from it. In other words, if a connection with device stalled and
 // no bytes could be read, then this command is used to read something and then close the connection.
 const KillCmd = "AT_KILL"
 
 // NoopCmd is like a ping command that signals that the device is responsive.
 const NoopCmd = "AT"
 
-type optMap map[int]Opt
-type stringOpts []StringOpt
+type (
+	optMap     map[int]Opt
+	stringOpts []StringOpt
+)
 
 func (o optMap) Resolve(id int) Opt {
 	if opt, ok := o[id]; ok {

opts_test.go

@@ -8,13 +8,17 @@ import (
 
 // Test the field access for an opt.
 func TestOpt(t *testing.T) {
+	t.Parallel()
+
 	opt := ServiceStates.Restricted
 	assert.Equal(t, 1, opt.ID)
 	assert.Equal(t, "Restricted service", opt.Description)
 }
 
 // Test the resolve function of an opt.
 func TestResolve(t *testing.T) {
+	t.Parallel()
+
 	opt := ServiceStates.Restricted
 	assert.Equal(t, opt, ServiceStates.Resolve(1))
 }

pdu/7bit.go

@@ -6,17 +6,16 @@ import (
 	"fmt"
 )
 
-// Esc code.
-const Esc byte = 0x1B
-
-// Ctrl+Z code.
-const Sub byte = 0x1A
-
-// <CR> code.
-const CR byte = 0x0D
+const (
+	Esc byte = 0x1B // Esc code.
+	Sub byte = 0x1A // Ctrl+Z code.
+	CR  byte = 0x0D // <CR> code.
+)
 
-var crcr = []byte{CR, CR}
-var cr = []byte{CR}
+var (
+	crcr = []byte{CR, CR}
+	cr   = []byte{CR}
+)
 
 const (
 	max     byte = 0x7F
@@ -105,12 +104,12 @@ func pack7Bit(raw7 []byte) []byte {
 	// N.B. in order to not confuse 7 zero-bits with @
 	// <CR> code is added to the packed bits.
 	if 8-bit == 7 {
-		oct, bit = pack(pack7, CR, oct, bit)
+		pack(pack7, CR, oct, bit)
 	} else if bit == 0 && b == CR {
 		// and if data ends with <CR> on the octet boundary,
 		// then we add an additional octet with <CR>. See (3GPP TS 23.038).
 		pack7 = append(pack7, 0x00)
-		oct, bit = pack(pack7, CR, oct, bit)
+		pack(pack7, CR, oct, bit)
 	}
 	return pack7
 }
@@ -204,7 +203,7 @@ func (rt *runeTable) Rune(idx int) rune {
 	return unknown
 }
 
-// Thanks, Jeroen @ Mobile Tidings
+// Thanks, Jeroen @ Mobile Tidings.
 var gsmTable = runeTable{
 	/* 0x00 */ 0x0040, /* COMMERCIAL AT */
 	/* 0x01 */ 0x00A3, /* POUND SIGN */

pdu/7bit_test.go

@@ -9,7 +9,9 @@ import (
 )
 
 func TestEncode7Bit(t *testing.T) {
-	data := []struct {
+	t.Parallel()
+
+	testcases := []struct {
 		str string
 		exp []byte
 	}{
@@ -18,13 +20,15 @@ func TestEncode7Bit(t *testing.T) {
 		{"AAAAAAAAAAAAAAB", util.MustBytes("C16030180C0683C16030180C0A1B")},
 		{"height of eifel", util.MustBytes("E872FA8CA683DE6650396D2EB31B")},
 	}
-	for _, d := range data {
-		assert.Equal(t, d.exp, Encode7Bit(d.str))
+	for _, tc := range testcases {
+		assert.Equal(t, tc.exp, Encode7Bit(tc.str))
 	}
 }
 
 func TestDecode7Bit(t *testing.T) {
-	data := []struct {
+	t.Parallel()
+
+	testcases := []struct {
 		exp   string
 		pack7 []byte
 	}{
@@ -34,21 +38,25 @@ func TestDecode7Bit(t *testing.T) {
 		{"AAAAAAAAAAAAAAB", util.MustBytes("C16030180C0683C16030180C0A1B")},
 		{"height of eifel", util.MustBytes("E872FA8CA683DE6650396D2EB31B")},
 	}
-	for _, d := range data {
-		log.Println(displayPack(d.pack7))
-		out, err := Decode7Bit(d.pack7)
+	for _, tc := range testcases {
+		log.Println(displayPack(tc.pack7))
+		out, err := Decode7Bit(tc.pack7)
 		assert.NoError(t, err)
-		assert.Equal(t, d.exp, out)
+		assert.Equal(t, tc.exp, out)
 	}
 }
 
 func TestPack7Bit(t *testing.T) {
+	t.Parallel()
+
 	raw7 := []byte{Esc, 0x3c, Esc, 0x3e}
 	exp := []byte{0x1b, 0xde, 0xc6, 0x7}
 	assert.Equal(t, exp, pack7Bit(raw7))
 }
 
 func TestUnpack7Bit(t *testing.T) {
+	t.Parallel()
+
 	pack7 := []byte{0x1b, 0xde, 0xc6, 0x7}
 	exp := []byte{Esc, 0x3c, Esc, 0x3e}
 	assert.Equal(t, exp, unpack7Bit(pack7))

pdu/doc.go

@@ -1,3 +1,7 @@
-// Package pdu implementes dataencoding schemes described in 3GPP TS 23.040. Such schemes include: GSM 7-Bit text encoding,
-// UCS2 (UTF-16) text encoding, semi-octet encoding of integers.
+// Package pdu implements data encoding schemes described in 3GPP TS 23.040.
+//
+// Such schemes include:
+//  - GSM 7-Bit text encoding,
+//  - UCS2 (UTF-16) text encoding, and
+//  - semi-octet encoding of integers.
 package pdu

pdu/semi_octet.go

@@ -2,19 +2,19 @@ package pdu
 
 import "fmt"
 
-// Swap semi-octets in octet
+// Swap semi-octets in octet.
 func Swap(octet byte) byte {
 	return (octet << 4) | (octet >> 4 & 0x0F)
 }
 
-// Encode to semi-octets
+// Encode to semi-octets.
 func Encode(value int) byte {
 	lo := byte(value % 10)
 	hi := byte((value % 100) / 10)
 	return hi<<4 | lo
 }
 
-// Decode form semi-octets
+// Decode form semi-octets.
 func Decode(octet byte) int {
 	lo := octet & 0x0F
 	hi := octet >> 4 & 0x0F

pdu/semi_octet_test.go

@@ -7,14 +7,18 @@ import (
 )
 
 func TestEncodeSemi(t *testing.T) {
-	out := EncodeSemi(14, 06, 26, 21, 36, 30, 16)
+	t.Parallel()
+
+	out := EncodeSemi(14, 6, 26, 21, 36, 30, 16)
 	exp := []byte{0x41, 0x60, 0x62, 0x12, 0x63, 0x03, 0x61}
 	assert.Equal(t, exp, out)
 }
 
 func TestDecodeSemi(t *testing.T) {
+	t.Parallel()
+
 	oct := []byte{0x41, 0x60, 0x62, 0x12, 0x63, 0x03, 0x61}
 	out := DecodeSemi(oct)
-	exp := []int{14, 06, 26, 21, 36, 30, 16}
+	exp := []int{14, 6, 26, 21, 36, 30, 16}
 	assert.Equal(t, exp, out)
 }