gobject-linter 0.1.2

A fast tree-sitter-based linter for GObject/C code
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

use std::{
    hash::{DefaultHasher, Hash, Hasher},
    path::Path,
};

use serde_json::json;

use crate::{
    config::RuleLevel,
    rules::{Category, Violation},
};

pub fn generate_gitlab_codequality(violations: &[Violation], project_root: &Path) -> String {
    let issues = violations
        .iter()
        .map(|v| generate_issue(v, project_root))
        .collect::<Vec<_>>();

    serde_json::to_string_pretty(&issues).unwrap()
}

/// Generate a unique fingerprint to identify a violation.
fn geneerate_issue_fingerprint(violation: &Violation, relative_path: &str) -> String {
    let mut hasher = DefaultHasher::new();

    violation.rule.hash(&mut hasher);
    relative_path.hash(&mut hasher);
    violation.line.hash(&mut hasher);
    violation.column.hash(&mut hasher);

    hasher.finish().to_string()
}

/// Generate a Gitlab CodeQuality issue report
/// The format is very similar to CodeClimate reports
/// https://docs.gitlab.com/ci/testing/code_quality/#code-quality-report-format
fn generate_issue(violation: &Violation, project_root: &Path) -> serde_json::Value {
    // Make file path relative to project root for Gitlab CodeQuality
    let relative_path = violation
        .file
        .strip_prefix(project_root)
        .unwrap_or(&violation.file)
        .display()
        .to_string();

    let location = json!({
        "path": relative_path,
        "positions": {
            "begin": {
                "line": violation.line,
                "column": violation.column
            }
        },
    });

    json!({
        "description": violation.message,
        "check_name": violation.rule,
        "fingerprint": geneerate_issue_fingerprint(violation, &relative_path),
        "severity": rule_level_to_codequality_severity(violation),
        "categories": [violation.category],
        "location": location,
    })
}

// The severity of the violation, can be one of info, minor, major, critical, or
// blocker.
fn rule_level_to_codequality_severity(violation: &Violation) -> &'static str {
    match (violation.level, violation.category) {
        (RuleLevel::Error, _) => "blocker",
        // Bump Correctness and Perf to critical if they are warnings
        // Only matters for how its displayed in Gitlab.
        (RuleLevel::Warn, Category::Correctness) => "critical",
        (RuleLevel::Warn, Category::Perf) => "critical",
        (RuleLevel::Warn, _) => "info",
        (RuleLevel::Ignore, _) => {
            unreachable!("Ignored violations should not be reported")
        }
    }
}