oak-powershell 0.0.11

PowerShell script parser with support for modern PowerShell syntax and cmdlets.
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

#![doc = include_str!("readme.md")]
#[cfg(feature = "oak-highlight")]
pub mod highlighter;

use crate::{PowerShellElementType, PowerShellLanguage};
use core::range::Range;
use oak_core::tree::RedNode;
#[cfg(feature = "lsp")]
use {
    oak_hover::{Hover as ProviderHover, HoverProvider},
    oak_lsp::{service::LanguageService, types::Hover as LspHover},
    oak_vfs::Vfs,
};
/// Hover provider implementation for PowerShell.
#[cfg(feature = "lsp")]
pub struct PowerShellHoverProvider;
#[cfg(feature = "lsp")]
impl HoverProvider<PowerShellLanguage> for PowerShellHoverProvider {
    fn hover(&self, node: &RedNode<PowerShellLanguage>, _range: Range<usize>) -> Option<ProviderHover> {
        let kind = node.green.kind;
        let contents = match kind {
            PowerShellElementType::FunctionDef => "### PowerShell Function\nA named block of code that performs a specific task.",
            PowerShellElementType::ClassDef => "### PowerShell Class\nA blueprint for creating objects in PowerShell.",
            PowerShellElementType::IfStatement => "### PowerShell If Statement\nA conditional statement that executes a block of code if a condition is true.",
            _ => return None,
        };
        Some(ProviderHover { contents: contents.to_string(), range: Some(node.span()) })
    }
}
/// Language service implementation for PowerShell.
#[cfg(feature = "lsp")]
pub struct PowerShellLanguageService<V: Vfs> {
    /// The virtual file system.
    pub vfs: V,
    /// The workspace manager.
    pub workspace: oak_lsp::workspace::WorkspaceManager,
    /// The hover provider.
    pub hover_provider: PowerShellHoverProvider,
}

#[cfg(feature = "lsp")]
impl<V: Vfs> PowerShellLanguageService<V> {
    /// Creates a new `PowerShellLanguageService`.
    pub fn new(vfs: V) -> Self {
        Self { vfs, workspace: oak_lsp::workspace::WorkspaceManager::default(), hover_provider: PowerShellHoverProvider }
    }
}
impl<V: Vfs + Send + Sync + 'static + oak_vfs::WritableVfs> LanguageService for PowerShellLanguageService<V> {
    type Lang = PowerShellLanguage;
    type Vfs = V;
    fn vfs(&self) -> &Self::Vfs {
        &self.vfs
    }
    fn workspace(&self) -> &oak_lsp::workspace::WorkspaceManager {
        &self.workspace
    }
    fn get_root(&self, _uri: &str) -> impl futures::Future<Output = Option<RedNode<'_, PowerShellLanguage>>> + Send + '_ {
        async move {
            // TODO: Implement proper caching of parsed trees in LanguageService
            None
        }
    }
    fn hover(&self, uri: &str, range: Range<usize>) -> impl futures::Future<Output = Option<LspHover>> + Send + '_ {
        let uri = uri.to_string();
        async move { self.with_root(&uri, |root| self.hover_provider.hover(&root, range).map(|h| LspHover { contents: h.contents, range: h.range })).await.flatten() }
    }
}