mirror of
https://github.com/l0ng-ai/openidea.git
synced 2026-11-08 08:52:12 +00:00
Pedro Pessoa
8259a81335
Plugin API 1.3 adds an optional semantic-tokens-provider export (world plugin-semantic-tokens). A plugin declares the semantic-tokens kind under [[contributes.providers]] for any language, including ones it does not contribute, and returns single-line tokens with LSP token kinds and modifiers. The host asks it with the other editor providers (50 ms / 500 ms) when the editor requests semantic tokens and joins the result with the language server's: plugin tokens replace the server tokens they overlap, so the colour scheme styles them like any semantic token. Declaring the kind needs engines.openidea ^1.3. API 1.2 shipped with 0.1.38, so wit/ and the SDK's copy, ENGINE_VERSION and both API_VERSION constants move to 1.3 and every shipped component is rebuilt. The SDK gains openidea_plugin::semantic_tokens, and register_plugin! accepts any combination of optional exports (providers, views, indexing, syntax, semantic_tokens) instead of a fixed list of pairs.
57 lines
2.4 KiB
Rust
57 lines
2.4 KiB
Rust
use ide_host::plugins::{Consent, PluginHost};
|
|
use ide_plugin::{Limits, ProviderDocument};
|
|
use std::path::{Path, PathBuf};
|
|
use std::sync::Arc;
|
|
use std::time::Duration;
|
|
|
|
fn fixture_dir() -> PathBuf {
|
|
Path::new(env!("CARGO_MANIFEST_DIR")).join("../ide-plugin/tests/fixtures/semantic-tokens")
|
|
}
|
|
|
|
fn host(dir: &Path) -> PluginHost {
|
|
let limits = Limits { edit_soft: Duration::from_secs(5), edit_hard: Duration::from_secs(10), ..Limits::default() };
|
|
PluginHost::new(dir.join("plugins"), Arc::new(|_: Option<&str>, _| {}), limits).unwrap()
|
|
}
|
|
|
|
fn doc(dir: &Path, language: &str, text: &str) -> ProviderDocument {
|
|
ProviderDocument { path: dir.join("Order.php"), language: language.into(), version: 1, text: text.into() }
|
|
}
|
|
|
|
const ORDER: &str =
|
|
"<?php\nclass Order\n{\n public function user() {}\n}\n$order->user;\n$order->total;\n$order->user();\n";
|
|
|
|
#[test]
|
|
fn relation_accesses_and_columns_get_their_own_kinds() {
|
|
let tmp = tempfile::tempdir().unwrap();
|
|
let host = host(tmp.path());
|
|
host.install_from_dir(&fixture_dir(), &Consent::all()).unwrap();
|
|
let tokens = host.provide_semantic_tokens(&doc(tmp.path(), "php", ORDER));
|
|
let found: Vec<_> = tokens
|
|
.iter()
|
|
.map(|t| (t.range.start.line, t.range.start.col, t.range.end.line, t.range.end.col, t.kind.as_str()))
|
|
.collect();
|
|
assert_eq!(found, [(5, 8, 5, 12, "method"), (6, 8, 6, 13, "property")]);
|
|
assert!(tokens.iter().all(|t| t.modifiers.is_empty()));
|
|
}
|
|
|
|
#[test]
|
|
fn only_declared_languages_are_asked() {
|
|
let tmp = tempfile::tempdir().unwrap();
|
|
let host = host(tmp.path());
|
|
host.install_from_dir(&fixture_dir(), &Consent::all()).unwrap();
|
|
assert!(host.provide_semantic_tokens(&doc(tmp.path(), "javascript", "a->b")).is_empty());
|
|
}
|
|
|
|
#[test]
|
|
fn the_kind_needs_plugin_api_1_3() {
|
|
let tmp = tempfile::tempdir().unwrap();
|
|
let host = host(tmp.path());
|
|
let pkg = tmp.path().join("old");
|
|
std::fs::create_dir_all(pkg.join("dist")).unwrap();
|
|
std::fs::copy(fixture_dir().join("dist/plugin.wasm"), pkg.join("dist/plugin.wasm")).unwrap();
|
|
let manifest = std::fs::read_to_string(fixture_dir().join("plugin.toml")).unwrap();
|
|
std::fs::write(pkg.join("plugin.toml"), manifest.replace("\"^1.3\"", "\"^1.0\"")).unwrap();
|
|
let err = host.install_from_dir(&pkg, &Consent::all()).unwrap_err();
|
|
assert!(err.message.contains("new in plugin API 1.3"), "{}", err.message);
|
|
}
|