Add actions workflow and fix some minor issues

zyedidia · Mar 19, 2023 · 0e4b88a · 0e4b88a
1 parent a371993
commit 0e4b88a
Show file tree

Hide file tree

Showing 9 changed files with 55 additions and 23 deletions.
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -0,0 +1,32 @@
+on: [push, pull_request]
+name: Test
+jobs:
+  test:
+    strategy:
+      matrix:
+        go-version: [1.19.x]
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/setup-go@v3
+      with:
+        go-version: ${{ matrix.go-version }}
+    - uses: actions/checkout@v3
+
+    - name: Format
+      run: if [ "$(gofmt -s -l . | wc -l)" -gt 0 ]; then exit 1; fi
+
+    - name: Vet
+      run: "go vet ./..."
+
+    - name: Install Staticcheck
+      uses: dominikh/staticcheck-action@v1.2.0
+      with:
+        version: "2022.1.1"
+        install-go: false
+        cache-key: ${{ matrix.go-version }}
+    - name: Staticcheck
+      run: "staticcheck ./..."
+
+    - name: Test
+      run: "go test ./..."
diff --git a/README.md b/README.md
@@ -1,5 +1,6 @@
 # Generic Data Structures
 
+![Test Workflow](https://github.com/zyedidia/generic/actions/workflows/test.yaml/badge.svg)
 [![Go Reference](https://pkg.go.dev/badge/github.com/zyedidia/generic.svg)](https://pkg.go.dev/github.com/zyedidia/generic)
 [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/zyedidia/generic/blob/master/LICENSE)
 

diff --git a/interval/itree.go b/interval/itree.go
@@ -5,15 +5,15 @@
 // following operations, where 'n' is the number of
 // intervals in the tree:
 //
-// * Put: add an interval to the tree. Complexity: O(lg n).
+//   - Put: add an interval to the tree. Complexity: O(lg n).
 //
-// * Get: find an interval with a given starting position. Complexity O(lg n).
+//   - Get: find an interval with a given starting position. Complexity O(lg n).
 //
-// * Overlaps: find all intervals that overlap with a given interval. Complexity:
-//   O(lg n + m), where 'm' is the size of the result (number of overlapping
-//   intervals found).
+//   - Overlaps: find all intervals that overlap with a given interval. Complexity:
+//     O(lg n + m), where 'm' is the size of the result (number of overlapping
+//     intervals found).
 //
-// * Remove: remove the interval at a given position. Complexity: O(lg n).
+//   - Remove: remove the interval at a given position. Complexity: O(lg n).
 package interval
 
 import (

diff --git a/mapset/set.go b/mapset/set.go
@@ -52,7 +52,7 @@ func (s Set[K]) Size() int {
 
 // Each calls 'fn' on every item in the set in no particular order.
 func (s Set[K]) Each(fn func(key K)) {
-	for k, _ := range s.m {
+	for k := range s.m {
 		fn(k)
 	}
 }
diff --git a/multimap/avl.go b/multimap/avl.go
@@ -89,9 +89,9 @@ func (m *avlMultiMap[K, V, C]) EachAssociation(fn func(key K, values []V)) {
 }
 
 // NewAvlSlice creates a MultiMap using AVL tree and builtin slice.
-//  - Value type must be comparable.
-//  - Duplicate entries are permitted.
-//  - Keys are sorted, but values are unsorted.
+//   - Value type must be comparable.
+//   - Duplicate entries are permitted.
+//   - Keys are sorted, but values are unsorted.
 func NewAvlSlice[K any, V comparable](keyLess g.LessFn[K]) MultiMap[K, V] {
 	m := &avlMultiMap[K, V, *valuesSlice[V]]{
 		keyLess: keyLess,
@@ -104,8 +104,8 @@ func NewAvlSlice[K any, V comparable](keyLess g.LessFn[K]) MultiMap[K, V] {
 }
 
 // NewAvlSet creates a MultiMap using AVL tree and AVL set.
-//  - Duplicate entries are not permitted.
-//  - Both keys and values are sorted.
+//   - Duplicate entries are not permitted.
+//   - Both keys and values are sorted.
 func NewAvlSet[K, V any](keyLess g.LessFn[K], valueLess g.LessFn[V]) MultiMap[K, V] {
 	m := &avlMultiMap[K, V, valuesSet[V]]{
 		keyLess: keyLess,

diff --git a/multimap/map.go b/multimap/map.go
@@ -88,9 +88,9 @@ func (m *mapMultiMap[K, V, C]) EachAssociation(fn func(key K, values []V)) {
 }
 
 // NewMapSlice creates a MultiMap using builtin map and builtin slice.
-//  - Both key type and value type must be comparable.
-//  - Duplicate entries are permitted.
-//  - Both keys and values are unsorted.
+//   - Both key type and value type must be comparable.
+//   - Duplicate entries are permitted.
+//   - Both keys and values are unsorted.
 func NewMapSlice[K, V comparable]() MultiMap[K, V] {
 	m := &mapMultiMap[K, V, *valuesSlice[V]]{
 		makeValues: func() *valuesSlice[V] {
@@ -102,9 +102,9 @@ func NewMapSlice[K, V comparable]() MultiMap[K, V] {
 }
 
 // NewMapSet creates a MultiMap using builtin map and AVL set.
-//  - Key type must be comparable.
-//  - Duplicate entries are not permitted.
-//  - Values are sorted, but keys are unsorted.
+//   - Key type must be comparable.
+//   - Duplicate entries are not permitted.
+//   - Values are sorted, but keys are unsorted.
 func NewMapSet[K comparable, V any](valueLess g.LessFn[V]) MultiMap[K, V] {
 	m := &mapMultiMap[K, V, valuesSet[V]]{
 		makeValues: func() valuesSet[V] {

diff --git a/multimap/multimap.go b/multimap/multimap.go
@@ -2,9 +2,9 @@
 //
 // There are four implementations of the MultiMap data structure, identified by separate New* functions.
 // They differ in the following ways:
-//  - whether key type and value type must be comparable.
-//  - whether duplicate entries (same key and same value) are permitted.
-//  - whether keys and values are sorted or unsorted in Get, Each, and EachAssociation methods.
+//   - whether key type and value type must be comparable.
+//   - whether duplicate entries (same key and same value) are permitted.
+//   - whether keys and values are sorted or unsorted in Get, Each, and EachAssociation methods.
 package multimap
 
 // MultiMap is an associative container that contains a list of key-value pairs, while permitting multiple entries with the same key.

diff --git a/prope/prope_test.go b/prope/prope_test.go
@@ -19,7 +19,6 @@ func check(p *prope.Node[byte], r *rope.Node[byte], t *testing.T) {
 	if r.Len() != p.Len() {
 		t.Errorf("incorrect length: %d %d", r.Len(), p.Len())
 	}
-	return
 }
 
 const datasz = 5000

diff --git a/queue/queue_test.go b/queue/queue_test.go
@@ -72,7 +72,7 @@ func TestQueueTryPeek(t *testing.T) {
 		wantValue := 1
 		wantOk := true
 
-		if gotOk != gotOk {
+		if wantOk != gotOk {
 			t.Errorf("got ok %v, want ok %v", gotOk, wantOk)
 		}
 		if gotValue != wantValue {
-Original file line number
+Diff line change
@@ Expand Up @@
     	if r.Len() != p.Len() {
     		t.Errorf("incorrect length: %d %d", r.Len(), p.Len())
     	}
-    	return
     }
     const datasz = 5000
@@ Expand Down @@