1use anyhow::{anyhow, Context, Result};
2use collections::{BTreeMap, HashMap};
3use fs::Fs;
4use language::LanguageServerName;
5use semantic_version::SemanticVersion;
6use serde::{Deserialize, Serialize};
7use std::{
8 ffi::OsStr,
9 fmt,
10 path::{Path, PathBuf},
11 sync::Arc,
12};
13
14/// This is the old version of the extension manifest, from when it was `extension.json`.
15#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
16pub struct OldExtensionManifest {
17 pub name: String,
18 pub version: Arc<str>,
19
20 #[serde(default)]
21 pub description: Option<String>,
22 #[serde(default)]
23 pub repository: Option<String>,
24 #[serde(default)]
25 pub authors: Vec<String>,
26
27 #[serde(default)]
28 pub themes: BTreeMap<Arc<str>, PathBuf>,
29 #[serde(default)]
30 pub languages: BTreeMap<Arc<str>, PathBuf>,
31 #[serde(default)]
32 pub grammars: BTreeMap<Arc<str>, PathBuf>,
33}
34
35/// The schema version of the [`ExtensionManifest`].
36#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, Serialize, Deserialize)]
37pub struct SchemaVersion(pub i32);
38
39impl fmt::Display for SchemaVersion {
40 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
41 write!(f, "{}", self.0)
42 }
43}
44
45impl SchemaVersion {
46 pub const ZERO: Self = Self(0);
47
48 pub fn is_v0(&self) -> bool {
49 self == &Self::ZERO
50 }
51}
52
53#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
54pub struct ExtensionManifest {
55 pub id: Arc<str>,
56 pub name: String,
57 pub version: Arc<str>,
58 pub schema_version: SchemaVersion,
59
60 #[serde(default)]
61 pub description: Option<String>,
62 #[serde(default)]
63 pub repository: Option<String>,
64 #[serde(default)]
65 pub authors: Vec<String>,
66 #[serde(default)]
67 pub lib: LibManifestEntry,
68
69 #[serde(default)]
70 pub themes: Vec<PathBuf>,
71 #[serde(default)]
72 pub languages: Vec<PathBuf>,
73 #[serde(default)]
74 pub grammars: BTreeMap<Arc<str>, GrammarManifestEntry>,
75 #[serde(default)]
76 pub language_servers: BTreeMap<LanguageServerName, LanguageServerManifestEntry>,
77 #[serde(default)]
78 pub slash_commands: BTreeMap<Arc<str>, SlashCommandManifestEntry>,
79 #[serde(default)]
80 pub indexed_docs_providers: BTreeMap<Arc<str>, IndexedDocsProviderEntry>,
81}
82
83#[derive(Clone, Default, PartialEq, Eq, Debug, Deserialize, Serialize)]
84pub struct LibManifestEntry {
85 pub kind: Option<ExtensionLibraryKind>,
86 pub version: Option<SemanticVersion>,
87}
88
89#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
90pub enum ExtensionLibraryKind {
91 Rust,
92}
93
94#[derive(Clone, Default, PartialEq, Eq, Debug, Deserialize, Serialize)]
95pub struct GrammarManifestEntry {
96 pub repository: String,
97 #[serde(alias = "commit")]
98 pub rev: String,
99 #[serde(default)]
100 pub path: Option<String>,
101}
102
103#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
104pub struct LanguageServerManifestEntry {
105 /// Deprecated in favor of `languages`.
106 #[serde(default)]
107 language: Option<Arc<str>>,
108 /// The list of languages this language server should work with.
109 #[serde(default)]
110 languages: Vec<Arc<str>>,
111 #[serde(default)]
112 pub language_ids: HashMap<String, String>,
113 #[serde(default)]
114 pub code_action_kinds: Option<Vec<lsp::CodeActionKind>>,
115}
116
117impl LanguageServerManifestEntry {
118 /// Returns the list of languages for the language server.
119 ///
120 /// Prefer this over accessing the `language` or `languages` fields directly,
121 /// as we currently support both.
122 ///
123 /// We can replace this with just field access for the `languages` field once
124 /// we have removed `language`.
125 pub fn languages(&self) -> impl IntoIterator<Item = Arc<str>> + '_ {
126 let language = if self.languages.is_empty() {
127 self.language.clone()
128 } else {
129 None
130 };
131 self.languages.iter().cloned().chain(language)
132 }
133}
134
135#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
136pub struct SlashCommandManifestEntry {
137 pub description: String,
138 pub tooltip_text: String,
139 pub requires_argument: bool,
140}
141
142#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
143pub struct IndexedDocsProviderEntry {}
144
145impl ExtensionManifest {
146 pub async fn load(fs: Arc<dyn Fs>, extension_dir: &Path) -> Result<Self> {
147 let extension_name = extension_dir
148 .file_name()
149 .and_then(OsStr::to_str)
150 .ok_or_else(|| anyhow!("invalid extension name"))?;
151
152 let mut extension_manifest_path = extension_dir.join("extension.json");
153 if fs.is_file(&extension_manifest_path).await {
154 let manifest_content = fs
155 .load(&extension_manifest_path)
156 .await
157 .with_context(|| format!("failed to load {extension_name} extension.json"))?;
158 let manifest_json = serde_json::from_str::<OldExtensionManifest>(&manifest_content)
159 .with_context(|| {
160 format!("invalid extension.json for extension {extension_name}")
161 })?;
162
163 Ok(manifest_from_old_manifest(manifest_json, extension_name))
164 } else {
165 extension_manifest_path.set_extension("toml");
166 let manifest_content = fs
167 .load(&extension_manifest_path)
168 .await
169 .with_context(|| format!("failed to load {extension_name} extension.toml"))?;
170 toml::from_str(&manifest_content)
171 .with_context(|| format!("invalid extension.json for extension {extension_name}"))
172 }
173 }
174}
175
176fn manifest_from_old_manifest(
177 manifest_json: OldExtensionManifest,
178 extension_id: &str,
179) -> ExtensionManifest {
180 ExtensionManifest {
181 id: extension_id.into(),
182 name: manifest_json.name,
183 version: manifest_json.version,
184 description: manifest_json.description,
185 repository: manifest_json.repository,
186 authors: manifest_json.authors,
187 schema_version: SchemaVersion::ZERO,
188 lib: Default::default(),
189 themes: {
190 let mut themes = manifest_json.themes.into_values().collect::<Vec<_>>();
191 themes.sort();
192 themes.dedup();
193 themes
194 },
195 languages: {
196 let mut languages = manifest_json.languages.into_values().collect::<Vec<_>>();
197 languages.sort();
198 languages.dedup();
199 languages
200 },
201 grammars: manifest_json
202 .grammars
203 .into_keys()
204 .map(|grammar_name| (grammar_name, Default::default()))
205 .collect(),
206 language_servers: Default::default(),
207 slash_commands: BTreeMap::default(),
208 indexed_docs_providers: BTreeMap::default(),
209 }
210}