aboutsummaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)Author
2024-03-10Increase version v0.0.1 -> v0.0.2HEADv0.0.2masterTeddy Wing
2024-03-10go.mod: Upgrade 'golang.org/x/tools' to latest v0.19.0Teddy Wing
After upgrading to Go 1.22.0, I ended up with a segfault: $ go test -v === RUN Test panic: runtime error: invalid memory address or nil pointer dereference [recovered] panic: runtime error: invalid memory address or nil pointer dereference [signal SIGSEGV: segmentation violation code=0x2 addr=0x0 pc=0x1006fef14] goroutine 44 [running]: go/types.(*Checker).handleBailout(0x140003e8c00, 0x14000027b98) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/check.go:367 +0x9c panic({0x100815520?, 0x1009e85d0?}) /opt/homebrew/Cellar/go/1.22.1/libexec/src/runtime/panic.go:770 +0x124 go/types.(*StdSizes).Sizeof(0x0, {0x100861ca8, 0x1009eb9a0}) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/sizes.go:228 +0x314 go/types.(*Config).sizeof(...) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/sizes.go:333 go/types.representableConst.func1({0x100861ca8?, 0x1009eb9a0?}) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/const.go:76 +0x9c go/types.representableConst({0x100862fb0, 0x1009dfd60}, 0x140003e8c00, 0x1009eb9a0, 0x0) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/const.go:92 +0x138 go/types.(*Checker).arrayLength(0x140003e8c00, {0x100862088, 0x140002f5c00?}) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/typexpr.go:510 +0x238 go/types.(*Checker).typInternal(0x140003e8c00, {0x100862058, 0x140003f6a80}, 0x0) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/typexpr.go:299 +0x3bc go/types.(*Checker).definedType(0x140003e8c00, {0x100862058, 0x140003f6a80}, 0x14000027158?) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/typexpr.go:180 +0x2c go/types.(*Checker).varType(0x140003e8c00, {0x100862058, 0x140003f6a80}) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/typexpr.go:145 +0x2c go/types.(*Checker).structType(0x140003e8c00, 0x140003f6de0, 0x140003f6de0?) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/struct.go:113 +0x128 go/types.(*Checker).typInternal(0x140003e8c00, {0x100862328, 0x1400000d368}, 0x140004220a0) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/typexpr.go:316 +0xed0 go/types.(*Checker).definedType(0x140003e8c00, {0x100862328, 0x1400000d368}, 0x10052c214?) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/typexpr.go:180 +0x2c go/types.(*Checker).typeDecl(0x140003e8c00, 0x140004220a0, 0x140003bd940, 0x0) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/decl.go:615 +0x39c go/types.(*Checker).objDecl(0x140003e8c00, {0x100865178, 0x140004220a0}, 0x0) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/decl.go:197 +0x880 go/types.(*Checker).packageObjects(0x140003e8c00) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/resolver.go:681 +0x3c0 go/types.(*Checker).checkFiles(0x140003e8c00, {0x14000052660, 0x1, 0x1}) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/check.go:408 +0x164 go/types.(*Checker).Files(...) /opt/homebrew/Cellar/go/1.22.1/libexec/src/go/types/check.go:372 golang.org/x/tools/go/packages.(*loader).loadPackage(0x140001581c0, 0x14000169230) go/pkg/mod/golang.org/x/tools@v0.9.1/go/packages/packages.go:1052 +0x870 golang.org/x/tools/go/packages.(*loader).loadRecursive.func1() go/pkg/mod/golang.org/x/tools@v0.9.1/go/packages/packages.go:851 +0x178 sync.(*Once).doSlow(0x0?, 0x0?) /opt/homebrew/Cellar/go/1.22.1/libexec/src/sync/once.go:74 +0x100 sync.(*Once).Do(...) /opt/homebrew/Cellar/go/1.22.1/libexec/src/sync/once.go:65 golang.org/x/tools/go/packages.(*loader).loadRecursive(0x0?, 0x0?) go/pkg/mod/golang.org/x/tools@v0.9.1/go/packages/packages.go:839 +0x50 golang.org/x/tools/go/packages.(*loader).loadRecursive.func1.1(0x0?) go/pkg/mod/golang.org/x/tools@v0.9.1/go/packages/packages.go:846 +0x30 created by golang.org/x/tools/go/packages.(*loader).loadRecursive.func1 in goroutine 43 go/pkg/mod/golang.org/x/tools@v0.9.1/go/packages/packages.go:845 +0x84 exit status 2 FAIL gopkg.teddywing.com/defererr 0.130s Upgrading to the latest version of 'golang.org/x/tools' resolved the problem.
2023-05-26Add license (GNU GPLv3+)v0.0.1Teddy Wing
2023-05-26Add READMETeddy Wing
2023-05-26Add package documentationTeddy Wing
Tried the sample code and it looks like the `return err` is not necessary. The `err` set in `defer` does work find even when using `return nil`. Oh well, we can adjust that check later if needed.
2023-05-26functionState: Format fields after doc comment additionTeddy Wing
2023-05-25Add more detail to the explanation of how the analyser worksTeddy Wing
2023-05-25checkErrorAssignedInDefer: Remove obsolete TODOTeddy Wing
Since we don't want to bother with functions that return multiple values, don't actually report a suggested return signature replacement.
2023-05-25shouldDeclareErrInSignature: Add note about variable declaration lineTeddy Wing
When I was first coming up with ideas for the project, I thought that this line is one I might need to report a diagnostic for, but since the compiler will catch it, we don't need to bother.
2023-05-25Report missing signature declaration with multiple return valuesTeddy Wing
The previous message which reported when a function's return signature didn't declare an error variable didn't work for functions with multiple return values. I thought about extending it and coming up with generated variable names for the non-error types to be able to support automatic fixing, but this idea ended up being too complicated. Also, I didn't like the idea of an automated fixer coming up with generated variable names, because you'd need to manually rename them anyway. That kind of defeats the purpose of it being automated. Instead, change the diagnostic message to only refer to the error variable and recommend what the declared variable name should be based on the identifier the error was assigned to in the defer. Modify our multiple return value test functions according to this new approach.
2023-05-25Add identifier documentation commentsTeddy Wing
2023-05-25newFunctionState: Return value instead of pointerTeddy Wing
Makes more sense to me to show the `&`s when we pass the value as an argument to functions. That makes it clearer that the functions are taking a reference type.
2023-05-25checkFunctions: Move function body `ast.Inspect` to named functionTeddy Wing
Clean up the rest of `checkFunctions`.
2023-05-25checkFunctions: Keep `continue` in return value loopTeddy Wing
Looks like the return value type is always an `*ast.Ident`. Use `continue` instead of `return true` to be more tolerant of unexpected values.
2023-05-25Add note to check ident condition in return signature list loopTeddy Wing
2023-05-25checkFunctions: Start cleaning up this functionTeddy Wing
* Add some explanatory comments. * Fix return value loop: don't stop the function analysis if one of the items isn't an identifier. (Wait, is this really fixing the loop or did I get it right the first time, and the return was when the function results don't have variable declarations? Will have to check that.) * Remove `funcReturnsError` which is redundant now that we have `errorReturnIndex`.
2023-05-24Change `isFirstErrorDeferEndPosSet()` to `deferAssignsError()`Teddy Wing
The previous function didn't make enough sense without the context of when `firstErrorDeferEndPos` is set. Use a different function named for what we actually want to know.
2023-05-24Fix name of `isfirstErrorDeferEndPosSet`Teddy Wing
Wasn't using the correct case because I had auto-completed from the field name.
2023-05-24Fix logic of `isfirstErrorDeferEndPosSet`Teddy Wing
Was returning the opposite of what it said.
2023-05-24Clean up `checkFunctionReturns()` functionTeddy Wing
2023-05-23Extract `return` handling to functionTeddy Wing
2023-05-23Idea about multiple return valuesTeddy Wing
2023-05-23Add tests with multiple return valuesTeddy Wing
Don't pass yet as we currently only suggest `(errorVar error)` as the return signature.
2023-05-22Clean up `checkErrorAssignedInDefer()` functionTeddy Wing
* Remove debug prints. * Reorganise the code so that similar things are together. * Add comments describing the logic.
2023-05-21Report function signature declaration using variable name other than errTeddy Wing
I had previously hard-coded the variable name "err" as the recommended name declaration in the function signature for simplicity. Now, use the name assigned in the `defer` instead, which is more correct.
2023-05-21Add 'godefererr' executableTeddy Wing
Based on the code from 'gocapturedrefrace'.
2023-05-21Check whether `return` uses error variable set in `defer`Teddy Wing
This reports diagnostics when using `return nil` instead of `return err` when `err` is an error variable assigned in the first `defer` closure.
2023-05-21Clarify name of `returnsOtherVariable` testTeddy Wing
2023-05-21Check whether returned name matches defer error nameTeddy Wing
Ensure the name of the returned error variable matches the name of the error variable assigned in the `defer` statement.
2023-05-21Inspect return value looking at type and nameTeddy Wing
Want to check that the `return` statement uses the same variable used in the `defer` closure. Start inspecting the values to figure out how we can narrow that down. Add a test case for a "good" assignment of a returned error in `defer`.
2023-05-21Get type information from `return` statement valuesTeddy Wing
2023-05-21Explore inspecting `return` statements for error valuesTeddy Wing
2023-05-21Add skeleton for checking `return` statements after `defer` closuresTeddy Wing
2023-05-21Correctly `setFirstErrorDeferEndPos` for `doesDeclareErrInSignature`Teddy Wing
Since `ident.Obj.Decl` is a `*ast.ValueSpec` in `shouldDeclareErrInSignature` but a `*ast.Field` in `doesDeclareErrInSignature`, we need to handle both declaration types. Turn the value into an `ast.Node`, which covers both, and use that to determine whether the variable is declared in the closure.
2023-05-21Working out why doesDeclareErrInSignature doesn't get far in assign loopTeddy Wing
We were looking for a `*ast.ValueSpec`, but it looks like when `err` is declared in the function signature, the type is `*ast.Field`.
2023-05-21Print the current function for easier debuggingTeddy Wing
Show me which function the debug print statements belong to.
2023-05-21Try to store the end position of the first defer closure with errorTeddy Wing
The idea is to store the end position of the first defer closure that assigns an error variable from the outer scope. Then, we can check the `return` statements in the rest of the function after that position to ensure they use the error variable.
2023-05-21Update `firstDeferEndPos` nameTeddy Wing
Clarify intended contents.
2023-05-21Add ideas for checking `return`sTeddy Wing
2023-05-21Idea for checking `return`sTeddy Wing
2023-05-21Next step to check usage of error variable in returnTeddy Wing
2023-05-21Move error variable GenDecl check to functionTeddy Wing
Give the check a name.
2023-05-21Ignore errors declared using GenDecl inside defer closureTeddy Wing
We don't want to report error variables that were declared inside the closure, as those don't depend on the outside scope.
2023-05-21Idea to move defer func check to a separate functionTeddy Wing
2023-05-21Move function `ast.Inspect` to new functionTeddy Wing
Give it a name.
2023-05-21Move defer closure `ast.Inspect` to a separate functionTeddy Wing
Trying to make this easier to read.
2023-05-21Add test to ensure error vars declared in defer closure are not reportedTeddy Wing
2023-05-20Report when error declaration in signature is neededTeddy Wing
While looking at the assignments in the `defer`, if we encounter an `error`-type assignment, emit a diagnostic if the error named in the lhs of the assignment is not present in the return signature's names. Not sure if this makes sense to me yet. I probably only want to report a problem for a non-declare assignment of an error value when the error type in the return signature is _not_ named at all.
2023-05-20Get error variable names from type loopTeddy Wing
Store the index where we find the `error` type in the function signature's return list so we can use it later to get the corresponding variable names, if any.
2023-05-20Find function signature return value namesTeddy Wing
And add a test function that does have named returned values.
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-14 07:54:03 +0000