Modernize for Go 1.25 (#31)

* Modernize for Go 1.25

Bump the go directive to 1.25 and drop the pinned toolchain, matching go-envconfig and go-limiter.

Reject negative numDigits/numSymbols in Generate with a new ErrNegativeInput sentinel. Previously Generate(10, -3, 0, ...) computed chars = 10 - (-3) = 13 and silently returned a 13-character password instead of erroring.

Replace the golangci-lint CI job (v1.57 config referencing removed linters like execinquery and exportloopref) with a make test target run across the macOS/Ubuntu/Windows matrix, and pin the actions with ratchet. Convert the error sentinels to fmt.Errorf for consistency.

Fix docs: log.Printf(res) -> log.Print(res) (non-constant format string), the deprecated shields.io workflow badge, and the dead godoc.org link.

Modernize tests: range-over-int loops and atomic.Int64.

* Repoint dead documentation links

The AgileBits discussion link 301-redirects to the 1Password community homepage; the original content is gone and was never archived. Repoint it to the current 1Password password generator page.

Update the stale help.github.com contributing link to its canonical docs.github.com URL.

Author: sethvargo

.github/CONTRIBUTING.md

@@ -8,5 +8,5 @@ just a few small guidelines you need to follow.
 
 All submissions, including submissions by project members, require review. We
 use GitHub pull requests for this purpose. Consult
-[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
+[GitHub Help](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) for more
 information on using pull requests.

.github/workflows/test.yml

@@ -1,59 +1,39 @@
-name: Test
+name: 'Test'
 
 on:
   push:
     branches:
-      - main
+      - 'main'
+    tags:
+      - '*'
   pull_request:
     branches:
-      - main
+      - 'main'
 
 concurrency:
   group: '${{ github.workflow }}-${{ github.head_ref || github.ref }}'
   cancel-in-progress: true
 
 jobs:
-  lint:
-    runs-on: 'ubuntu-latest'
-
-    steps:
-      - uses: 'actions/checkout@v4'
-
-      - uses: 'actions/setup-go@v5'
-        with:
-          cache: false
-          go-version-file: 'go.mod'
-
-      - uses: 'golangci/golangci-lint-action@v4'
-        with:
-          version: 'v1.57.2'
-          skip-cache: true
-
   test:
     strategy:
+      fail-fast: false
       matrix:
         platform:
           - 'macos-latest'
           - 'ubuntu-latest'
           - 'windows-latest'
-      fail-fast: false
 
     runs-on: '${{ matrix.platform }}'
 
     steps:
-      - uses: 'actions/checkout@v4'
+      - uses: 'actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0' # ratchet:actions/checkout@v7
 
-      - uses: 'actions/setup-go@v5'
+      - uses: 'actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e' # ratchet:actions/setup-go@v7
         with:
-          cache: false
           go-version-file: 'go.mod'
 
-      - shell: 'bash'
+      - name: 'Test'
+        shell: 'bash'
         run: |-
-          go test \
-            -count=1 \
-            -race \
-            -shuffle=on \
-            -timeout=5m \
-            -vet=all \
-            ./...
+          make test

.golangci.yml

@@ -0,0 +1,9 @@
+test:
+	@go test \
+		-count=1 \
+		-race \
+		-shuffle=on \
+		-timeout=5m \
+		-vet=all \
+		./...
+.PHONY: test

Makefile

@@ -1,11 +1,11 @@
 ## Golang Password Generator
 
 [![GoDoc](https://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](https://pkg.go.dev/github.com/sethvargo/go-password/password)
-[![GitHub Actions](https://img.shields.io/github/workflow/status/sethvargo/go-password/Test?style=flat-square)](https://github.com/sethvargo/go-password/actions?query=workflow%3ATest)
+[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/sethvargo/go-password/test.yml?style=flat-square)](https://github.com/sethvargo/go-password/actions/workflows/test.yml)
 
 This library implements generation of random passwords with provided
 requirements as described by  [AgileBits
-1Password](https://discussions.agilebits.com/discussion/23842/how-random-are-the-generated-passwords)
+1Password](https://1password.com/password-generator)
 in pure Golang. The algorithm is commonly used when generating website
 passwords.
 
@@ -26,7 +26,7 @@ wpvbxlsc
 ## Installation
 
 ```sh
-$ go get -u github.com/sethvargo/go-password/password
+$ go get github.com/sethvargo/go-password/password
 ```
 
 ## Usage
@@ -47,11 +47,11 @@ func main() {
   if err != nil {
     log.Fatal(err)
   }
-  log.Printf(res)
+  log.Print(res)
 }
 ```
 
-See the [GoDoc](https://godoc.org/github.com/sethvargo/go-password) for more
+See the [GoDoc](https://pkg.go.dev/github.com/sethvargo/go-password/password) for more
 information.
 
 ## Testing

README.md

@@ -1,5 +1,3 @@
 module github.com/sethvargo/go-password
 
-toolchain go1.21.11
-
-go 1.21
+go 1.25

go.mod

@@ -5,14 +5,13 @@
 //	if err != nil  {
 //	  log.Fatal(err)
 //	}
-//	log.Printf(res)
+//	log.Print(res)
 //
 // Most functions are safe for concurrent use.
 package password
 
 import (
 	"crypto/rand"
-	"errors"
 	"fmt"
 	"io"
 	"math/big"
@@ -47,19 +46,23 @@ const (
 var (
 	// ErrExceedsTotalLength is the error returned with the number of digits and
 	// symbols is greater than the total length.
-	ErrExceedsTotalLength = errors.New("number of digits and symbols must be less than total length")
+	ErrExceedsTotalLength = fmt.Errorf("number of digits and symbols must be less than total length")
 
 	// ErrLettersExceedsAvailable is the error returned with the number of letters
 	// exceeds the number of available letters and repeats are not allowed.
-	ErrLettersExceedsAvailable = errors.New("number of letters exceeds available letters and repeats are not allowed")
+	ErrLettersExceedsAvailable = fmt.Errorf("number of letters exceeds available letters and repeats are not allowed")
 
 	// ErrDigitsExceedsAvailable is the error returned with the number of digits
 	// exceeds the number of available digits and repeats are not allowed.
-	ErrDigitsExceedsAvailable = errors.New("number of digits exceeds available digits and repeats are not allowed")
+	ErrDigitsExceedsAvailable = fmt.Errorf("number of digits exceeds available digits and repeats are not allowed")
 
 	// ErrSymbolsExceedsAvailable is the error returned with the number of symbols
 	// exceeds the number of available symbols and repeats are not allowed.
-	ErrSymbolsExceedsAvailable = errors.New("number of symbols exceeds available symbols and repeats are not allowed")
+	ErrSymbolsExceedsAvailable = fmt.Errorf("number of symbols exceeds available symbols and repeats are not allowed")
+
+	// ErrNegativeInput is the error returned when the number of digits or symbols
+	// is negative.
+	ErrNegativeInput = fmt.Errorf("number of digits and symbols must not be negative")
 )
 
 // Generator is the stateful generator which can be used to customize the list
@@ -129,6 +132,10 @@ func NewGenerator(i *GeneratorInput) (*Generator, error) {
 // The algorithm is fast, but it's not designed to be performant; it favors
 // entropy over speed. This function is safe for concurrent use.
 func (g *Generator) Generate(length, numDigits, numSymbols int, noUpper, allowRepeat bool) (string, error) {
+	if numDigits < 0 || numSymbols < 0 {
+		return "", ErrNegativeInput
+	}
+
 	letters := g.lowerLetters
 	if !noUpper {
 		letters += g.upperLetters

password/generate.go

@@ -10,7 +10,7 @@ import (
 
 type (
 	MockReader struct {
-		Counter int64
+		Counter atomic.Int64
 	}
 )
 
@@ -19,8 +19,8 @@ const (
 )
 
 func (mr *MockReader) Read(data []byte) (int, error) {
-	for i := 0; i < len(data); i++ {
-		data[i] = byte(atomic.AddInt64(&mr.Counter, 1))
+	for i := range data {
+		data[i] = byte(mr.Counter.Add(1))
 	}
 	return len(data), nil
 }
@@ -85,6 +85,18 @@ func testGeneratorGenerate(t *testing.T, reader io.Reader) {
 		}
 	})
 
+	t.Run("negative_input", func(t *testing.T) {
+		t.Parallel()
+
+		if _, err := gen.Generate(10, -1, 0, false, false); !errors.Is(err, ErrNegativeInput) {
+			t.Errorf("expected %q to be %q", err, ErrNegativeInput)
+		}
+
+		if _, err := gen.Generate(10, 0, -1, false, false); !errors.Is(err, ErrNegativeInput) {
+			t.Errorf("expected %q to be %q", err, ErrNegativeInput)
+		}
+	})
+
 	t.Run("gen_lowercase", func(t *testing.T) {
 		t.Parallel()
 
@@ -116,7 +128,7 @@ func testGeneratorGenerate(t *testing.T, reader io.Reader) {
 	t.Run("gen_no_repeats", func(t *testing.T) {
 		t.Parallel()
 
-		for i := 0; i < N; i++ {
+		for range N {
 			res, err := gen.Generate(52, 10, 30, false, false)
 			if err != nil {
 				t.Error(err)
@@ -153,7 +165,7 @@ func testGeneratorGenerateCustom(t *testing.T, reader io.Reader) {
 		t.Fatal(err)
 	}
 
-	for i := 0; i < N; i++ {
+	for range N {
 		res, err := gen.Generate(52, 10, 10, false, true)
 		if err != nil {
 			t.Error(err)