slopguard-core 0.1.26

Core analysis engine for slopguard
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

//! Shared fixtures for the scanner test modules.

use std::path::Path;

use crate::config::Config;
use crate::finding::ScanResult;
use crate::rule::{parse_rule, Rule};

use super::scan;

pub(super) fn unwrap_rule() -> Rule {
    parse_rule(
        r#"
id: test-unwrap
language: rust
severity: error
category: correctness
message: ".unwrap() forbidden"
rule:
  kind: call_expression
  regex: '\.unwrap\(\)\s*$'
"#,
    )
    .unwrap()
}

pub(super) fn unwrap_rule_skipping_test_code() -> Rule {
    parse_rule(
        r#"
id: test-unwrap
language: rust
severity: error
category: correctness
message: ".unwrap() forbidden"
rule:
  kind: call_expression
  regex: '\.unwrap\(\)\s*$'
skip_test_code: true
"#,
    )
    .unwrap()
}

pub(super) fn metric_rule(body: &str) -> Rule {
    parse_rule(body).unwrap()
}

pub(super) fn file_lines_rule() -> Rule {
    metric_rule(
        r#"
id: test-file-lines
language: rust
severity: warning
category: slop
metric: file_lines
threshold: 10
message: "File is too long"
"#,
    )
}

pub(super) fn single_impl_trait_rule() -> Rule {
    parse_rule(
        r#"
id: no-single-impl-trait
language: rust
severity: warning
category: slop
cross_file: single_impl_trait
message: "Trait with a single implementation in the project."
skip_test_code: true
"#,
    )
    .unwrap()
}

/// `n` lines of trivial Rust, one comment per line.
pub(super) fn rust_lines(n: usize) -> String {
    (0..n).map(|i| format!("// line {i}\n")).collect()
}

pub(super) fn scan_dir(dir: &Path, rules: &[Rule]) -> ScanResult {
    scan(&[dir.to_path_buf()], rules, &Config::default()).unwrap()
}