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}
78
79#[derive(Clone, Default, PartialEq, Eq, Debug, Deserialize, Serialize)]
80pub struct LibManifestEntry {
81 pub kind: Option<ExtensionLibraryKind>,
82 pub version: Option<SemanticVersion>,
83}
84
85#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
86pub enum ExtensionLibraryKind {
87 Rust,
88}
89
90#[derive(Clone, Default, PartialEq, Eq, Debug, Deserialize, Serialize)]
91pub struct GrammarManifestEntry {
92 pub repository: String,
93 #[serde(alias = "commit")]
94 pub rev: String,
95 #[serde(default)]
96 pub path: Option<String>,
97}
98
99#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
100pub struct LanguageServerManifestEntry {
101 /// Deprecated in favor of `languages`.
102 #[serde(default)]
103 language: Option<Arc<str>>,
104 /// The list of languages this language server should work with.
105 #[serde(default)]
106 languages: Vec<Arc<str>>,
107 #[serde(default)]
108 pub language_ids: HashMap<String, String>,
109}
110
111impl LanguageServerManifestEntry {
112 /// Returns the list of languages for the language server.
113 ///
114 /// Prefer this over accessing the `language` or `languages` fields directly,
115 /// as we currently support both.
116 ///
117 /// We can replace this with just field access for the `languages` field once
118 /// we have removed `language`.
119 pub fn languages(&self) -> impl IntoIterator<Item = Arc<str>> + '_ {
120 let language = if self.languages.is_empty() {
121 self.language.clone()
122 } else {
123 None
124 };
125 self.languages.iter().cloned().chain(language)
126 }
127}
128
129impl ExtensionManifest {
130 pub async fn load(fs: Arc<dyn Fs>, extension_dir: &Path) -> Result<Self> {
131 let extension_name = extension_dir
132 .file_name()
133 .and_then(OsStr::to_str)
134 .ok_or_else(|| anyhow!("invalid extension name"))?;
135
136 let mut extension_manifest_path = extension_dir.join("extension.json");
137 if fs.is_file(&extension_manifest_path).await {
138 let manifest_content = fs
139 .load(&extension_manifest_path)
140 .await
141 .with_context(|| format!("failed to load {extension_name} extension.json"))?;
142 let manifest_json = serde_json::from_str::<OldExtensionManifest>(&manifest_content)
143 .with_context(|| {
144 format!("invalid extension.json for extension {extension_name}")
145 })?;
146
147 Ok(manifest_from_old_manifest(manifest_json, extension_name))
148 } else {
149 extension_manifest_path.set_extension("toml");
150 let manifest_content = fs
151 .load(&extension_manifest_path)
152 .await
153 .with_context(|| format!("failed to load {extension_name} extension.toml"))?;
154 toml::from_str(&manifest_content)
155 .with_context(|| format!("invalid extension.json for extension {extension_name}"))
156 }
157 }
158}
159
160fn manifest_from_old_manifest(
161 manifest_json: OldExtensionManifest,
162 extension_id: &str,
163) -> ExtensionManifest {
164 ExtensionManifest {
165 id: extension_id.into(),
166 name: manifest_json.name,
167 version: manifest_json.version,
168 description: manifest_json.description,
169 repository: manifest_json.repository,
170 authors: manifest_json.authors,
171 schema_version: SchemaVersion::ZERO,
172 lib: Default::default(),
173 themes: {
174 let mut themes = manifest_json.themes.into_values().collect::<Vec<_>>();
175 themes.sort();
176 themes.dedup();
177 themes
178 },
179 languages: {
180 let mut languages = manifest_json.languages.into_values().collect::<Vec<_>>();
181 languages.sort();
182 languages.dedup();
183 languages
184 },
185 grammars: manifest_json
186 .grammars
187 .into_keys()
188 .map(|grammar_name| (grammar_name, Default::default()))
189 .collect(),
190 language_servers: Default::default(),
191 }
192}