masmlint 0.1.1

A linter for Miden Assembly
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

use std::sync::Arc;

use miden_assembly::{SourceFile, SourceSpan, ast::Instruction};
use miette::Diagnostic;

#[derive(Debug, thiserror::Error, Diagnostic)]
pub enum LintError {
    #[error("operand is pushed before an instruction that can take an immediate value")]
    #[diagnostic(help("use the instruction in its immediate form `{alternative}`"))]
    PushImmediate {
        #[label("instruction can be rewritten to take the immediate directly")]
        span: SourceSpan,
        alternative: String,
        #[source_code]
        source_file: Arc<SourceFile>,
    },
    #[error("assert without error message")]
    #[diagnostic(help(
        "use the instruction with a helpful error message, e.g. `{assert_with_error}`"
    ))]
    BareAssert {
        #[label("does not include an error message")]
        span: SourceSpan,
        assert_with_error: Instruction,
        #[source_code]
        source_file: Arc<SourceFile>,
    },
}

#[derive(Debug, thiserror::Error, Diagnostic)]
#[error("one or more lints failed")]
pub struct LinterError {
    #[related]
    errors: Vec<LintError>,
    // #[error("failed to select unknown lint `{0}`")]
    // UnknownSelectedLint(String),
    // #[error("failed to exclude unknown lint `{0}`")]
    // UnknownExcludedLint(String),
}

impl LinterError {
    pub fn new_lints(errors: Vec<LintError>) -> Self {
        Self { errors }
    }
}