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