blob: 5aaed57e01d37374b844008d8f4a9c886a649a79 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
godefererr
==========
[][Documentation]
An analyser that reports incorrectly returned errors from defer closures.
Errors can be returned from a `defer` closure by assigning the error to a
captured variable declared in the function signature. This analyser looks for
defer closures that assign captured error variables and checks that they are
correctly declared and returned.
## Example
Given the following program:
``` go
package main
import (
"errors"
"log"
)
func main() {
err := returnErrorFromDefer()
if err != nil {
log.Fatal(err)
}
log.Println("test")
}
func returnErrorFromDefer() error { // return signature should be '(err error)'
var err error = nil
if err != nil {
return err
}
defer func() {
err = errors.New("defer error")
}()
return nil // return should use 'err'
}
```
the analyser produces the following results:
$ godefererr ./...
package_doc_example.go:17:29: return signature should use named error parameter err
package_doc_example.go:27:9: does not return 'err'
## Install
$ go install gopkg.teddywing.com/defererr/cmd/godefererr@latest
## License
Copyright © 2023 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
COPYING file).
[Documentation]: https://godocs.io/gopkg.teddywing.com/defererr
|
