ontocore-plugin 0.14.0

Plugin manifest discovery for OntoCore (v0.14 host foundation)
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

use ontocore_core::{
    validate_workspace_scope, Diagnostic, DiagnosticCode, DiagnosticSeverity, SourceLocation,
};
use serde::{Deserialize, Serialize};
use std::path::{Path, PathBuf};

/// JSON wire format returned by subprocess plugins on stdout.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct PluginOutput {
    #[serde(default)]
    pub diagnostics: Vec<PluginDiagnosticWire>,
    #[serde(default)]
    pub output_paths: Vec<String>,
    #[serde(default)]
    pub logs: Option<String>,
    #[serde(default)]
    pub exit_message: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PluginDiagnosticWire {
    pub code: String,
    pub severity: String,
    pub message: String,
    pub file: String,
    #[serde(default)]
    pub line: Option<u64>,
    #[serde(default)]
    pub column: Option<u64>,
    #[serde(default)]
    pub entity_iri: Option<String>,
}

impl PluginDiagnosticWire {
    pub fn into_diagnostic(self, plugin_id: &str, workspace: &Path) -> Diagnostic {
        let requested = PathBuf::from(&self.file);
        let (file, message) = match validate_workspace_scope(&requested, workspace) {
            Ok(file) => (file, self.message),
            Err(err) => (
                workspace.to_path_buf(),
                format!(
                    "{} (rejected plugin diagnostic file path '{}': {})",
                    self.message, self.file, err
                ),
            ),
        };
        Diagnostic {
            code: DiagnosticCode::PluginViolation,
            severity: match self.severity.as_str() {
                "error" => DiagnosticSeverity::Error,
                "warning" => DiagnosticSeverity::Warning,
                _ => DiagnosticSeverity::Info,
            },
            message,
            file,
            range: SourceLocation {
                line: self.line,
                column: self.column,
                start_byte: None,
                end_byte: None,
            },
            entity_iri: self.entity_iri,
            quick_fix: None,
            plugin_id: Some(plugin_id.to_string()),
            plugin_code: Some(self.code),
        }
    }
}

pub fn plugin_diagnostic(
    plugin_id: &str,
    code: &str,
    severity: DiagnosticSeverity,
    message: impl Into<String>,
    file: PathBuf,
    entity_iri: Option<String>,
) -> Diagnostic {
    Diagnostic {
        code: DiagnosticCode::PluginViolation,
        severity,
        message: message.into(),
        file,
        range: SourceLocation::default(),
        entity_iri,
        quick_fix: None,
        plugin_id: Some(plugin_id.to_string()),
        plugin_code: Some(code.to_string()),
    }
}