linthis 0.17.2

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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
// Copyright 2024 zhlinh and linthis Project Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found at
//
// https://opensource.org/license/MIT
//
// The above copyright notice and this permission
// notice shall be included in all copies or
// substantial portions of the Software.

//! Format presets for different coding standards.
//!
//! Presets define formatting and linting rules based on popular style guides:
//! - Google: Google's coding standards
//! - Standard: Community standard (e.g., StandardJS for JS)
//! - Airbnb: Airbnb's style guide

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Available format presets
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum PresetName {
    /// Google style guide
    Google,
    /// Community standard style
    Standard,
    /// Airbnb style guide
    Airbnb,
}

impl PresetName {
    /// Parse preset name from string
    pub fn parse(s: &str) -> Option<Self> {
        match s.to_lowercase().as_str() {
            "google" => Some(PresetName::Google),
            "standard" => Some(PresetName::Standard),
            "airbnb" => Some(PresetName::Airbnb),
            _ => None,
        }
    }

    /// Get the preset name as a string
    pub fn as_str(&self) -> &'static str {
        match self {
            PresetName::Google => "google",
            PresetName::Standard => "standard",
            PresetName::Airbnb => "airbnb",
        }
    }

    /// List all available presets
    pub fn all() -> &'static [PresetName] {
        &[PresetName::Google, PresetName::Standard, PresetName::Airbnb]
    }
}

/// Format rules for a specific language
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct LanguageRules {
    /// Indentation style ("tabs" or number of spaces)
    #[serde(default)]
    pub indent: Option<IndentStyle>,
    /// Maximum line length
    #[serde(default)]
    pub max_line_length: Option<usize>,
    /// Use semicolons (for JS/TS)
    #[serde(default)]
    pub semicolons: Option<bool>,
    /// Quote style ("single" or "double")
    #[serde(default)]
    pub quotes: Option<QuoteStyle>,
    /// Trailing commas ("none", "es5", "all")
    #[serde(default)]
    pub trailing_commas: Option<TrailingCommaStyle>,
    /// Additional linter rules to enable
    #[serde(default)]
    pub enable_rules: Vec<String>,
    /// Linter rules to disable
    #[serde(default)]
    pub disable_rules: Vec<String>,
}

/// Indentation style
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum IndentStyle {
    Tabs,
    Spaces(u8),
}

impl Default for IndentStyle {
    fn default() -> Self {
        IndentStyle::Spaces(4)
    }
}

/// Quote style for strings
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum QuoteStyle {
    Single,
    #[default]
    Double,
}

/// Trailing comma style
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum TrailingCommaStyle {
    #[default]
    None,
    Es5,
    All,
}

/// A complete format preset
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Preset {
    /// Preset name
    pub name: String,
    /// Description
    pub description: String,
    /// Per-language rules
    #[serde(default)]
    pub languages: HashMap<String, LanguageRules>,
}

