jimeh/rands
1
0
Fork 0
mirror of https://github.com/jimeh/rands.git synced 2026-02-19 03:16:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(deps)!: upgrade to Go 1.17 and golanci-lint 1.64 (#5)

Browse Source 
Upgrade to Go 1.17 and golangci-lint to 1.64, and fix the linting issues
that were found.

Also upgrade CI workflow actions to latest versions, and setup a test
matrix for relevant Go versions.

BREAKING CHANGE: Minimum Go version changed from 1.15 to 1.17.
This commit is contained in:
Jim Myhrberg
2025-02-28 00:42:28 +00:00
committed by GitHub
parent 8da5e1ef80
commit 16bd3ea3b9
8 changed files with 77 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
.github/workflows/ci.yml vendored
View File

@@ -7,11 +7,14 @@ jobs:
name: Lint name: Lint
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v4
- name: golangci-lint - uses: actions/setup-go@v5
uses: golangci/golangci-lint-action@v2
with: with:
version: v1.43 go-version-file: 'go.mod'
- name: golangci-lint
uses: golangci/golangci-lint-action@v6
with:
version: v1.64
env: env:
VERBOSE: "true" VERBOSE: "true"
@@ -19,34 +22,22 @@ jobs:
name: Tidy name: Tidy
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v4
- uses: actions/setup-go@v2 - uses: actions/setup-go@v5
with: with:
go-version: 1.15 go-version-file: 'go.mod'
- uses: actions/cache@v2
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
restore-keys: |
${{ runner.os }}-go-
- name: Check if mods are tidy - name: Check if mods are tidy
run: make check-tidy run: make check-tidy
benchmark: benchmark:
name: Benchmarks name: Benchmarks
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: github.ref != 'refs/heads/master' if: github.ref != 'refs/heads/main'
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v4
- uses: actions/setup-go@v2 - uses: actions/setup-go@v5
with: with:
go-version: 1.15 go-version-file: 'go.mod'
- uses: actions/cache@v2
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
restore-keys: |
${{ runner.os }}-go-
- name: Run benchmarks - name: Run benchmarks
run: make bench | tee output.raw run: make bench | tee output.raw
- name: Fix benchmark names - name: Fix benchmark names
@@ -67,18 +58,12 @@ jobs:
name: Coverage name: Coverage
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v4
- uses: actions/setup-go@v2 - uses: actions/setup-go@v5
with: with:
go-version: 1.15 go-version-file: 'go.mod'
- uses: actions/cache@v2
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
restore-keys: |
${{ runner.os }}-go-
- name: Publish coverage - name: Publish coverage
uses: paambaati/codeclimate-action@v2.7.4 uses: paambaati/codeclimate-action@v9
env: env:
VERBOSE: "true" VERBOSE: "true"
GOMAXPROCS: 4 GOMAXPROCS: 4
@@ -92,17 +77,22 @@ jobs:
test: test:
name: Test name: Test
runs-on: ubuntu-latest runs-on: ubuntu-latest
strategy:
matrix:
go-version:
- "1.17"
- "1.18"
- "1.19"
- "1.20"
- "1.21"
- "1.22"
- "1.23"
- "1.24"
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v4
- uses: actions/setup-go@v2 - uses: actions/setup-go@v5
with: with:
go-version: 1.15 go-version: ${{ matrix.go-version }}
- uses: actions/cache@v2
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
restore-keys: |
${{ runner.os }}-go-
- name: Run tests - name: Run tests
run: make test run: make test
env: env:
@@ -111,18 +101,12 @@ jobs:
benchmark-store: benchmark-store:
name: Store benchmarks name: Store benchmarks
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: github.ref == 'refs/heads/master' if: github.ref == 'refs/heads/main'
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v4
- uses: actions/setup-go@v2 - uses: actions/setup-go@v5
with: with:
go-version: 1.15 go-version-file: 'go.mod'
- uses: actions/cache@v2
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
restore-keys: |
${{ runner.os }}-go-
- name: Run benchmarks - name: Run benchmarks
run: make bench | tee output.raw run: make bench | tee output.raw
- name: Fix benchmark names - name: Fix benchmark names

11
.golangci.yml
View File

