kcl-lib 0.2.185

KittyCAD Language implementation and tools
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

use anyhow::Result;

use crate::SourceRange;
use crate::lint::rule::Discovered;
use crate::lint::rule::Finding;
use crate::lint::rule::FindingFamily;
use crate::lint::rule::def_finding;
use crate::parsing::ast::types::Node as AstNode;
use crate::parsing::ast::types::Program;
use crate::walk::Node;

def_finding!(
    Z0007,
    "Legacy angle constraint can be converted to angleDimension",
    "The angle function does not identify a directed angle sector. Convert it to angleDimension to preserve the currently solved sector explicitly.",
    FindingFamily::Simplify
);

pub fn lint_legacy_angle(node: Node, _prog: &AstNode<Program>) -> Result<Vec<Discovered>> {
    let Node::CallExpressionKw(call) = node else {
        return Ok(vec![]);
    };
    if call.callee.name.name != "angle" || call.unlabeled.is_none() {
        return Ok(vec![]);
    }

    let source_range = SourceRange::new(call.start, call.end, call.module_id);
    Ok(vec![Z0007.at(
        "angle can be converted to an explicit angleDimension sector".to_owned(),
        source_range,
        None,
    )])
}

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

    #[test]
    fn finds_legacy_angle_calls() {
        let program = crate::Program::parse_no_errs("sketch(on = XY) { angle([line1, line2]) == 60deg }").unwrap();
        let findings = program.lint(lint_legacy_angle).unwrap();
        assert_eq!(findings.len(), 1);
        assert_eq!(findings[0].finding.code, Z0007.code);
    }

    #[test]
    fn ignores_angle_dimension_calls() {
        let program = crate::Program::parse_no_errs(
            "sketch(on = XY) { angleDimension(lines = [line1, line2], sector = 1) == 60deg }",
        )
        .unwrap();
        assert!(program.lint(lint_legacy_angle).unwrap().is_empty());
    }
}