lint

Signed-off-by: Harry Randazzo <[email protected]>
Noxsios · Dec 23, 2024 · af8920c · af8920c
1 parent 354a0da
commit af8920c
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 4 deletions.
diff --git a/Makefile b/Makefile
@@ -12,4 +12,7 @@ words:
 test:
 	go test ./...
 
-.PHONY: build clean words test
+lint:
+	golangci-lint run ./...
+
+.PHONY: build clean words test lint
diff --git a/count/main.go b/count/main.go
@@ -1,3 +1,7 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2024-Present Harry Randazzo
+
+// Package main is the entrypoint for some misc CLIs
 package main
 
 import (

diff --git a/gen/main.go b/gen/main.go
@@ -1,3 +1,7 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2024-Present Harry Randazzo
+
+// Package main is the entrypoint for generating words/gen.go from /usr/share/dict/words
 package main
 
 import (
@@ -27,7 +31,10 @@ func main() {
 	}
 
 	tmpl := template.New("words")
-	tmpl, err = tmpl.Parse(`package words
+	tmpl, err = tmpl.Parse(`// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2024-Present Harry Randazzo
+
+package words
 
 // generated by go run gen/main.go > words/gen.go DO NOT EDIT
 

diff --git a/main.go b/main.go
@@ -1,3 +1,7 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2024-Present Harry Randazzo
+
+// Package main is the entrypoint for the ezpass CLI
 package main
 
 import (

diff --git a/words/ezpass.go b/words/ezpass.go
@@ -1,3 +1,7 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2024-Present Harry Randazzo
+
+// Package words contains the generated wordlist and passphrase printer
 package words
 
 import (
@@ -7,11 +11,12 @@ import (
 	"math/big"
 )
 
+// PrintEzpass prints to wr a random passphrase of n words separated by a given delimiter
 func PrintEzpass(wr io.Writer, n int, delimiter string) error {
-	max := big.NewInt(int64(len(ALL)))
+	upper := big.NewInt(int64(len(ALL)))
 
 	for i := range n {
-		randBigInt, err := rand.Int(rand.Reader, max)
+		randBigInt, err := rand.Int(rand.Reader, upper)
 		if err != nil {
 			return err
 		}

diff --git a/words/ezpass_test.go b/words/ezpass_test.go
@@ -1,3 +1,6 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2024-Present Harry Randazzo
+
 package words_test
 
 import (

diff --git a/words/gen.go b/words/gen.go
@@ -1,3 +1,6 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2024-Present Harry Randazzo
+
 package words
 
 // generated by go run gen/main.go > words/gen.go DO NOT EDIT