Skip to main content

oak_powershell/lsp/
mod.rs

1#![doc = include_str!("readme.md")]
2#[cfg(feature = "oak-highlight")]
3pub mod highlighter;
4
5use crate::{PowerShellElementType, PowerShellLanguage};
6use core::range::Range;
7use oak_core::tree::RedNode;
8#[cfg(feature = "lsp")]
9use {
10    oak_hover::{Hover as ProviderHover, HoverProvider},
11    oak_lsp::{service::LanguageService, types::Hover as LspHover},
12    oak_vfs::Vfs,
13};
14/// Hover provider implementation for PowerShell.
15#[cfg(feature = "lsp")]
16pub struct PowerShellHoverProvider;
17#[cfg(feature = "lsp")]
18impl HoverProvider<PowerShellLanguage> for PowerShellHoverProvider {
19    fn hover(&self, node: &RedNode<PowerShellLanguage>, _range: Range<usize>) -> Option<ProviderHover> {
20        let kind = node.green.kind;
21        let contents = match kind {
22            PowerShellElementType::FunctionDef => "### PowerShell Function\nA named block of code that performs a specific task.",
23            PowerShellElementType::ClassDef => "### PowerShell Class\nA blueprint for creating objects in PowerShell.",
24            PowerShellElementType::IfStatement => "### PowerShell If Statement\nA conditional statement that executes a block of code if a condition is true.",
25            _ => return None,
26        };
27        Some(ProviderHover { contents: contents.to_string(), range: Some(node.span()) })
28    }
29}
30/// Language service implementation for PowerShell.
31#[cfg(feature = "lsp")]
32pub struct PowerShellLanguageService<V: Vfs> {
33    /// The virtual file system.
34    pub vfs: V,
35    /// The workspace manager.
36    pub workspace: oak_lsp::workspace::WorkspaceManager,
37    /// The hover provider.
38    pub hover_provider: PowerShellHoverProvider,
39}
40
41#[cfg(feature = "lsp")]
42impl<V: Vfs> PowerShellLanguageService<V> {
43    /// Creates a new `PowerShellLanguageService`.
44    pub fn new(vfs: V) -> Self {
45        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: PowerShellHoverProvider }
46    }
47}
48impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for PowerShellLanguageService<V> {
49    type Lang = PowerShellLanguage;
50    type Vfs = V;
51    fn vfs(&self) -> &Self::Vfs {
52        &self.vfs
53    }
54    fn workspace(&self) -> &oak_lsp::workspace::WorkspaceManager {
55        &self.workspace
56    }
57    fn get_root(&self, _uri: &str) -> impl futures::Future<Output = Option<RedNode<'_, PowerShellLanguage>>> + Send + '_ {
58        async move {
59            // TODO: Implement proper caching of parsed trees in LanguageService
60            None
61        }
62    }
63    fn hover(&self, uri: &str, range: Range<usize>) -> impl futures::Future<Output = Option<LspHover>> + Send + '_ {
64        let uri = uri.to_string();
65        async move { self.with_root(&uri, |root| self.hover_provider.hover(&root, range).map(|h| LspHover { contents: h.contents, range: h.range })).await.flatten() }
66    }
67}