html-languageservice 0.12.0

The basics of an HTML language server.
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use std::fmt::Debug;

use lazy_static::lazy_static;
use serde_json::{json, Value};

use super::{
    data_provider::{HTMLDataProvider, IHTMLDataProvider},
    web_custom_data::HTML_DATA_INSTANCE,
};

/// Provides tags, attributes, and attribute value and so on,
/// for completion proposals and hover information.
/// It has standard data built-in and can be customized
pub struct HTMLDataManager {
    data_providers: Vec<Box<dyn IHTMLDataProvider>>,
    case_sensitive: bool,
}

impl HTMLDataManager {
    pub(crate) fn new(
        use_default_data_provider: bool,
        custom_data_providers: Option<Vec<Box<dyn IHTMLDataProvider>>>,
        case_sensitive: bool,
    ) -> HTMLDataManager {
        let mut data_manager = HTMLDataManager {
            data_providers: vec![],
            case_sensitive,
        };
        data_manager.set_data_providers(
            use_default_data_provider,
            custom_data_providers.unwrap_or(vec![]),
        );
        data_manager
    }

    /// Set up a data provider, and the old data will be cleaned
    pub fn set_data_providers(
        &mut self,
        built_in: bool,
        mut providers: Vec<Box<dyn IHTMLDataProvider>>,
    ) {
        self.data_providers.clear();
        if built_in {
            self.data_providers.push(Box::new(HTMLDataProvider::new(
                "html5".to_string(),
                HTML_DATA_INSTANCE.clone(),
                self.case_sensitive,
            )));
        }
        self.data_providers.append(&mut providers);
    }

    pub fn get_data_providers(&self) -> &Vec<Box<dyn IHTMLDataProvider>> {
        &self.data_providers
    }

    /// Is the tag void element
    ///
    /// `void_elements` is from `get_void_elements`, and you should cache it to avoid duplicate void_elements generation
    pub fn is_void_element(&self, tag: &str, void_elements: &Vec<String>) -> bool {
        void_elements.contains(&tag.to_string())
    }

    /// Get `void_elements` from data_provider and you should cache it if you make sure it doesn't change
    pub fn get_void_elements(&self, language_id: &str) -> Vec<String> {
        let mut void_tags: Vec<String> = vec![];
        for provider in &self.data_providers {
            if provider.is_applicable(language_id) {
                provider
                    .provide_tags()
                    .iter()
                    .filter(|tag| tag.void.is_some_and(|v| v))
                    .for_each(|tag| void_tags.push(tag.name.clone()))
            }
        }
        void_tags.sort();
        void_tags
    }

    /// Is the `attr` of `tag` a path attribute
    pub fn is_path_attribute(&self, tag: &str, attr: &str) -> bool {
        if ["src", "href"].contains(&attr) {
            return true;
        }
        let value = PATH_TAG_AND_ATTR.as_object().unwrap().get(tag);
        if let Some(value) = value {
            if value.is_array() {
                value
                    .as_array()
                    .unwrap()
                    .contains(&Value::String(attr.to_string()))
            } else {
                value.as_str().unwrap() == attr
            }
        } else {
            false
        }
    }
}

impl Default for HTMLDataManager {
    fn default() -> Self {
        HTMLDataManager::new(true, None, false)
    }
}

impl Debug for HTMLDataManager {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("HTMLDataManager")
            .field("data_providers(len)", &self.data_providers.len())
            .field("case_sensitive", &self.case_sensitive)
            .finish()
    }
}

lazy_static! {
    static ref PATH_TAG_AND_ATTR: Value = json!({
        // HTML 4
        "a": "href",
        "area": "href",
        "body": "background",
        "blockquote": "cite",
        "del": "cite",
        "form": "action",
        "frame": ["src", "longdesc"],
        "img": ["src", "longdesc"],
        "ins": "cite",
        "link": "href",
        "object": "data",
        "q": "cite",
        "script": "src",
        // HTML 5
        "audio": "src",
        "button": "formaction",
        "command": "icon",
        "embed": "src",
        "html": "manifest",
        "input": ["src", "formaction"],
        "source": "src",
        "track": "src",
        "video": ["src", "poster"]
    });
}