@@ -4,18 +4,13 @@ linters-settings:
statements: 150 statements: 150
gocyclo: gocyclo:
min-complexity: 20 min-complexity: 20
golint:
min-confidence: 0
govet: govet:
check-shadowing: true
enable-all: true enable-all: true
disable: disable:
- fieldalignment - fieldalignment
lll: lll:
line-length: 80 line-length: 80
tab-width: 4 tab-width: 4
maligned:
suggest-new: true
misspell: misspell:
locale: US locale: US
@@ -24,13 +19,11 @@ linters:
enable: enable:
- asciicheck - asciicheck
- bodyclose - bodyclose
- deadcode - copyloopvar
- depguard
- durationcheck - durationcheck
- errcheck - errcheck
- errorlint - errorlint
- exhaustive - exhaustive
- exportloopref
- funlen - funlen
- gochecknoinits - gochecknoinits
- goconst - goconst
@@ -58,12 +51,10 @@ linters:
- rowserrcheck - rowserrcheck
- sqlclosecheck - sqlclosecheck
- staticcheck - staticcheck
- structcheck
- typecheck - typecheck
- unconvert - unconvert
- unparam - unparam
- unused - unused
- varcheck
- wastedassign - wastedassign
- whitespace - whitespace

35
Makefile
View File

