jsslint-core 1.0.0

Core rule engine for the JSS style checker (spec 018 Rust port).
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

//! Shared tex-rule infrastructure — spec 018 Phase 3. Ports
//! `_helpers.py`'s `make_violation` / `tex_violation` / `_lineno_col`
//! factories (the tex-side counterparts of `entry_violation` in
//! `rules::mod`).

use crate::catalogue;
use crate::report::{Fix, Violation};
use crate::tex::position::LineIndex;

/// Generic catalogue-backed violation: severity/message come from the
/// rule's catalogue entry; the caller supplies position. Mirrors
/// `_helpers.py::make_violation`.
pub fn make_violation(
    file: &str,
    line: u32,
    column: Option<u32>,
    rule_id: &str,
    suggestion: Option<String>,
    fix: Option<Fix>,
) -> Violation {
    let meta = catalogue::lookup(rule_id).unwrap_or_else(|| panic!("unknown rule_id {rule_id}"));
    Violation {
        file: file.to_string(),
        line,
        column,
        rule_id: rule_id.to_string(),
        severity: meta.severity,
        message: meta.message_template.to_string(),
        suggestion,
        fix,
    }
}

/// `(1-based line, 1-based column)` at a codepoint position — mirrors
/// `_helpers.py::_lineno_col` (`walker.pos_to_lineno_colno` + 1 on the
/// 0-based column it returns).
pub fn lineno_col(line_index: &LineIndex, pos: usize) -> (u32, u32) {
    let (line, col0) = line_index.lineno_colno(pos);
    (line, col0 + 1)
}

/// A violation anchored to a source position inside a parsed tex-like
/// file. Mirrors `_helpers.py::tex_violation`.
pub fn tex_violation(
    file: &str,
    line_index: &LineIndex,
    pos: usize,
    rule_id: &str,
    suggestion: Option<String>,
) -> Violation {
    tex_violation_with_fix(file, line_index, pos, rule_id, suggestion, None)
}

pub fn tex_violation_with_fix(
    file: &str,
    line_index: &LineIndex,
    pos: usize,
    rule_id: &str,
    suggestion: Option<String>,
    fix: Option<Fix>,
) -> Violation {
    let (line, column) = lineno_col(line_index, pos);
    make_violation(file, line, Some(column), rule_id, suggestion, fix)
}