impl Preset {
    /// Get the Google preset
    pub fn google() -> Self {
        let mut languages = HashMap::new();

        // JavaScript/TypeScript rules
        languages.insert(
            "javascript".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Spaces(2)),
                max_line_length: Some(80),
                semicolons: Some(true),
                quotes: Some(QuoteStyle::Single),
                trailing_commas: Some(TrailingCommaStyle::Es5),
                ..Default::default()
            },
        );

        languages.insert(
            "typescript".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Spaces(2)),
                max_line_length: Some(80),
                semicolons: Some(true),
                quotes: Some(QuoteStyle::Single),
                trailing_commas: Some(TrailingCommaStyle::Es5),
                ..Default::default()
            },
        );

        // Python rules
        languages.insert(
            "python".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Spaces(4)),
                max_line_length: Some(80),
                ..Default::default()
            },
        );

        // C++ rules
        languages.insert(
            "cpp".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Spaces(2)),
                max_line_length: Some(80),
                ..Default::default()
            },
        );

        // Java rules
        languages.insert(
            "java".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Spaces(2)),
                max_line_length: Some(100),
                ..Default::default()
            },
        );

        // Go rules
        languages.insert(
            "go".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Tabs),
                max_line_length: None, // Go doesn't enforce line length
                ..Default::default()
            },
        );

        // Rust rules
        languages.insert(
            "rust".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Spaces(4)),
                max_line_length: Some(100),
                ..Default::default()
            },
        );

        Preset {
            name: "google".to_string(),
            description: "Google's coding standards".to_string(),
            languages,
        }
    }

    /// Get the Standard preset (community standards)
    pub fn standard() -> Self {
        let mut languages = HashMap::new();

        // JavaScript/TypeScript rules (StandardJS)
        languages.insert(
            "javascript".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Spaces(2)),
                max_line_length: None,
                semicolons: Some(false), // StandardJS: no semicolons
                quotes: Some(QuoteStyle::Single),
                trailing_commas: Some(TrailingCommaStyle::None),
                ..Default::default()
            },
        );

        languages.insert(
            "typescript".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Spaces(2)),
                max_line_length: None,
                semicolons: Some(false),
                quotes: Some(QuoteStyle::Single),
                trailing_commas: Some(TrailingCommaStyle::None),
                ..Default::default()
            },
        );

        // Python rules (PEP 8)
        languages.insert(
            "python".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Spaces(4)),
                max_line_length: Some(79),
                ..Default::default()
            },
        );

        // C++ rules
        languages.insert(
            "cpp".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Spaces(4)),
                max_line_length: Some(120),
                ..Default::default()
            },
        );

        // Go rules (standard gofmt)
        languages.insert(
            "go".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Tabs),
                max_line_length: None,
                ..Default::default()
            },
        );

        // Rust rules (standard rustfmt)
        languages.insert(
            "rust".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Spaces(4)),
                max_line_length: Some(100),
                ..Default::default()
            },
        );

        Preset {
            name: "standard".to_string(),
            description: "Community standard styles (PEP 8, StandardJS, etc.)".to_string(),
            languages,
        }
    }

    /// Get the Airbnb preset
    pub fn airbnb() -> Self {
        let mut languages = HashMap::new();

        // JavaScript/TypeScript rules (Airbnb style)
        languages.insert(
            "javascript".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Spaces(2)),
                max_line_length: Some(100),
                semicolons: Some(true),
                quotes: Some(QuoteStyle::Single),
                trailing_commas: Some(TrailingCommaStyle::All),
                ..Default::default()
            },
        );

        languages.insert(
            "typescript".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Spaces(2)),
                max_line_length: Some(100),
                semicolons: Some(true),
                quotes: Some(QuoteStyle::Single),
                trailing_commas: Some(TrailingCommaStyle::All),
                ..Default::default()
            },
        );

        // Python rules
        languages.insert(
            "python".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Spaces(4)),
                max_line_length: Some(100),
                ..Default::default()
            },
        );

        // Go rules
        languages.insert(
            "go".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Tabs),
                max_line_length: Some(120),
                ..Default::default()
            },
        );

        // Rust rules
        languages.insert(
            "rust".to_string(),
            LanguageRules {
                indent: Some(IndentStyle::Spaces(4)),
                max_line_length: Some(100),
                ..Default::default()
            },
        );

        Preset {
            name: "airbnb".to_string(),
            description: "Airbnb's style guide".to_string(),
            languages,
        }
    }

    /// Load a preset by name
    pub fn load(name: PresetName) -> Self {
        match name {
            PresetName::Google => Self::google(),
            PresetName::Standard => Self::standard(),
            PresetName::Airbnb => Self::airbnb(),
        }
    }

    /// Get rules for a specific language
    pub fn get_language_rules(&self, language: &str) -> Option<&LanguageRules> {
        self.languages.get(language)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_preset_name_parse() {
        assert_eq!(PresetName::parse("google"), Some(PresetName::Google));
        assert_eq!(PresetName::parse("GOOGLE"), Some(PresetName::Google));
        assert_eq!(PresetName::parse("standard"), Some(PresetName::Standard));
        assert_eq!(PresetName::parse("airbnb"), Some(PresetName::Airbnb));
        assert_eq!(PresetName::parse("unknown"), None);
    }

    #[test]
    fn test_google_preset() {
        let preset = Preset::google();
        assert_eq!(preset.name, "google");

        let js_rules = preset.get_language_rules("javascript").unwrap();
        assert_eq!(js_rules.indent, Some(IndentStyle::Spaces(2)));
        assert_eq!(js_rules.semicolons, Some(true));
    }

    #[test]
    fn test_standard_preset() {
        let preset = Preset::standard();
        assert_eq!(preset.name, "standard");

        let js_rules = preset.get_language_rules("javascript").unwrap();
        assert_eq!(js_rules.semicolons, Some(false)); // StandardJS has no semicolons
    }

    #[test]
    fn test_airbnb_preset() {
        let preset = Preset::airbnb();
        assert_eq!(preset.name, "airbnb");

        let js_rules = preset.get_language_rules("javascript").unwrap();
        assert_eq!(js_rules.trailing_commas, Some(TrailingCommaStyle::All));
    }
}