Skip to content

Commit 818fa8b

Browse files
Antonboomldez
andauthored
docs: improve testifylint description of require-f-funcs flag (#5131)
Co-authored-by: Fernandez Ludovic <[email protected]>
1 parent 5d5f373 commit 818fa8b

4 files changed

+14
-4
lines changed

.golangci.next.reference.yml

+6-1
Original file line numberDiff line numberDiff line change
@@ -3383,7 +3383,12 @@ linters-settings:
33833383
# To enable go vet's printf checks.
33843384
# Default: true
33853385
check-format-string: false
3386-
# To require f-assertions if format string is used.
3386+
# To require f-assertions (e.g. `assert.Equalf`) if format string is used, even if there are no variable-length
3387+
# variables, i.e. it requires `require.NoErrorf` for both these cases:
3388+
# - require.NoErrorf(t, err, "unexpected error")
3389+
# - require.NoErrorf(t, err, "unexpected error for sid: %v", sid)
3390+
# To understand this behavior, please read the
3391+
# https://github.com/Antonboom/testifylint?tab=readme-ov-file#historical-reference-of-formatter.
33873392
# Default: false
33883393
require-f-funcs: true
33893394
go-require:

.golangci.reference.yml

+6-1
Original file line numberDiff line numberDiff line change
@@ -3383,7 +3383,12 @@ linters-settings:
33833383
# To enable go vet's printf checks.
33843384
# Default: true
33853385
check-format-string: false
3386-
# To require f-assertions if format string is used.
3386+
# To require f-assertions (e.g. `assert.Equalf`) if format string is used, even if there are no variable-length
3387+
# variables, i.e. it requires `require.NoErrorf` for both these cases:
3388+
# - require.NoErrorf(t, err, "unexpected error")
3389+
# - require.NoErrorf(t, err, "unexpected error for sid: %v", sid)
3390+
# To understand this behavior, please read the
3391+
# https://github.com/Antonboom/testifylint?tab=readme-ov-file#historical-reference-of-formatter.
33873392
# Default: false
33883393
require-f-funcs: true
33893394
go-require:

jsonschema/golangci.jsonschema.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -3059,7 +3059,7 @@
30593059
"default": true
30603060
},
30613061
"require-f-funcs": {
3062-
"description": "To require f-assertions if format string is used.",
3062+
"description": "To require f-assertions (e.g. assert.Equalf) if format string is used, even if there are no variable-length variables.",
30633063
"type": "boolean",
30643064
"default": false
30653065
}

jsonschema/golangci.next.jsonschema.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -3059,7 +3059,7 @@
30593059
"default": true
30603060
},
30613061
"require-f-funcs": {
3062-
"description": "To require f-assertions if format string is used.",
3062+
"description": "To require f-assertions (e.g. assert.Equalf) if format string is used, even if there are no variable-length variables.",
30633063
"type": "boolean",
30643064
"default": false
30653065
}

0 commit comments

Comments
 (0)