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

# Rust Language Guide

linthis uses **clippy** for linting and **rustfmt** for formatting Rust code.

## Supported File Extensions

- `.rs`

## Required Tools

### Linter: clippy

```bash
# Install via rustup (recommended)
rustup component add clippy

# Verify installation
cargo clippy --version
```

### Formatter: rustfmt

```bash
# Install via rustup (recommended)
rustup component add rustfmt

# Verify installation
rustfmt --version
```

## Configuration

### Basic Example

```toml
# .linthis/config.toml

[rust]
max_complexity = 15
excludes = ["target/**"]
```

### Disable Specific Clippy Lints

```toml
[rust.rules]
disable = [
    "clippy::needless_return",
    "clippy::too_many_arguments",
    "clippy::type_complexity"
]
```

### Change Severity

```toml
[rust.rules.severity]
"clippy::unwrap_used" = "error"    # Treat unwrap as error
"clippy::todo" = "warning"         # Keep TODO as warning
```

## Custom Rules

```toml
[[rules.custom]]
code = "rust/no-println"
pattern = "println!"
message = "Use log macros instead of println!"
severity = "warning"
suggestion = "Use log::info!, log::debug!, etc."
languages = ["rust"]
```

## CLI Usage

```bash
# Check Rust files only
linthis -c --lang rust

# Format Rust files only
linthis -f --lang rust

# Check specific file
linthis -c src/main.rs
```

## Clippy Configuration

linthis respects your `.clippy.toml` or `clippy.toml` configuration file:

```toml
# clippy.toml
cognitive-complexity-threshold = 15
too-many-arguments-threshold = 8
```

## Common Issues

### Clippy not found

```
Warning: No rust linter available for rust files
  Install: rustup component add clippy
```

**Solution**: Run `rustup component add clippy`

### Slow first run

Clippy compiles your project on first run. Subsequent runs use incremental compilation.

### Conflicting with project clippy config

linthis uses the same clippy configuration as `cargo clippy`. Your project's `clippy.toml` settings are respected.

## Best Practices

1. **Use workspace-level config**: Place `.linthis/config.toml` at workspace root
2. **CI integration**: Run `linthis -c --lang rust` in CI for consistent checks
3. **Complexity limits**: Set `max_complexity = 15` for maintainable code
4. **Unwrap handling**: Consider treating `clippy::unwrap_used` as error in production code