Views and decorations

[[contributes.views]]
id = "todos"
title = "TODO Example"
icon = "search"            # an IDE icon name (up to 64 bytes) or a package SVG
location = "right"         # left, right (default), bottom, services

engines.openidea = "^1.3"

[[contributes.views]]
id = "endpoints"
title = "Spring"
group = "spring"
when = "workspaceContains:pom.xml || workspaceContains:build.gradle"

[[contributes.views]]
id = "beans"
title = "Beans"
group = "spring"
when = "plugin.my-plugin.ready"

use openidea_plugin::views::{Body, ListItem, View, ViewEvent, Viewport, Views};
use openidea_plugin::{Error, Invocation, Location, TextQuery, host, register_plugin};

fn query() -> TextQuery {
    TextQuery { pattern: "TODO".into(), case_sensitive: true, ..Default::default() }
}

impl Views for TodoFinder {
    fn render(&mut self, _view: &str, _viewport: Option<Viewport>, ctx: &Invocation) -> Result<View, Error> {
        let found = ctx.project().ok_or("Open a project first")?.search_text(&query(), 500)?;
        let items = found
            .matches
            .into_iter()
            .map(|m| {
                let detail = format!("{}:{}", m.location.path, m.location.range.start.line + 1);
                ListItem::new(&serde_json::to_string(&m.location).unwrap(), &m.line).detail(&detail)
            })
            .collect();
        Ok(View {
            toolbar: vec![],
            body: Body::List(items),
            status: found.limit_hit.then(|| "Showing the first 500 matches".into()),
        })
    }

    fn handle(&mut self, _view: &str, event: ViewEvent, _ctx: &Invocation) -> Result<(), Error> {
        if let ViewEvent::Activate(key) = event {
            let location: Location = serde_json::from_str(&key).map_err(|e| Error::Invalid(e.to_string()))?;
            host::open_location(&location.path, location.range.start.line, location.range.start.character)?;
        }
        Ok(())
    }
}

register_plugin!(TodoFinder, views);

[[contributes.customEditors]]
id = "table"
title = "Table"
patterns = ["*.csv", "*.tsv"]   # 1–16 file name globs, no directories
priority = "default"            # or "option": only through Open With
layout = "tab"                  # or "split" / "preview": beside the text editor
# web = "web/index.html"        # a web page instead of rendered content

fn handle(&mut self, _view: &str, event: ViewEvent, ctx: &Invocation) -> Result<(), Error> {
    let editor = ctx.editor().ok_or_else(|| Error::Invalid("the table editor needs a document".into()))?;
    let doc = editor.document()?;
    let edits = edits_for(&doc.text, &event)?;
    if !edits.is_empty() {
        // Stale if the user typed in the text view meanwhile; the table renders again.
        editor.apply_edits(doc.version, &edits)?;
    }
    Ok(())
}

[[contributes.customEditors]]
id = "preview"
title = "Preview"
patterns = ["*.dot", "*.gv"]
layout = "split"
web = "web/index.html"   # the page; its directory is what it can load

.toolbar {
  min-height: var(--openidea-corner-inset-height, 0px);
  padding-right: var(--openidea-corner-inset-width, 0px);
}

engines.openidea = "^1.3"

[[contributes.views]]
id = "kube"
title = "Kubernetes"
icon = "icons/kubernetes.svg"
location = "services"

[capabilities]
optional = ["process:kubectl"]

use openidea_plugin::details::{Details, Pane, ProcessLog, Tab};

impl Details for MyPlugin {
    fn detail(&mut self, _view: &str, key: &str, _ctx: &Invocation) -> Result<Vec<Tab>, Error> {
        let pod = key.trim_start_matches("pod:");
        let log = ProcessLog::new("kubectl", &["logs", "-f", "--tail=1000", pod])
            .toggle("ts", "Timestamps", &["--timestamps"]);
        Ok(vec![Tab::new("log", "Log", log), Tab::new("inspect", "Inspect", Pane::Text(self.describe(pod)?))])
    }
}

use openidea_plugin::{ContentAction, ContentTab, host};

host::open_content_tab(&ContentTab {
    key: "service-config".into(),
    title: "service.toml".into(),
    file_name: Some("service.toml".into()),
    language: Some("toml".into()),
    content: "name = \"demo\"\n".into(),
    read_only: false,
    actions: vec![ContentAction { id: "save".into(), label: "Apply".into(), primary: true, save: true, ..Default::default() }],
})?;

use openidea_plugin::{Decoration, FileDecoration, Position, Range, host};

let at = Position::new(3, 20);
host::set_decorations(&path, "blame", &[Decoration {
    range: Range::new(at, at),
    style: "muted".into(),
    hover: Some("Fix the parser".into()),
    after: Some("  Ada · 1a2b3c4d".into()),   // plain text shown after the range
}])?;

host::set_file_decoration(&path, "status", &FileDecoration {
    badge: Some("M".into()),                  // at most two characters
    style: "modified".into(),
    tooltip: Some("Changed by the tool".into()),
})?;