Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add interface{} to any replacement to make fmt, exclude *.pb.go #30461

Merged
merged 11 commits into from Apr 13, 2024
Merged

Add interface{} to any replacement to make fmt, exclude *.pb.go #30461

merged 11 commits into from Apr 13, 2024

Conversation

silverwind
Copy link
Member

@silverwind silverwind commented Apr 13, 2024 •
edited

Since #25686, a few interface{} have sneaked into the codebase. Add this replacement to make fmt to prevent this from happening again.

Ideally a linter would do this, but I haven't found any suitable.

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Apr 13, 2024
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Apr 13, 2024
@github-actions github-actions bot added modifies/api This PR adds API routes or modifies them modifies/go Pull requests that update Go code modifies/internal labels Apr 13, 2024
@silverwind silverwind changed the title Add interface{} to any replacement to make fmt Add interface{} to any replacement to make fmt Apr 13, 2024
@silverwind silverwind added the type/refactoring Existing code has been cleaned up. There should be no new functionality. label Apr 13, 2024
@pull-request-size pull-request-size bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 13, 2024
@silverwind
Copy link
Member Author

silverwind commented Apr 13, 2024 •
edited

getGoVersion is removed because gofumpt already defaults to the version in go.mod:

-lang       str    target Go version in the form "1.X" (default from go.mod)

Related discussion in #21457.

@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Apr 13, 2024
@wxiaoguang
Copy link
Contributor

Don't do this for some auto generated file like routers/api/actions/artifact.pb.go

image

@silverwind
Copy link
Member Author

silverwind commented Apr 13, 2024 •
edited

How should we identify generated code? Need something in the filename. Maybe this .pb.go extension but no idea what it means.

@silverwind
Copy link
Member Author

.pb.go seems to be protobuf specific for generated go code: https://protobuf.dev/reference/go/go-generated/

@github-actions github-actions bot removed the modifies/api This PR adds API routes or modifies them label Apr 13, 2024
@silverwind
Copy link
Member Author

Done, those will not be formatted or linted anymore and I marked them as generated in the gitattributes as well.

@silverwind silverwind changed the title Add interface{} to any replacement to make fmt Add interface{} to any replacement to make fmt, exclude .pb.go Apr 13, 2024
@silverwind
Copy link
Member Author

silverwind commented Apr 13, 2024 •
edited

BTW there is this quip in golangci docs:

There is no need to include all autogenerated files,
we confidently recognize autogenerated files.

I would not rely on such undocumented magic, so the exclude rule stays.

silverwind
silverwind commented Apr 13, 2024
View reviewed changes
.golangci.yml Outdated Show resolved Hide resolved
silverwind
silverwind commented Apr 13, 2024
View reviewed changes
.golangci.yml Outdated Show resolved Hide resolved
@silverwind silverwind changed the title Add interface{} to any replacement to make fmt, exclude .pb.go Add interface{} to any replacement to make fmt, exclude *.pb.go Apr 13, 2024
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Apr 13, 2024
silverwind
silverwind commented Apr 13, 2024
View reviewed changes
.golangci.yml Outdated Show resolved Hide resolved
@silverwind
Copy link
Member Author

silverwind commented Apr 13, 2024 •
edited

BTW there is this quip in golangci docs:

There is no need to include all autogenerated files,
we confidently recognize autogenerated files.

I would not rely on such undocumented magic, so the exclude rule stays.

Decided with going with the defaults now. .pb.go is excluded in golangci by all current indications, so it's better to go with the defaults, even though I disagree that golangci even has such opinionated and more importantly undocumented defaults.

