Avoid getter methods in Go
Avoid using "getter" methods in Go code. Instead, expose fields directly when appropriate, following Go's idiomatic approach to visibility.
Bad:
```go
type Person struct {
name string
age int
}
Install this rule for wispbit
Add this rule to wispbit and it will run when you open a pull request
Install this rule for Coderabbit
Copy the configuration below and add it to your repository as .coderabbit.yml
in your project root.
reviews:
path_instructions:
- path: "*.go"
instructions: |
Avoid using "getter" methods in Go code. Instead, expose fields directly when appropriate, following Go's idiomatic approach to visibility.
Bad:
```go
type Person struct {
name string
age int
}
func (p *Person) GetName() string {
return p.name
}
func (p *Person) GetAge() int {
return p.age
}
// Usage
name := person.GetName()
```
Good:
```go
type Person struct {
Name string
Age int
}
// Usage
name := person.Name
```
Install this rule for Greptile
Greptile rules can be added through the web interface. Please see this documentation for details on how to add custom rules and context.
Avoid using "getter" methods in Go code. Instead, expose fields directly when appropriate, following Go's idiomatic approach to visibility.
Bad:
```go
type Person struct {
name string
age int
}
func (p *Person) GetName() string {
return p.name
}
func (p *Person) GetAge() int {
return p.age
}
// Usage
name := person.GetName()
```
Good:
```go
type Person struct {
Name string
Age int
}
// Usage
name := person.Name
```
File Path Patterns:
Install this rule for GitHub Copilot
Copilot instructions can be added through the interface. See the documentation for details on how to create coding guidelines.
Avoid using "getter" methods in Go code. Instead, expose fields directly when appropriate, following Go's idiomatic approach to visibility.
Bad:
```go
type Person struct {
name string
age int
}
func (p *Person) GetName() string {
return p.name
}
func (p *Person) GetAge() int {
return p.age
}
// Usage
name := person.GetName()
```
Good:
```go
type Person struct {
Name string
Age int
}
// Usage
name := person.Name
```
File Path Patterns:
Install this rule for Graphite Diamond
Diamond custom rules can be added through the interface. See the documentation for details on how to create custom rules.
Avoid using "getter" methods in Go code. Instead, expose fields directly when appropriate, following Go's idiomatic approach to visibility.
Bad:
```go
type Person struct {
name string
age int
}
func (p *Person) GetName() string {
return p.name
}
func (p *Person) GetAge() int {
return p.age
}
// Usage
name := person.GetName()
```
Good:
```go
type Person struct {
Name string
Age int
}
// Usage
name := person.Name
```
File Path Patterns:
Use with Cline
Copy the rule below and ask Cline to review your code using this rule
Avoid using "getter" methods in Go code. Instead, expose fields directly when appropriate, following Go's idiomatic approach to visibility.
Bad:
```go
type Person struct {
name string
age int
}
func (p *Person) GetName() string {
return p.name
}
func (p *Person) GetAge() int {
return p.age
}
// Usage
name := person.GetName()
```
Good:
```go
type Person struct {
Name string
Age int
}
// Usage
name := person.Name
```
Use with OpenAI Codex
Copy the rule below and ask OpenAI Codex to review your code using this rule
Avoid using "getter" methods in Go code. Instead, expose fields directly when appropriate, following Go's idiomatic approach to visibility.
Bad:
```go
type Person struct {
name string
age int
}
func (p *Person) GetName() string {
return p.name
}
func (p *Person) GetAge() int {
return p.age
}
// Usage
name := person.GetName()
```
Good:
```go
type Person struct {
Name string
Age int
}
// Usage
name := person.Name
```
Use with Cursor
Copy the rule below and ask Cursor to review your code using this rule
Avoid using "getter" methods in Go code. Instead, expose fields directly when appropriate, following Go's idiomatic approach to visibility.
Bad:
```go
type Person struct {
name string
age int
}
func (p *Person) GetName() string {
return p.name
}
func (p *Person) GetAge() int {
return p.age
}
// Usage
name := person.GetName()
```
Good:
```go
type Person struct {
Name string
Age int
}
// Usage
name := person.Name
```
Use with Claude Code
Copy the rule below and ask Claude Code to review your code using this rule
Avoid using "getter" methods in Go code. Instead, expose fields directly when appropriate, following Go's idiomatic approach to visibility.
Bad:
```go
type Person struct {
name string
age int
}
func (p *Person) GetName() string {
return p.name
}
func (p *Person) GetAge() int {
return p.age
}
// Usage
name := person.GetName()
```
Good:
```go
type Person struct {
Name string
Age int
}
// Usage
name := person.Name
```
Install this rule for Windsurf
To set up rules for Windsurf Reviews, please see this documentation
Avoid using "getter" methods in Go code. Instead, expose fields directly when appropriate, following Go's idiomatic approach to visibility.
Bad:
```go
type Person struct {
name string
age int
}
func (p *Person) GetName() string {
return p.name
}
func (p *Person) GetAge() int {
return p.age
}
// Usage
name := person.GetName()
```
Good:
```go
type Person struct {
Name string
Age int
}
// Usage
name := person.Name
```