Add codespell workflow (#421)

raklaptudirm · cclauss · web-flow · commit 2485670be23f · 2021-10-28T15:46:33.000+02:00
* feat: add codespell workflow

* chore: fix spelling

* chore: fix spelling

* chore: fix spelling

* chore: fix spelling

* chore: fix spelling

* chore: fix spelling

* chore: fix spelling

* chore: fix spelling

* chore: fix spelling

* chore: fix spelling

* chore: fix spelling

* chore: rename variables

* chore: fix spellings

* chore: fix spelling

* chore: fix spellings

* chore: fix spellings

* chore: fix spelling

* chore: fix spelling

* chore: fix spelling

* chore: fix spelling

* chore: fix spelling

* chore: fix spelling

* chore: undo variable renaming

* chore: join `fmt.Print`s together

* chore: add ignore list for words

* fix: use correct property name

* fix: change words to lowercase

* fix: change `Print` to `Printf`

Co-authored-by: Christian Clauss &lt;cclauss@me.com&gt;

* chore: move workflow

* chore: add codespell workflow here

* Update .github/workflows/golang_lint_and_test.yml

Co-authored-by: Christian Clauss &lt;cclauss@me.com&gt;
diff --git a/.github/workflows/golang_lint_and_test.yml b/.github/workflows/golang_lint_and_test.yml
@@ -8,6 +8,10 @@ jobs:
       fail-fast: false
     steps:
       - uses: actions/checkout@v2
+      - uses: codespell-project/actions-codespell@master
+        with:
+          ignore_words_list: "actualy,nwe"
+          skip: "go.mod,go.sum"
       - uses: actions/setup-go@v2
       - run: go version
       - uses: golangci/golangci-lint-action@v2
diff --git a/cipher/polybius/polybius_test.go b/cipher/polybius/polybius_test.go
@@ -51,7 +51,7 @@ func TestNewPolybius(t *testing.T) {
 			name: "truncate characters", size: 5, characters: "HogeFuga", key: "abcdefghijklmnopqrstuvwxy", wantErr: "",
 		},
 		{
-			name: "invaid key", size: 5, characters: "HogeFuga", key: "abcdefghi", wantErr: "len(key): 9 must be as long as size squared: 25",
+			name: "invalid key", size: 5, characters: "HogeFuga", key: "abcdefghi", wantErr: "len(key): 9 must be as long as size squared: 25",
 		},
 		{
 			name: "invalid characters", size: 5, characters: "HogeH", key: "abcdefghijklmnopqrstuvwxy", wantErr: "\"chars\" contains same character: H",
diff --git a/cipher/rsa/rsa_test.go b/cipher/rsa/rsa_test.go
@@ -47,7 +47,7 @@ func TestEncryptDecrypt(t *testing.T) {
 	e := int64(17) // Coprime with delta
 
 	if gcd.Recursive(e, delta) != 1 {
-		t.Fatal("Algorithm failed in preamble stage:\n\tPrime numbers are chosed statically and it shouldn't fail at this stage")
+		t.Fatal("Algorithm failed in preamble stage:\n\tPrime numbers are chosen statically and it shouldn't fail at this stage")
 	}
 
 	d, err := modular.Inverse(e, delta)
diff --git a/conversion/binarytodecimal.go b/conversion/binarytodecimal.go
@@ -8,7 +8,7 @@ Date: 19-Oct-2021
 // https://en.wikipedia.org/wiki/Binary_number
 // https://en.wikipedia.org/wiki/Decimal
 // Function receives a Binary Number as string and returns the Decimal number as integer.
-// Suppoted Binary number range is 0 to 2^(31-1).
+// Supported Binary number range is 0 to 2^(31-1).
 
 // Package name.
 package conversion
diff --git a/conversion/decimaltobinary.go b/conversion/decimaltobinary.go
@@ -7,7 +7,7 @@ Date: 14-Oct-2021
 // This algorithm will convert any Decimal (+ve integer) number to Binary number.
 // https://en.wikipedia.org/wiki/Binary_number
 // Function receives a integer as a Decimal number and returns the Binary number.
-// Suppoted integer value range is 0 to 2^(31 -1).
+// Supported integer value range is 0 to 2^(31 -1).
 
 // Package name.
 package conversion
diff --git a/graph/topological.go b/graph/topological.go
@@ -22,14 +22,14 @@ func Topological(N int, constraints [][]int) []int {
 		edges[a][b] = true
 	}
 
-	ans := []int{}
+	answer := []int{}
 	for s := 0; s < N; s++ {
 		// Only start walking from top level nodes
 		if dependencies[s] == 0 {
 			route, _ := DepthFirstSearchHelper(s, N, nodes, edges, true)
-			ans = append(ans, route...)
+			answer = append(answer, route...)
 		}
 	}
 
-	return ans
+	return answer
 }
diff --git a/math/geometry/straightlines.go b/math/geometry/straightlines.go
@@ -18,7 +18,7 @@ func Distance(a, b *Point) float64 {
 	return math.Sqrt(math.Pow(a.X-b.X, 2) + math.Pow(a.Y-b.Y, 2))
 }
 
-// Calcualtes the Point that divides a line in specific ratio.
+// Calculates the Point that divides a line in specific ratio.
 // DO NOT specify the ratio in the form m:n, specify it as r, where r = m / n.
 func Section(p1, p2 *Point, r float64) Point {
 	var point Point
diff --git a/other/maxsubarraysum/maxsubarraysum.go b/other/maxsubarraysum/maxsubarraysum.go
@@ -2,7 +2,7 @@
 maximum contiguous sum in the given array. */
 
 // Package maxsubarraysum is a package containing a solution to a common
-// problem of finding max contigious sum within a array of ints.
+// problem of finding max contiguous sum within a array of ints.
 package maxsubarraysum
 
 import (
diff --git a/other/nested/nestedbrackets.go b/other/nested/nestedbrackets.go
@@ -1,5 +1,5 @@
 // Package nested provides functions for testing
-// strings propper brackets nesting.
+// strings proper brackets nesting.
 package nested
 
 // IsBalanced returns true if provided input string is properly nested.
@@ -16,7 +16,7 @@ package nested
 //
 // **Note** Providing characters other then brackets would return false,
 // despite brackets sequence in the string. Make sure to filter
-// input before useage.
+// input before usage.
 func IsBalanced(input string) bool {
 	if len(input) == 0 {
 		return true
diff --git a/search/ternary.go b/search/ternary.go
@@ -9,7 +9,7 @@ import (
 // in the interval [a, b]. a and b should be finit numbers
 func TernaryMax(a, b, epsilon float64, f func(x float64) float64) (float64, error) {
 	if a == math.Inf(-1) || b == math.Inf(1) {
-		return -1, fmt.Errorf("interval boundries should be finite numbers")
+		return -1, fmt.Errorf("interval boundaries should be finite numbers")
 	}
 	if math.Abs(a-b) <= epsilon {
 		return f((a + b) / 2), nil
@@ -26,7 +26,7 @@ func TernaryMax(a, b, epsilon float64, f func(x float64) float64) (float64, erro
 // in the interval [a, b]. a and b should be finit numbers.
 func TernaryMin(a, b, epsilon float64, f func(x float64) float64) (float64, error) {
 	if a == math.Inf(-1) || b == math.Inf(1) {
-		return -1, fmt.Errorf("interval boundries should be finite numbers")
+		return -1, fmt.Errorf("interval boundaries should be finite numbers")
 	}
 	if math.Abs(a-b) <= epsilon {
 		return f((a + b) / 2), nil
diff --git a/search/ternary_test.go b/search/ternary_test.go
@@ -25,7 +25,7 @@ func TestTernaryMax(t *testing.T) {
 	for _, test := range tests {
 		result, err := TernaryMax(test.a, test.b, EPS, test.f)
 		if err != nil {
-			t.Errorf("error occured: %v", err)
+			t.Errorf("error occurred: %v", err)
 		}
 		if !equal(result, test.expected) {
 			t.Errorf("Wrong result! Expected:%v, returned:%v ", test.expected, result)
@@ -47,7 +47,7 @@ func TestTernaryMin(t *testing.T) {
 	for _, test := range tests {
 		result, err := TernaryMin(test.a, test.b, EPS, test.f)
 		if err != nil {
-			t.Errorf("error occured: %v", err)
+			t.Errorf("error occurred: %v", err)
 		}
 		if !equal(result, test.expected) {
 			t.Errorf("Wrong result! Expected:%v, returned:%v ", test.expected, result)
diff --git a/strings/ahocorasick/advancedahocorasick.go b/strings/ahocorasick/advancedahocorasick.go
@@ -5,7 +5,7 @@ import (
 	"time"
 )
 
-// Advanced Function performing the Advanced Aho-Corasick alghoritm.
+// Advanced Function performing the Advanced Aho-Corasick algorithm.
 // Finds and prints occurrences of each pattern.
 func Advanced(t string, p []string) Result {
 	startTime := time.Now()
diff --git a/strings/ahocorasick/shared.go b/strings/ahocorasick/shared.go
@@ -35,7 +35,7 @@ func ConstructTrie(p []string) (trie map[int]map[uint8]int, stateIsTerminal []bo
 	return trie, stateIsTerminal, f
 }
 
-// Contains Returns 'true' if arry of int's 's' contains int 'e', 'false' otherwise.
+// Contains Returns 'true' if array of int's 's' contains int 'e', 'false' otherwise.
 func Contains(s []int, e int) bool {
 	for _, a := range s {
 		if a == e {
diff --git a/strings/bom/bom.go b/strings/bom/bom.go
@@ -49,11 +49,11 @@ package bom
 // 			log.Fatal("Pattern  is longer than text!")
 // 		}
 // 		if debugMode == true {
-// 			fmt.Printf("\nRunning: Backward Oracle Matching alghoritm.\n\n")
+// 			fmt.Printf("\nRunning: Backward Oracle Matching algorithm.\n\n")
 // 			fmt.Printf("Search word (%d chars long): %q.\n", len(patFile), patFile)
 // 			fmt.Printf("Text        (%d chars long): %q.\n\n", len(textFile), textFile)
 // 		} else {
-// 			fmt.Printf("\nRunning: Backward Oracle Matching alghoritm.\n\n")
+// 			fmt.Printf("\nRunning: Backward Oracle Matching algorithm.\n\n")
 // 		}
 // 		bom(string(textFile), string(patFile))
 // 	}
diff --git a/strings/genetic/genetic.go b/strings/genetic/genetic.go
@@ -103,7 +103,7 @@ func GeneticString(target string, charmap []rune, conf *Conf) (*Result, error) {
 			}
 		}
 		if invalid {
-			message := fmt.Sprintf("character not aviable in charmap at position: %v", position)
+			message := fmt.Sprintf("character not available in charmap at position: %v", position)
 			return nil, errors.New(message)
 		}
 	}
diff --git a/strings/kmp/kmp.go b/strings/kmp/kmp.go
@@ -95,7 +95,7 @@ func Kmp(text string, word string) Result {
 	}
 }
 
-// Table building alghoritm.
+// Table building algorithm.
 // Takes word to be analyzed and table to be filled.
 func kmpTable(word string) (t []int) {
 	t = make([]int, len(word))
diff --git a/structure/hashmap/hashmap_test.go b/structure/hashmap/hashmap_test.go
@@ -48,7 +48,7 @@ func TestHashMap(t *testing.T) {
 		}
 	})
 
-	t.Run("Test 6: Checking if the key that doesnt exists returns false", func(t *testing.T) {
+	t.Run("Test 6: Checking if the key that doesn't exists returns false", func(t *testing.T) {
 		want := false
 		got := mp.Contains(2)
 		if got != want {
diff --git a/structure/linkedlist/doubly.go b/structure/linkedlist/doubly.go
@@ -116,7 +116,7 @@ func (ll *Doubly) Reverse() {
 	ll.Head = Prev
 }
 
-// Display diplay the linked list
+// Display display the linked list
 func (ll *Doubly) Display() {
 	for cur := ll.Head; cur != nil; cur = cur.Next {
 		fmt.Print(cur.Val, " ")
diff --git a/structure/linkedlist/shared.go b/structure/linkedlist/shared.go
@@ -1,7 +1,7 @@
 package linkedlist
 
 // Node Structure representing the linkedlist node.
-// This node is shared accross different implementations.
+// This node is shared across different implementations.
 type Node struct {
 	Val  interface{}
 	Prev *Node
diff --git a/structure/set/set.go b/structure/set/set.go
@@ -15,17 +15,17 @@ func New(items ...interface{}) Set {
 type Set interface {
 	// Add: adds new element to the set
 	Add(item interface{})
-	// Delete: delets the passed element from the set if present
+	// Delete: deletes the passed element from the set if present
 	Delete(item interface{})
 	// Len: gives the length of the set (total no. of elements in set)
 	Len() int
 	// GetItems: gives the array( []interface{} ) of elements of the set.
 	GetItems() []interface{}
 	// In: checks whether item is present in set or not.
 	In(item interface{}) bool
-	// IsSubsetOf: checks wether set is subset of set2 or not.
+	// IsSubsetOf: checks whether set is subset of set2 or not.
 	IsSubsetOf(set2 Set) bool
-	// IsSupersetOf: checks wether set is superset of set2 or not.
+	// IsSupersetOf: checks whether set is superset of set2 or not.
 	IsSupersetOf(set2 Set) bool
 	// Union: gives new union set of both sets.
 	// ex: [1,2,3] union [3,4,5] -> [1,2,3,4,5]
diff --git a/structure/stack/stack_test.go b/structure/stack/stack_test.go
@@ -105,15 +105,15 @@ func TestStackArray(t *testing.T) {
 
 		t.Run("Stack Empty", func(t *testing.T) {
 			if stackEmpty() == true {
-				t.Errorf("Stack Emtpy is not work we expected %v but got %v", false, stackEmpty())
+				t.Errorf("Stack Empty is not work we expected %v but got %v", false, stackEmpty())
 			}
 
 			stackPop()
 			stackPop()
 			stackPop()
 
 			if stackEmpty() == false {
-				t.Errorf("Stack Emtpy is not work we expected %v but got %v", true, stackEmpty())
+				t.Errorf("Stack Empty is not work we expected %v but got %v", true, stackEmpty())
 			}
 		})
 	})
@@ -161,7 +161,7 @@ func TestStackLinkedListWithList(t *testing.T) {
 
 	t.Run("Stack Empty", func(t *testing.T) {
 		if stackList.Empty() == true {
-			t.Errorf("Stack Emtpy is not work we expected %v but got %v", false, stackList.Empty())
+			t.Errorf("Stack Empty is not work we expected %v but got %v", false, stackList.Empty())
 		}
 
 		d1, err := stackList.Pop()
@@ -173,7 +173,7 @@ func TestStackLinkedListWithList(t *testing.T) {
 		}
 
 		if stackList.Empty() == false {
-			t.Errorf("Stack Emtpy is not work we expected %v but got %v", true, stackList.Empty())
+			t.Errorf("Stack Empty is not work we expected %v but got %v", true, stackList.Empty())
 		}
 	})
 }
diff --git a/structure/trie/trie_test.go b/structure/trie/trie_test.go
@@ -91,7 +91,7 @@ func TestTrieRemove(t *testing.T) {
 	n.verify(t, checkWords)
 	n.verifySizeCapa(t, size, capa)
 
-	n.Remove("marcel") // no effect since ,o, existant
+	n.Remove("marcel") // no effect since ,o, existent
 	n.verify(t, checkWords)
 	n.verifySizeCapa(t, size, capa)
 

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ func TestNewPolybius(t *testing.T) {`
`51`	`51`	`name: "truncate characters", size: 5, characters: "HogeFuga", key: "abcdefghijklmnopqrstuvwxy", wantErr: "",`
`52`	`52`	`},`
`53`	`53`	`{`
`54`		`- name: "invaid key", size: 5, characters: "HogeFuga", key: "abcdefghi", wantErr: "len(key): 9 must be as long as size squared: 25",`
	`54`	`+ name: "invalid key", size: 5, characters: "HogeFuga", key: "abcdefghi", wantErr: "len(key): 9 must be as long as size squared: 25",`
`55`	`55`	`},`
`56`	`56`	`{`
`57`	`57`	`name: "invalid characters", size: 5, characters: "HogeH", key: "abcdefghijklmnopqrstuvwxy", wantErr: "\"chars\" contains same character: H",`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ func TestEncryptDecrypt(t *testing.T) {`
`47`	`47`	`e := int64(17) // Coprime with delta`
`48`	`48`
`49`	`49`	`if gcd.Recursive(e, delta) != 1 {`
`50`		`- t.Fatal("Algorithm failed in preamble stage:\n\tPrime numbers are chosed statically and it shouldn't fail at this stage")`
	`50`	`+ t.Fatal("Algorithm failed in preamble stage:\n\tPrime numbers are chosen statically and it shouldn't fail at this stage")`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`d, err := modular.Inverse(e, delta)`
Original file line number	Diff line number	Diff line change
`@@ -22,14 +22,14 @@ func Topological(N int, constraints [][]int) []int {`
`22`	`22`	`edges[a][b] = true`
`23`	`23`	`}`
`24`	`24`
`25`		`- ans := []int{}`
	`25`	`+ answer := []int{}`
`26`	`26`	`for s := 0; s < N; s++ {`
`27`	`27`	`// Only start walking from top level nodes`
`28`	`28`	`if dependencies[s] == 0 {`
`29`	`29`	`route, _ := DepthFirstSearchHelper(s, N, nodes, edges, true)`
`30`		`- ans = append(ans, route...)`
	`30`	`+ answer = append(answer, route...)`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`
`34`		`- return ans`
	`34`	`+ return answer`
`35`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ func Distance(a, b *Point) float64 {`
`18`	`18`	`return math.Sqrt(math.Pow(a.X-b.X, 2) + math.Pow(a.Y-b.Y, 2))`
`19`	`19`	`}`
`20`	`20`
`21`		`-// Calcualtes the Point that divides a line in specific ratio.`
	`21`	`+// Calculates the Point that divides a line in specific ratio.`
`22`	`22`	`// DO NOT specify the ratio in the form m:n, specify it as r, where r = m / n.`
`23`	`23`	`func Section(p1, p2 *Point, r float64) Point {`
`24`	`24`	`var point Point`