feat: adding uber style guidelines (WIP) #48
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ccoVeille
reviewed
Apr 14, 2025
ccoVeille
reviewed
Apr 16, 2025
|
I added |
|
Ok, I was checking what else to add, and to be honest, I don't know if more rules can be covered, any idea @ccoVeille ? |
ccoVeille
reviewed
Apr 26, 2025
| - [Local Variable Declarations](https://github.com/uber-go/guide/blob/master/style.md#local-variable-declarations) | ||
| - [nil is a valid slice](https://github.com/uber-go/guide/blob/master/style.md#nil-is-a-valid-slice) | ||
| - [Reduce Scope of Variables](https://github.com/uber-go/guide/blob/master/style.md#reduce-scope-of-variables) | ||
| - [Avoid Naked Parameters](https://github.com/uber-go/guide/blob/master/style.md#avoid-naked-parameters) |
There was a problem hiding this comment.
Something was discussed lately in nakedreturn linter I think
| - [nil is a valid slice](https://github.com/uber-go/guide/blob/master/style.md#nil-is-a-valid-slice) | ||
| - [Reduce Scope of Variables](https://github.com/uber-go/guide/blob/master/style.md#reduce-scope-of-variables) | ||
| - [Avoid Naked Parameters](https://github.com/uber-go/guide/blob/master/style.md#avoid-naked-parameters) | ||
| - [Use Raw String Literals to Avoid Escaping](https://github.com/uber-go/guide/blob/master/style.md#use-raw-string-literals-to-avoid-escaping) |
There was a problem hiding this comment.
This one, I plan to create a linter.
There is one rule in staticcheck, but only for regexp
| - [Omit Zero Value Fields in Structs](https://github.com/uber-go/guide/blob/master/style.md#omit-zero-value-fields-in-structs) | ||
| - [Use `var` for Zero Value Structs](https://github.com/uber-go/guide/blob/master/style.md#use-var-for-zero-value-structs) | ||
| - [Initializing Struct References](https://github.com/uber-go/guide/blob/master/style.md#initializing-struct-references) | ||
| - [Initializing Maps](https://github.com/uber-go/guide/blob/master/style.md#initializing-maps) |
There was a problem hiding this comment.
There is something for this
maybe revive.enforce-slice-style
| - [Initializing Struct References](https://github.com/uber-go/guide/blob/master/style.md#initializing-struct-references) | ||
| - [Initializing Maps](https://github.com/uber-go/guide/blob/master/style.md#initializing-maps) | ||
| - [Format Strings outside Printf](https://github.com/uber-go/guide/blob/master/style.md#format-strings-outside-printf) | ||
| - [Naming Printf-style Functions](https://github.com/uber-go/guide/blob/master/style.md#naming-printf-style-functions) |
There was a problem hiding this comment.
There is something for this in revive, go vet, or go-critic
Comment on lines
+51
to
+52
| - [Package Names](https://github.com/uber-go/guide/blob/master/style.md#package-names) | ||
| - [Function Names](https://github.com/uber-go/guide/blob/master/style.md#function-names) |
There was a problem hiding this comment.
revive.var-naming does that for packages and function
| - [Wait for goroutines to exit](https://github.com/uber-go/guide/blob/master/style.md#wait-for-goroutines-to-exit) | ||
| - [No goroutines in `init()`](https://github.com/uber-go/guide/blob/master/style.md#no-goroutines-in-init) | ||
| - [Performance](https://github.com/uber-go/guide/blob/master/style.md#performance) | ||
| - [x] [Prefer strconv over fmt](https://github.com/uber-go/guide/blob/master/style.md#prefer-strconv-over-fmt) - Style applied through `perfsprint` |
There was a problem hiding this comment.
Please mention the name of the option
| - [Prefer Specifying Container Capacity](https://github.com/uber-go/guide/blob/master/style.md#prefer-specifying-container-capacity) | ||
| - [Style](https://github.com/uber-go/guide/blob/master/style.md#style) | ||
| - [x] [Avoid overly long lines](https://github.com/uber-go/guide/blob/master/style.md#avoid-overly-long-lines) - Style applied through `lll` | ||
| - [Be Consistent](https://github.com/uber-go/guide/blob/master/style.md#be-consistent) |
There was a problem hiding this comment.
Maybe revive.enforce-slice-style make sense here
| - [Avoid Naked Parameters](https://github.com/uber-go/guide/blob/master/style.md#avoid-naked-parameters) | ||
| - [Use Raw String Literals to Avoid Escaping](https://github.com/uber-go/guide/blob/master/style.md#use-raw-string-literals-to-avoid-escaping) | ||
| - [Initializing Structs](https://github.com/uber-go/guide/blob/master/style.md#initializing-structs) | ||
| - [Use Field Names to Initialize Structs](https://github.com/uber-go/guide/blob/master/style.md#use-field-names-to-initialize-structs) |
There was a problem hiding this comment.
There is something for this
Try to find it with daredevil
| - [Use `var` for Zero Value Structs](https://github.com/uber-go/guide/blob/master/style.md#use-var-for-zero-value-structs) | ||
| - [Initializing Struct References](https://github.com/uber-go/guide/blob/master/style.md#initializing-struct-references) | ||
| - [Initializing Maps](https://github.com/uber-go/guide/blob/master/style.md#initializing-maps) | ||
| - [Format Strings outside Printf](https://github.com/uber-go/guide/blob/master/style.md#format-strings-outside-printf) |
There was a problem hiding this comment.
Perfsprint here maybe, this one might be about str-concat option
| - [Function Names](https://github.com/uber-go/guide/blob/master/style.md#function-names) | ||
| - [Import Aliasing](https://github.com/uber-go/guide/blob/master/style.md#import-aliasing) | ||
| - [x] [Function Grouping and Ordering](https://github.com/uber-go/guide/blob/master/style.md#function-grouping-and-ordering) - Style applied through linter `funcorder`. | ||
| - [Reduce Nesting](https://github.com/uber-go/guide/blob/master/style.md#reduce-nesting) |
There was a problem hiding this comment.
There is revive.max-control-nesting and revive.cyclomatic
But also everything listed in #48 (comment)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Skeleton to create a
.golangci-lint.ymlwith Uber Style Guidelines.