mir-analyzer 0.18.0

Analysis engine for the mir PHP static analyzer
Documentation
use mir_codebase::storage::{Assertion, AssertionKind};
use mir_issues::{Issue, IssueKind};
use mir_types::Union;
use std::sync::Arc;

pub(super) fn build_assertions(
    doc: &crate::parser::ParsedDocblock,
    resolve_union_doc_fn: impl Fn(Union) -> Union,
) -> Vec<Assertion> {
    let mut assertions = Vec::new();
    assertions.extend(doc.assertions.iter().map(|(param, ty)| Assertion {
        kind: AssertionKind::Assert,
        param: Arc::from(param.as_str()),
        ty: resolve_union_doc_fn(ty.clone()),
    }));
    assertions.extend(doc.assertions_if_true.iter().map(|(param, ty)| Assertion {
        kind: AssertionKind::AssertIfTrue,
        param: Arc::from(param.as_str()),
        ty: resolve_union_doc_fn(ty.clone()),
    }));
    assertions.extend(doc.assertions_if_false.iter().map(|(param, ty)| Assertion {
        kind: AssertionKind::AssertIfFalse,
        param: Arc::from(param.as_str()),
        ty: resolve_union_doc_fn(ty.clone()),
    }));
    assertions
}

pub(super) fn emit_docblock_issues(
    doc: &crate::parser::ParsedDocblock,
    span_start: u32,
    php_version: Option<crate::php_version::PhpVersion>,
    file: Arc<str>,
    source_map: &php_rs_parser::source_map::SourceMap,
    issues: &mut mir_issues::IssueBuffer,
) {
    if php_version.is_some() || doc.invalid_annotations.is_empty() {
        return;
    }
    let lc = source_map.offset_to_line_col(span_start);
    let line = lc.line + 1;
    let suppressed = doc.suppressed_issues.iter().any(|s| s == "InvalidDocblock");
    for msg in &doc.invalid_annotations {
        let issue = Issue::new(
            IssueKind::InvalidDocblock {
                message: msg.clone(),
            },
            mir_issues::Location {
                file: file.clone(),
                line,
                line_end: line,
                col_start: 0,
                col_end: 0,
            },
        );
        issues.add(if suppressed { issue.suppress() } else { issue });
    }
}