https://github.com/linabellbiu/gorecover

🔧可集成golangci-lint的协程内部静态检查recover的插件
https://github.com/linabellbiu/gorecover

go-pulgin goalngci-lint golang goroutine pulgin recover

Last synced: 12 days ago
JSON representation

🔧可集成golangci-lint的协程内部静态检查recover的插件

• Host: GitHub
• URL: https://github.com/linabellbiu/gorecover
• Owner: linabellbiu
• License: mit
• Created: 2022-11-02T09:14:13.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-04T02:12:35.000Z (about 2 years ago)
• Last Synced: 2024-11-05T22:06:56.951Z (2 months ago)
• Topics: go-pulgin, goalngci-lint, golang, goroutine, pulgin, recover
• Language: Go
• Homepage:
• Size: 7.81 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# goroutinen 静态检查recover 插件

### 用来检查某些场景下goroutine内需要捕获panic,防止不必要的程序异常停止

### 使用:

```

./gorecover ../../testdata/src/p/main.go

// 输出检查的异常

gorecover/testdata/src/p/main.go:9:5: goroutine should have recover in defer func

```

```go

package main

import (

	"fmt"

	"runtime"

)

func goFuncWithRecover() {

	go func() { // want "goroutine should have recover in defer func"

	}()

	

	go func() {

		defer func() {

			recover()

		}()

	}()

	go HandlerPanic(func() {

		panic("panic2")

	})

}

func HandlerPanic(f func()) {

	defer func() {

		if r := recover(); r != nil {

			buf := make([]byte, 64<<10)

			buf = buf[:runtime.Stack(buf, false)]

			fmt.Println(r)

		}

	}()

	f()

}

func main() {

	goFuncWithRecover()

}

```

## 集成到[golangci-lint](https://golangci-lint.run)使用

1. 创建文件 golangci-lint/pkg/golinters/gorecover.go

```go

package golinters

import (

"github.com/wangxudong123/gorecover/analyzer"

"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"

"golang.org/x/tools/go/analysis"

)

func NewGoRecoverCheck() *goanalysis.Linter {

    return goanalysis.NewLinter(

            analyzer.Analyzer.Name,

            analyzer.Analyzer.Doc,

            []*analysis.Analyzer{analyzer.Analyzer},

            nil,

        ).WithLoadMode(goanalysis.LoadModeSyntax)

}

   ```

2. 导入配置 golangci-lint/pkg/lint/lintersdb/manager.go

```go

func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {

	// 一坨代码

	...

	

	// 导入NewGoRecoverCheck配置 

	linter.NewConfig(golinters.NewGoRecoverCheck()).

		WithSince("v1.0.0").

		WithPresets(linter.PresetStyle, linter.PresetBugs).

		WithURL("https://github.com/wangxudong123/gorecover"),

	

}

```

4. 重新编译golangci-lint

5. 在你的项目中`.golangci.yml`中添加`gorecover` 静态检查项

```yaml

linters:

  disable-all: true # 关闭全部检查

  enable: # 打开下面的检查选项

    - gorecover

```

[.golangci.yml](https://golangci-lint.run/usage/configuration) 相关配置

## Go Versions

| Version | Supported          |

| ------- | ------------------ |

| 1.18.x   | :white_check_mark:               |

## Golangci-lint Versions

| Version | Supported          |

|---------| ------------------ |

| 1.47.3  | :white_check_mark:  |