完美解决Github提交PR后报错:File is not gofumpt-ed (gofumpt)

问题阐述

最近在Github上提交PR后,遇到了这么一个问题:golangci-lint运行失败,具体原因是File is not gofumpt-ed (gofumpt)

名词解释

golangci-lint: golangci-lint 是Go语言社区中常用的代码质量检查工具,它可以帮助开发者发现代码中的潜在问题和不规范之处。它集成了多种代码检查工具,用于检查代码风格、静态分析、性能问题等。

可以在本地使用该工具,会输出当前项目的警告与错误等。

bash 复制代码
//前提确保`GOPATH/bin`在path环境变量里
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
golangci-lint run

gofumpt: gofumpt 是一个用于格式化Go代码的工具,它是 gofmt 的替代品。gofmt 是Go语言官方提供的代码格式化工具,而 gofumpt 是在 gofmt 基础上进行改进的,旨在强制执行一种更加一致和规范的代码风格。

bash 复制代码
//前提确保`GOPATH/bin`在path环境变量里
go install mvdan.cc/gofumpt@latest
gofumpt -w your_file.go

在我的情况下,出现了File is not gofumpt-ed的错误,意味着提交中的某个文件不符合 gofumpt 规定的代码格式。这可能是因为代码中的一些排版问题,例如缩进、空格、换行等方面不符合规范。为了通过代码审查,需要对这些文件进行格式化,使其符合 gofumpt 的规范。

解决办法

从我提供的截图可以看到:Check failure on line 20 in object/get-dashboard.go。说明是get-dashboard.go这个文件20行有问题。只需要cd到有问题的go文件目录,执行命令:gofumpt -w get-dashboard.go。这样gofumpt 工具就会自动帮我们格式化代码。格式化的结果就是将部分多余的换行删了,也就是删掉第20行。然后我重新commit代码,发现golangci-lint就可以通过了。

相关推荐
我是一只代码狗7 小时前
idea中使用git
git·gitee·github
产品经理独孤虾9 小时前
GitHub Copilot:产品经理提升工作效率的AI助手
github·copilot·产品经理·原型设计·ai工具·效率提升·prd
杜莱10 小时前
IDEA 安装AI代码助手GitHub Copilot和简单使用体验
人工智能·github·intellij-idea
亚洲第一中锋_哈达迪11 小时前
详解缓存淘汰策略:LFU
后端·缓存·golang
LogicFlow11 小时前
对单调的画布说拜拜👋🏻
前端框架·开源·github
nextera-void12 小时前
深入浅出 Golang:一次精神之旅
开发语言·golang·go
強云13 小时前
使用 SSH 连接 GitHub
ssh·github
这里有鱼汤14 小时前
🚀逆天神器来了!MCP Chrome:超越Playwright,让AI接管你的浏览器,我当场震撼!
github·mcp
独立开阀者_FwtCoder14 小时前
前端开发的你,其实并没有真的掌握img标签!
前端·vue.js·github