@@ -34,23 +34,19 @@ SHELL := env \
# Tools # Tools
# #
TOOLS += $(TOOLDIR)/gobin
$(TOOLDIR)/gobin:
GO111MODULE=off go get -u github.com/myitcv/gobin
# external tool # external tool
define tool # 1: binary-name, 2: go-import-path define tool # 1: binary-name, 2: go-import-path
TOOLS += $(TOOLDIR)/$(1) TOOLS += $(TOOLDIR)/$(1)
$(TOOLDIR)/$(1): $(TOOLDIR)/gobin Makefile $(TOOLDIR)/$(1): Makefile
gobin $(V) "$(2)" GOBIN="$(CURDIR)/$(TOOLDIR)" go install "$(2)"
endef endef
$(eval $(call tool,godoc,golang.org/x/tools/cmd/godoc)) $(eval $(call tool,godoc,golang.org/x/tools/cmd/godoc@latest))
$(eval $(call tool,gofumpt,mvdan.cc/gofumpt)) $(eval $(call tool,gofumpt,mvdan.cc/gofumpt@latest))
$(eval $(call tool,goimports,golang.org/x/tools/cmd/goimports)) $(eval $(call tool,goimports,golang.org/x/tools/cmd/goimports@latest))
$(eval $(call tool,golangci-lint,github.com/golangci/golangci-lint/cmd/golangci-lint@v1.43)) $(eval $(call tool,golangci-lint,github.com/golangci/golangci-lint/cmd/golangci-lint@v1.64))
$(eval $(call tool,gomod,github.com/Helcaraxan/gomod)) $(eval $(call tool,gomod,github.com/Helcaraxan/gomod@latest))
.PHONY: tools .PHONY: tools
tools: $(TOOLS) tools: $(TOOLS)
@@ -158,20 +154,3 @@ check-tidy:
docs: $(TOOLDIR)/godoc docs: $(TOOLDIR)/godoc
$(info serviing docs on http://127.0.0.1:6060/pkg/$(GOMODNAME)/) $(info serviing docs on http://127.0.0.1:6060/pkg/$(GOMODNAME)/)
@godoc -http=127.0.0.1:6060 @godoc -http=127.0.0.1:6060
#
# Release
#
.PHONY: new-version
new-version: check-npx
npx standard-version
.PHONY: next-version
next-version: check-npx
npx standard-version --dry-run
.PHONY: check-npx
check-npx:
$(if $(shell which npx),,\
$(error No npx found in PATH, please install NodeJS))

8
go.mod
View File

@@ -1,5 +1,11 @@
module github.com/jimeh/rands module github.com/jimeh/rands
go 1.15 go 1.17
require github.com/stretchr/testify v1.7.0 require github.com/stretchr/testify v1.7.0
require (
github.com/davecgh/go-spew v1.1.0 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c // indirect
)

16
ints.go
View File

@@ -8,13 +8,13 @@ import (
var ErrInvalidMaxInt = fmt.Errorf("%w: max cannot be less than 1", Err) var ErrInvalidMaxInt = fmt.Errorf("%w: max cannot be less than 1", Err)
// Int generates a random int ranging between 0 and max. // Int generates a random int ranging between 0 and nMax.
func Int(max int) (int, error) { func Int(nMax int) (int, error) {
if max < 1 { if nMax < 1 {
return 0, ErrInvalidMaxInt return 0, ErrInvalidMaxInt
} }
r, err := rand.Int(rand.Reader, big.NewInt(int64(max))) r, err := rand.Int(rand.Reader, big.NewInt(int64(nMax)))
if err != nil { if err != nil {
return 0, err return 0, err
} }
@@ -22,13 +22,13 @@ func Int(max int) (int, error) {
return int(r.Int64()), nil return int(r.Int64()), nil
} }
// Int64 generates a random int64 ranging between 0 and max. // Int64 generates a random int64 ranging between 0 and nMax.
func Int64(max int64) (int64, error) { func Int64(nMax int64) (int64, error) {
if max < 1 { if nMax < 1 {
return 0, ErrInvalidMaxInt return 0, ErrInvalidMaxInt
} }
r, err := rand.Int(rand.Reader, big.NewInt(max)) r, err := rand.Int(rand.Reader, big.NewInt(nMax))
if err != nil { if err != nil {
return 0, err return 0, err
} }

12
randsmust/ints.go
View File

@@ -2,9 +2,9 @@ package randsmust
import "github.com/jimeh/rands" import "github.com/jimeh/rands"
// Int generates a random int ranging between 0 and max. // Int generates a random int ranging between 0 and nMax.
func Int(max int) int { func Int(nMax int) int {
r, err := rands.Int(max) r, err := rands.Int(nMax)
if err != nil { if err != nil {
panic(err) panic(err)
} }
@@ -12,9 +12,9 @@ func Int(max int) int {
return r return r
} }
// Int64 generates a random int64 ranging between 0 and max. // Int64 generates a random int64 ranging between 0 and nMax.
func Int64(max int64) int64 { func Int64(nMax int64) int64 {
r, err := rands.Int64(max) r, err := rands.Int64(nMax)
if err != nil { if err != nil {
panic(err) panic(err)
} }

12
randsmust/strings.go
View File

@@ -165,12 +165,12 @@ func UnicodeString(n int, alphabet []rune) string {
// //
// In summary, the generated random string will: // In summary, the generated random string will:
// //
// - be between 1 and 63 characters in length, other n values returns a error // - be between 1 and 63 characters in length, other n values returns a error
// - first character will be one of a-z // - first character will be one of a-z
// - last character will be one of a-z or 0-9 // - last character will be one of a-z or 0-9
// - in-between first and last characters consist of a-z, 0-9, or "-" // - in-between first and last characters consist of a-z, 0-9, or "-"
// - potentially contain two or more consecutive "-", except the 3rd and 4th // - potentially contain two or more consecutive "-", except the 3rd and 4th
// characters, as that would violate RFC 5891, section 4.2.3.1. // characters, as that would violate RFC 5891, section 4.2.3.1.
func DNSLabel(n int) string { func DNSLabel(n int) string {
r, err := rands.DNSLabel(n) r, err := rands.DNSLabel(n)
if err != nil { if err != nil {

12
strings.go
View File

@@ -171,12 +171,12 @@ func UnicodeString(n int, alphabet []rune) (string, error) {
// //
// In summary, the generated random string will: // In summary, the generated random string will:
// //
// - be between 1 and 63 characters in length, other n values returns a error // - be between 1 and 63 characters in length, other n values returns a error
// - first character will be one of a-z // - first character will be one of a-z
// - last character will be one of a-z or 0-9 // - last character will be one of a-z or 0-9
// - in-between first and last characters consist of a-z, 0-9, or "-" // - in-between first and last characters consist of a-z, 0-9, or "-"
// - potentially contain two or more consecutive "-", except the 3rd and 4th // - potentially contain two or more consecutive "-", except the 3rd and 4th
// characters, as that would violate RFC 5891, section 4.2.3.1. // characters, as that would violate RFC 5891, section 4.2.3.1.
func DNSLabel(n int) (string, error) { func DNSLabel(n int) (string, error) {
switch { switch {
case n < 1 || n > 63: case n < 1 || n > 63: