linthis 0.20.0

A fast, cross-platform multi-language linter and formatter
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

# Go Language Guide

linthis uses **golangci-lint** for linting and **gofmt** for formatting Go code.

## Supported File Extensions

- `.go`

## Required Tools

### Linter: golangci-lint

```bash
# macOS
brew install golangci-lint

# Linux
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

# Windows
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

# Verify installation
golangci-lint --version
```

### Formatter: gofmt

gofmt is included with the Go installation.

```bash
# Verify installation
gofmt -h
```

## Configuration

### Basic Example

```toml
# .linthis/config.toml

[go]
max_complexity = 15
excludes = ["vendor/**", "*_test.go"]
```

### Disable Specific Rules

```toml
[go.rules]
disable = [
    "errcheck",
    "gosimple"
]
```

## Custom Rules

```toml
[[rules.custom]]
code = "go/no-panic"
pattern = "\\bpanic\\s*\\("
message = "Avoid panic in production code"
severity = "warning"
suggestion = "Return an error instead"
languages = ["go"]

[[rules.custom]]
code = "go/no-todo"
pattern = "// TODO"
message = "TODO comment found"
severity = "info"
languages = ["go"]
```

## CLI Usage

```bash
# Check Go files only
linthis -c --lang go

# Format Go files only
linthis -f --lang go
```

## Golangci-lint Configuration

Create `.golangci.yml`:

```yaml
linters:
  enable:
    - errcheck
    - gosimple
    - govet
    - ineffassign
    - staticcheck
    - unused

linters-settings:
  errcheck:
    check-type-assertions: true
  govet:
    check-shadowing: true

issues:
  exclude-rules:
    - path: _test\.go
      linters:
        - errcheck
```

## Common Issues

### Golangci-lint not found

```
Warning: No go linter available for go files
  Install: brew install golangci-lint
```

### Slow first run

Golangci-lint caches results. First run may be slow, subsequent runs are faster.

### Vendor directory being checked

Add to excludes:

```toml
[go]
excludes = ["vendor/**"]
```

## Best Practices

1. **Use .golangci.yml**: Consistent configuration across your project
2. **Enable multiple linters**: golangci-lint aggregates many linters
3. **Complexity limits**: Go code is typically less complex, set `max_complexity = 15`
4. **Test exclusions**: Consider different rules for test files