linthis 0.19.3

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
142
143
144
145
146
147
148
149
150
151

# Kotlin Language Guide

linthis uses **ktlint** for both linting and formatting, with optional **detekt** for additional static analysis.

## Supported File Extensions

- `.kt`
- `.kts`

## Required Tools

### Linter & Formatter: ktlint

```bash
# macOS
brew install ktlint

# Or via curl
curl -sSLO https://github.com/pinterest/ktlint/releases/download/1.0.1/ktlint
chmod a+x ktlint

# Verify installation
ktlint --version
```

### Optional: detekt (additional static analysis)

```bash
# macOS
brew install detekt

# Verify installation
detekt --version
```

## Configuration

### Basic Example

```toml
# .linthis/config.toml

[kotlin]
max_complexity = 15
excludes = ["build/**", "*.generated.kt"]
```

### Disable Specific Rules

```toml
[kotlin.rules]
disable = [
    "max-line-length",
    "no-wildcard-imports"
]
```

## Custom Rules

```toml
[[rules.custom]]
code = "kotlin/no-println"
pattern = "println\\s*\\("
message = "Use logging framework instead of println()"
severity = "warning"
languages = ["kotlin"]

[[rules.custom]]
code = "kotlin/no-lateinit"
pattern = "lateinit\\s+var"
message = "Consider using lazy or nullable instead of lateinit"
severity = "info"
languages = ["kotlin"]
```

## CLI Usage

```bash
# Check Kotlin files only
linthis -c --lang kotlin

# Format Kotlin files only
linthis -f --lang kotlin
```

## Ktlint Configuration

Create `.editorconfig` for ktlint:

```ini
[*.{kt,kts}]
indent_size = 4
max_line_length = 120
ktlint_code_style = ktlint_official
```

Or use ktlint-specific config file `.ktlint`:

```
disabled_rules=no-wildcard-imports
```

## Detekt Configuration

Create `detekt.yml`:

```yaml
complexity:
  LongMethod:
    threshold: 60
  ComplexMethod:
    threshold: 15

style:
  MaxLineLength:
    maxLineLength: 120
```

## Common Issues

### Ktlint not found

```
Warning: No kotlin linter available for kotlin files
  Install: brew install ktlint
```

### Build outputs being checked

Add to excludes:

```toml
[kotlin]
excludes = ["build/**", "out/**", ".gradle/**"]
```

### Generated code

Add generated files to excludes:

```toml
[kotlin]
excludes = ["*.generated.kt", "generated/**"]
```

## Best Practices

1. **Use .editorconfig**: Standard way to configure ktlint
2. **Android projects**: Exclude generated code and build outputs
3. **Coroutines**: Be mindful of complexity in suspend functions
4. **KDoc comments**: Use KDoc for public API documentation