@silverwind silverwind added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Apr 13, 2024
@silverwind silverwind enabled auto-merge (squash) April 13, 2024 17:06
@silverwind silverwind merged commit c77e814 into go-gitea:main Apr 13, 2024
26 checks passed
@GiteaBot GiteaBot added this to the 1.23.0 milestone Apr 13, 2024
@GiteaBot GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Apr 13, 2024
silverwind added a commit to silverwind/gitea that referenced this pull request Apr 13, 2024
@silverwind
Merge remote-tracking branch 'origin/main' into support_render_openapi
ff8a5b3 
* origin/main: (1540 commits)
  Add `interface{}` to `any` replacement to `make fmt`, exclude `*.pb.go` (go-gitea#30461)
  Fix network error when open/close organization/individual projects and redirect to project page (go-gitea#30387)
  Avoid losing token when updating mirror settings (go-gitea#30429)
  Fix label rendering (go-gitea#30456)
  Add comment for ContainsRedirectURI about the exact match (go-gitea#30457)
  Update JS and PY deps, lock eslint and related plugins (go-gitea#30452)
  Refactor cache and disable go-chi cache (go-gitea#30417)
  Fix admin notice view-detail (go-gitea#30450)
  Fix mirror error when mirror repo is empty (go-gitea#30432)
  Add `/public/assets/img/webpack` to ignore files again (go-gitea#30451)
  Lock a few tool dependencies to major versions (go-gitea#30439)
  Fix commit status cache which missed target_url (go-gitea#30426)
  Remove jQuery from the commit graph (except Fomantic) (go-gitea#30395)
  Fix rename branch 500 when the target branch is deleted but exist in database (go-gitea#30430)
  Limit the max line length when parsing git grep output (go-gitea#30418)
  Change the default maxPerPage for gitbucket (go-gitea#30392)
  Fix the spacing issue in the Project view (go-gitea#30415)
  Add commit status summary table to reduce query from commit status table (go-gitea#30223)
  Split `issue edit` code from `repo-legacy.js` into its own file (go-gitea#30419)
  Check the token's owner and repository when registering a runner (go-gitea#30406)
  ...
zjjhot added a commit to zjjhot/gitea that referenced this pull request Apr 14, 2024
@zjjhot
Merge remote-tracking branch 'giteaofficial/main'
d51ac9b 
* giteaofficial/main:
  Fix JS error when opening to expanded code comment (go-gitea#30463)
  fix: Fix to delete cookie when AppSubURL is non-empty (go-gitea#30375)
  Add `interface{}` to `any` replacement to `make fmt`, exclude `*.pb.go` (go-gitea#30461)
  Fix network error when open/close organization/individual projects and redirect to project page (go-gitea#30387)
  Avoid losing token when updating mirror settings (go-gitea#30429)
  Fix label rendering (go-gitea#30456)
  Add comment for ContainsRedirectURI about the exact match (go-gitea#30457)
  Update JS and PY deps, lock eslint and related plugins (go-gitea#30452)
  Refactor cache and disable go-chi cache (go-gitea#30417)
  Fix admin notice view-detail (go-gitea#30450)
  Fix mirror error when mirror repo is empty (go-gitea#30432)
  Add `/public/assets/img/webpack` to ignore files again (go-gitea#30451)
  Lock a few tool dependencies to major versions (go-gitea#30439)
  Fix commit status cache which missed target_url (go-gitea#30426)
  Remove jQuery from the commit graph (except Fomantic) (go-gitea#30395)
  Fix rename branch 500 when the target branch is deleted but exist in database (go-gitea#30430)
  Limit the max line length when parsing git grep output (go-gitea#30418)
silverwind added a commit to silverwind/gitea that referenced this pull request Apr 14, 2024
@silverwind
Merge remote-tracking branch 'origin/main' into rmapi
db2e80c 
* origin/main: (35 commits)
  Remove fomantic button module (go-gitea#30475)
  Improve "must-change-password" logic and document (go-gitea#30472)
  Fix commitstatus summary (go-gitea#30431)
  Remove fomantic menu module (go-gitea#30325)
  Use `flex-container` for dashboard layout (go-gitea#30214)
  Rewrite and restyle reaction selector and enable no-sizzle eslint rule (go-gitea#30453)
  Pulse page improvements (go-gitea#30149)
  Fix JS error when opening to expanded code comment (go-gitea#30463)
  fix: Fix to delete cookie when AppSubURL is non-empty (go-gitea#30375)
  Add `interface{}` to `any` replacement to `make fmt`, exclude `*.pb.go` (go-gitea#30461)
  Fix network error when open/close organization/individual projects and redirect to project page (go-gitea#30387)
  Avoid losing token when updating mirror settings (go-gitea#30429)
  Fix label rendering (go-gitea#30456)
  Add comment for ContainsRedirectURI about the exact match (go-gitea#30457)
  Update JS and PY deps, lock eslint and related plugins (go-gitea#30452)
  Refactor cache and disable go-chi cache (go-gitea#30417)
  Fix admin notice view-detail (go-gitea#30450)
  Fix mirror error when mirror repo is empty (go-gitea#30432)
  Add `/public/assets/img/webpack` to ignore files again (go-gitea#30451)
  Lock a few tool dependencies to major versions (go-gitea#30439)
  ...
silverwind added a commit to silverwind/gitea that referenced this pull request Apr 14, 2024
@silverwind
Merge remote-tracking branch 'origin/main' into longbranch
efa7943 
* origin/main:
  Improve flex ellipsis (go-gitea#30479)
  Remove fomantic button module (go-gitea#30475)
  Improve "must-change-password" logic and document (go-gitea#30472)
  Fix commitstatus summary (go-gitea#30431)
  Remove fomantic menu module (go-gitea#30325)
  Use `flex-container` for dashboard layout (go-gitea#30214)
  Rewrite and restyle reaction selector and enable no-sizzle eslint rule (go-gitea#30453)
  Pulse page improvements (go-gitea#30149)
  Fix JS error when opening to expanded code comment (go-gitea#30463)
  fix: Fix to delete cookie when AppSubURL is non-empty (go-gitea#30375)
  Add `interface{}` to `any` replacement to `make fmt`, exclude `*.pb.go` (go-gitea#30461)
  Fix network error when open/close organization/individual projects and redirect to project page (go-gitea#30387)
  Avoid losing token when updating mirror settings (go-gitea#30429)
@wxiaoguang wxiaoguang modified the milestones: 1.23.0, 1.22.0 Apr 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lunny lunny lunny approved these changes

@lafriks lafriks lafriks approved these changes

Assignees
No one assigned
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. modifies/go Pull requests that update Go code modifies/internal size/S Denotes a PR that changes 10-29 lines, ignoring generated files. type/refactoring Existing code has been cleaned up. There should be no new functionality.
Projects
None yet
Milestone
1.22.0
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@silverwind @wxiaoguang @lunny @lafriks @GiteaBot