诊断与检查

use openidea_plugin::{Diagnostic, Range, Severity};

let d = Diagnostic::new(range, Severity::Warning, "Line is longer than 100 characters").code("LineLength");

activation = ["on-event:file-saved", "on-command:*"]

[capabilities]
required = ["project.read", "events", "storage", "process:checkstyle"]

[[contributes.providers]]
kinds = ["code-actions"]
languages = ["java"]

fn check(&mut self, path: &str) -> Result<usize, Error> {
    let project = host::project_of(path).ok_or_else(|| Error::NotFound(path.into()))?;
    let task = host::begin_task("Checkstyle", true);
    let args = vec!["-f".to_owned(), "xml".into(), "-c".into(), "/google_checks.xml".into(), path.to_owned()];
    let out = project.run_process("checkstyle", &args, None)?;
    if task.is_cancelled() {
        return Err(Error::Cancelled);
    }
    let problems = parse_report(&out.stdout);
    let text = project.read_file(path)?;
    let diagnostics: Vec<Diagnostic> = problems.iter().map(|p| diagnostic(p, &text)).collect();
    host::publish_diagnostics(path, &diagnostics)?;
    self.problems.insert(path.to_owned(), problems); // 留给快速修复使用
    Ok(diagnostics.len())
}

engines.openidea = "^1.3"

[[contributes.providers]]
kinds = ["diagnostics"]
languages = ["text", "plaintext"]   # "*" 匹配任意语言

use openidea_plugin::diagnostics::{DiagnosticsProvider, Document};
use openidea_plugin::{Diagnostic, Range, Severity, register_plugin, text};

impl DiagnosticsProvider for MyPlugin {
    fn diagnostics(&mut self, doc: &Document) -> Vec<Diagnostic> {
        doc.text
            .match_indices("BAD")
            .map(|(offset, _)| {
                let range = Range { start: text::position(&doc.text, offset), end: text::position(&doc.text, offset + 3) };
                Diagnostic::new(range, Severity::Warning, "Avoid BAD").code("bad-word")
            })
            .collect()
    }
}

register_plugin!(MyPlugin, diagnostics);

use openidea_plugin::providers::{CodeAction, Document, Providers};
use openidea_plugin::{Position, Range, TextEdit};

impl Providers for Checkstyle {
    fn code_actions(&mut self, doc: &Document, selection: Range) -> Vec<CodeAction> {
        let Some(problems) = self.problems.get(&doc.path) else { return vec![] };
        let lines: Vec<&str> = doc.text.split('\n').collect();
        problems
            .iter()
            .filter(|p| p.check == "FileTabCharacter" && (selection.start.line..=selection.end.line).contains(&p.line))
            .filter_map(|p| {
                let line = lines.get(p.line as usize)?;
                let whole = Range::new(Position::new(p.line, 0), Position::new(p.line, line.encode_utf16().count() as u32));
                Some(CodeAction {
                    title: "Checkstyle: Replace tabs with spaces".into(),
                    kind: Some("quickfix".into()),
                    preferred: true,
                    edits: vec![(doc.path.clone(), vec![TextEdit { range: whole, text: line.replace('\t', "    ") }])],
                    data: None,
                })
            })
            .collect()
    }
}

use openidea_plugin::mock::MockHost;

let mock = MockHost::install();
mock.open_editor("/project/a.txt", "text", "a BAD word", &[]);
mock.refresh_diagnostics(&mut MyPlugin::default());
assert_eq!(mock.provider_diagnostics()["/project/a.txt"][0].code.as_deref(), Some("bad-word"));