mirror of
https://github.com/zed-industries/zed.git
synced 2026-11-19 06:59:22 +01:00
Make it possible to disable language servers in the extension manifest (#65030)
## Summary This PR enables extension authors to disable language servers from the `extension.toml` as opposed to requiring a change to Zed's default settings. With this in, we no longer need to ship default enabled servers for a given language and can instead resort to extension authors disabling those in their extension. This gives extension authors more control and also finally removes the need to link Zed version releases to extension releases in cases where the extension wants to add a new language server. ## Testing Aside from the added tests, also ran a local build and tested this against the kotlin extension. Worked as I would expect it to. ## Self-review - [X] I've reviewed my diff for quality, security, reliability, and performance. - [-] UI changes follow the [checklist](https://zed.dev/docs/development/ui-checklist). - [X] Tests cover the new or changed behavior. Release Notes: - Added the possibility for language server extensions to configure which language servers are enabled/disabled by default. Visit https://zed.dev/docs/extensions/languages.md#opt-in-language-servers for more information. --------- Co-authored-by: Piotr Osiewicz <24362066+osiewicz@users.noreply.github.com> Co-authored-by: zed-zippy[bot] <234243425+zed-zippy[bot]@users.noreply.github.com>
This commit is contained in:
@@ -34,6 +34,7 @@ pub fn register_fake_definition_server(
|
||||
arguments: Vec::new(),
|
||||
env: None,
|
||||
},
|
||||
enabled_by_default: true,
|
||||
capabilities: lsp::ServerCapabilities {
|
||||
definition_provider: Some(lsp::OneOf::Left(true)),
|
||||
type_definition_provider: Some(lsp::TypeDefinitionProviderCapability::Simple(true)),
|
||||
|
||||
@@ -50,6 +50,8 @@ impl fmt::Display for SchemaVersion {
|
||||
|
||||
impl SchemaVersion {
|
||||
pub const ZERO: Self = Self(0);
|
||||
/// The latest schema version supported by Zed.
|
||||
pub const CURRENT: Self = Self(1);
|
||||
|
||||
pub fn is_v0(&self) -> bool {
|
||||
self == &Self::ZERO
|
||||
@@ -254,6 +256,10 @@ pub struct LanguageServerManifestEntry {
|
||||
pub language_ids: HashMap<LanguageName, String>,
|
||||
#[serde(default)]
|
||||
pub code_action_kinds: Option<Vec<lsp::CodeActionKind>>,
|
||||
/// Languages (from `languages`) for which this language server is not started
|
||||
/// unless the user explicitly lists it in their `language_servers` setting.
|
||||
#[serde(default, skip_serializing_if = "BTreeSet::is_empty")]
|
||||
opt_in_languages: BTreeSet<LanguageName>,
|
||||
}
|
||||
|
||||
impl LanguageServerManifestEntry {
|
||||
@@ -272,6 +278,17 @@ impl LanguageServerManifestEntry {
|
||||
};
|
||||
self.languages.iter().cloned().chain(language)
|
||||
}
|
||||
|
||||
/// Returns the languages for which the language server is disabled by default.
|
||||
pub fn opt_in_languages(&self) -> &BTreeSet<LanguageName> {
|
||||
&self.opt_in_languages
|
||||
}
|
||||
|
||||
/// Returns whether the language server should only be started for the given
|
||||
/// language when the user explicitly enables it.
|
||||
pub fn is_opt_in_for(&self, language: &LanguageName) -> bool {
|
||||
self.opt_in_languages.contains(language)
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
|
||||
@@ -504,6 +521,41 @@ mod tests {
|
||||
assert!(manifest.allow_exec("docker", &["ps"]).is_err()); // wrong first arg
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_deserialize_opt_in_languages() {
|
||||
let manifest: ExtensionManifest = toml::from_str(indoc::indoc! {r#"
|
||||
id = "test-manifest"
|
||||
name = "Test Manifest"
|
||||
version = "0.0.1"
|
||||
schema_version = 1
|
||||
|
||||
[language_servers.default-server]
|
||||
languages = ["Julia"]
|
||||
|
||||
[language_servers.opt-in-server]
|
||||
languages = ["Julia", "Markdown"]
|
||||
opt_in_languages = ["Julia"]
|
||||
"#})
|
||||
.expect("manifest should parse");
|
||||
|
||||
let julia = LanguageName::new("Julia");
|
||||
let markdown = LanguageName::new("Markdown");
|
||||
|
||||
let default_server =
|
||||
&manifest.language_servers[&LanguageServerName::new_static("default-server")];
|
||||
assert!(default_server.opt_in_languages().is_empty());
|
||||
assert!(!default_server.is_opt_in_for(&julia));
|
||||
|
||||
let opt_in_server =
|
||||
&manifest.language_servers[&LanguageServerName::new_static("opt-in-server")];
|
||||
assert_eq!(
|
||||
opt_in_server.languages().into_iter().collect::<Vec<_>>(),
|
||||
vec![julia.clone(), markdown.clone()]
|
||||
);
|
||||
assert!(opt_in_server.is_opt_in_for(&julia));
|
||||
assert!(!opt_in_server.is_opt_in_for(&markdown));
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[cfg(target_os = "windows")]
|
||||
fn test_deserialize_manifest_with_windows_separators() {
|
||||
@@ -520,3 +572,87 @@ mod tests {
|
||||
assert_eq!(manifest.languages, vec![rel_path_buf("foo/bar")]);
|
||||
}
|
||||
}
|
||||
|
||||
/// Requirements for the manifest format of the next schema version.
|
||||
///
|
||||
/// These are skipped while [`SchemaVersion::CURRENT`] is below
|
||||
/// `NEXT_SCHEMA_VERSION` and fail once it is bumped, until the manifest
|
||||
/// format has been migrated.
|
||||
#[cfg(test)]
|
||||
mod next_schema_version_tests {
|
||||
use pretty_assertions::assert_eq;
|
||||
|
||||
use super::*;
|
||||
|
||||
const NEXT_SCHEMA_VERSION: SchemaVersion = SchemaVersion(2);
|
||||
|
||||
fn is_next_schema_version_supported() -> bool {
|
||||
SchemaVersion::CURRENT >= NEXT_SCHEMA_VERSION
|
||||
}
|
||||
|
||||
fn parse_manifest(language_server: &str) -> Result<ExtensionManifest, toml::de::Error> {
|
||||
toml::from_str(&format!(
|
||||
indoc::indoc! {r#"
|
||||
id = "test-manifest"
|
||||
name = "Test Manifest"
|
||||
version = "0.0.1"
|
||||
schema_version = {}
|
||||
|
||||
[language_servers.my-server]
|
||||
{}
|
||||
"#},
|
||||
NEXT_SCHEMA_VERSION, language_server
|
||||
))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_language_server_languages_must_not_be_a_list() {
|
||||
if !is_next_schema_version_supported() {
|
||||
return;
|
||||
}
|
||||
|
||||
assert!(
|
||||
parse_manifest(indoc::indoc! {r#"
|
||||
languages = ["Julia", "Markdown"]
|
||||
language_ids = { Julia = "julia" }
|
||||
opt_in_languages = ["Julia"]
|
||||
"#})
|
||||
.is_err(),
|
||||
"`languages`, `language_ids` and `opt_in_languages` must be folded \
|
||||
into a single `languages` map on schema version {NEXT_SCHEMA_VERSION}",
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_language_server_languages_are_a_map() {
|
||||
if !is_next_schema_version_supported() {
|
||||
return;
|
||||
}
|
||||
|
||||
let manifest = parse_manifest(indoc::indoc! {r#"
|
||||
[language_servers.my-server.languages]
|
||||
Julia = { language_id = "julia", enabled_by_default = false }
|
||||
Markdown = {}
|
||||
"#})
|
||||
.unwrap_or_else(|error| {
|
||||
panic!(
|
||||
"language server languages must be a map keyed by language name \
|
||||
on schema version {NEXT_SCHEMA_VERSION}: {error}"
|
||||
)
|
||||
});
|
||||
|
||||
let julia = LanguageName::new("Julia");
|
||||
let markdown = LanguageName::new("Markdown");
|
||||
let entry = &manifest.language_servers[&LanguageServerName::new_static("my-server")];
|
||||
assert_eq!(
|
||||
entry.languages().into_iter().collect::<Vec<_>>(),
|
||||
vec![julia.clone(), markdown.clone()]
|
||||
);
|
||||
assert_eq!(
|
||||
entry.language_ids.get(&julia).map(String::as_str),
|
||||
Some("julia")
|
||||
);
|
||||
assert!(entry.is_opt_in_for(&julia));
|
||||
assert!(!entry.is_opt_in_for(&markdown));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -456,6 +456,14 @@ enum ExtensionManifestValidationError {
|
||||
as these are currently unsupported"
|
||||
)]
|
||||
LanguageModelProvidersUnsupported,
|
||||
#[error(
|
||||
"language server `{language_server}` lists `{language}` in `opt_in_languages`, \
|
||||
but `{language}` is not listed in its `languages`"
|
||||
)]
|
||||
OptInLanguageNotInLanguages {
|
||||
language_server: String,
|
||||
language: String,
|
||||
},
|
||||
}
|
||||
|
||||
fn validate_extension_manifest(
|
||||
@@ -510,6 +518,18 @@ fn validate_extension_manifest(
|
||||
return Err(ExtensionManifestValidationError::LanguageModelProvidersUnsupported);
|
||||
}
|
||||
|
||||
for (language_server, entry) in &manifest.language_servers {
|
||||
let languages = entry.languages().into_iter().collect::<BTreeSet<_>>();
|
||||
if let Some(language) = entry.opt_in_languages().difference(&languages).next() {
|
||||
return Err(
|
||||
ExtensionManifestValidationError::OptInLanguageNotInLanguages {
|
||||
language_server: language_server.to_string(),
|
||||
language: language.to_string(),
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
@@ -897,6 +917,41 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_validate_manifest_opt_in_languages() {
|
||||
let manifest_with_language_server = |language_server: &str| -> ExtensionManifest {
|
||||
let language_server = toml::from_str(language_server).unwrap();
|
||||
ExtensionManifest {
|
||||
language_servers: BTreeMap::from_iter([("my-server".into(), language_server)]),
|
||||
..valid_manifest()
|
||||
}
|
||||
};
|
||||
|
||||
let manifest = manifest_with_language_server(
|
||||
r#"
|
||||
languages = ["Julia", "Markdown"]
|
||||
opt_in_languages = ["Julia"]
|
||||
"#,
|
||||
);
|
||||
assert_eq!(validate_extension_manifest(&manifest), Ok(()));
|
||||
|
||||
let manifest = manifest_with_language_server(
|
||||
r#"
|
||||
languages = ["Markdown"]
|
||||
opt_in_languages = ["Julia"]
|
||||
"#,
|
||||
);
|
||||
assert_eq!(
|
||||
validate_extension_manifest(&manifest),
|
||||
Err(
|
||||
ExtensionManifestValidationError::OptInLanguageNotInLanguages {
|
||||
language_server: "my-server".to_string(),
|
||||
language: "Julia".to_string(),
|
||||
}
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_validate_empty_features() {
|
||||
let provides = BTreeSet::new();
|
||||
|
||||
@@ -102,9 +102,6 @@ async fn with_remote_sync_timeout<T>(
|
||||
}
|
||||
}
|
||||
|
||||
/// The current extension [`SchemaVersion`] supported by Zed.
|
||||
const CURRENT_SCHEMA_VERSION: SchemaVersion = SchemaVersion(1);
|
||||
|
||||
/// Extensions that should no longer be loaded or downloaded.
|
||||
///
|
||||
/// These snippets should no longer be downloaded or loaded, because their
|
||||
@@ -131,7 +128,7 @@ static SUPPRESSED_EXTENSIONS: LazyLock<FxHashSet<&str>> = LazyLock::new(|| {
|
||||
|
||||
/// Returns the [`SchemaVersion`] range that is compatible with this version of Zed.
|
||||
pub fn schema_version_range() -> RangeInclusive<SchemaVersion> {
|
||||
SchemaVersion::ZERO..=CURRENT_SCHEMA_VERSION
|
||||
SchemaVersion::ZERO..=SchemaVersion::CURRENT
|
||||
}
|
||||
|
||||
/// Returns whether the given extension version is compatible with this version of Zed.
|
||||
@@ -140,7 +137,7 @@ pub fn is_version_compatible(
|
||||
extension_version: &ExtensionMetadata,
|
||||
) -> bool {
|
||||
let schema_version = extension_version.manifest.schema_version.unwrap_or(0);
|
||||
if CURRENT_SCHEMA_VERSION.0 < schema_version {
|
||||
if SchemaVersion::CURRENT.0 < schema_version {
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -667,7 +664,7 @@ impl ExtensionStore {
|
||||
provides_filter: Option<&BTreeSet<ExtensionProvides>>,
|
||||
cx: &mut Context<Self>,
|
||||
) -> Task<Result<Vec<ExtensionMetadata>>> {
|
||||
let version = CURRENT_SCHEMA_VERSION.to_string();
|
||||
let version = SchemaVersion::CURRENT.to_string();
|
||||
let mut query = vec![("max_schema_version", version.as_str())];
|
||||
if let Some(search) = search {
|
||||
query.push(("filter", search));
|
||||
|
||||
@@ -334,6 +334,7 @@ pub struct CachedLspAdapter {
|
||||
pub disk_based_diagnostic_sources: Vec<String>,
|
||||
pub disk_based_diagnostics_progress_token: Option<String>,
|
||||
language_ids: HashMap<LanguageName, String>,
|
||||
pub enabled_by_default: bool,
|
||||
pub adapter: Arc<dyn LspAdapter>,
|
||||
cached_binary: Arc<ServerBinaryCache>,
|
||||
}
|
||||
@@ -351,6 +352,7 @@ impl Debug for CachedLspAdapter {
|
||||
&self.disk_based_diagnostics_progress_token,
|
||||
)
|
||||
.field("language_ids", &self.language_ids)
|
||||
.field("enabled_by_default", &self.enabled_by_default)
|
||||
.finish_non_exhaustive()
|
||||
}
|
||||
}
|
||||
@@ -361,12 +363,14 @@ impl CachedLspAdapter {
|
||||
let disk_based_diagnostic_sources = adapter.disk_based_diagnostic_sources();
|
||||
let disk_based_diagnostics_progress_token = adapter.disk_based_diagnostics_progress_token();
|
||||
let language_ids = adapter.language_ids();
|
||||
let enabled_by_default = adapter.enabled_by_default();
|
||||
|
||||
Arc::new(CachedLspAdapter {
|
||||
name,
|
||||
disk_based_diagnostic_sources,
|
||||
disk_based_diagnostics_progress_token,
|
||||
language_ids,
|
||||
enabled_by_default,
|
||||
adapter,
|
||||
cached_binary: Default::default(),
|
||||
})
|
||||
@@ -656,6 +660,12 @@ pub trait LspAdapter: 'static + Send + Sync + DynLspInstaller {
|
||||
HashMap::default()
|
||||
}
|
||||
|
||||
/// Whether the `...` wildcard in the `language_servers` setting includes this
|
||||
/// language server. If `false`, it only starts when listed explicitly.
|
||||
fn enabled_by_default(&self) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
/// Support custom initialize params.
|
||||
fn prepare_initialize_params(
|
||||
&self,
|
||||
@@ -923,6 +933,7 @@ pub struct FakeLspAdapter {
|
||||
pub disk_based_diagnostics_progress_token: Option<String>,
|
||||
pub disk_based_diagnostics_sources: Vec<String>,
|
||||
pub language_server_binary: LanguageServerBinary,
|
||||
pub enabled_by_default: bool,
|
||||
|
||||
pub capabilities: lsp::ServerCapabilities,
|
||||
pub initializer: Option<Box<dyn 'static + Send + Sync + Fn(&mut lsp::FakeLanguageServer)>>,
|
||||
@@ -1550,6 +1561,7 @@ impl Default for FakeLspAdapter {
|
||||
arguments: vec![],
|
||||
env: Default::default(),
|
||||
},
|
||||
enabled_by_default: true,
|
||||
label_for_completion: None,
|
||||
}
|
||||
}
|
||||
@@ -1652,6 +1664,10 @@ impl LspAdapter for FakeLspAdapter {
|
||||
label_for_completion(item, language)
|
||||
}
|
||||
|
||||
fn enabled_by_default(&self) -> bool {
|
||||
self.enabled_by_default
|
||||
}
|
||||
|
||||
fn is_extension(&self) -> bool {
|
||||
false
|
||||
}
|
||||
|
||||
@@ -305,6 +305,14 @@ impl LspAdapter for ExtensionLspAdapter {
|
||||
.unwrap_or_default()
|
||||
}
|
||||
|
||||
fn enabled_by_default(&self) -> bool {
|
||||
self.extension
|
||||
.manifest()
|
||||
.language_servers
|
||||
.get(&self.language_server_id)
|
||||
.is_none_or(|server| !server.is_opt_in_for(&self.language_name))
|
||||
}
|
||||
|
||||
async fn initialization_options(
|
||||
self: Arc<Self>,
|
||||
delegate: &Arc<dyn LspAdapterDelegate>,
|
||||
|
||||
@@ -253,6 +253,7 @@ impl LanguageServerTree {
|
||||
let available_lsp_adapters = self.languages.lsp_adapters(language_name);
|
||||
let available_language_servers = available_lsp_adapters
|
||||
.iter()
|
||||
.filter(|lsp_adapter| lsp_adapter.enabled_by_default)
|
||||
.map(|lsp_adapter| lsp_adapter.name.clone())
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
|
||||
@@ -2054,6 +2054,96 @@ async fn test_late_lsp_adapter_registration(cx: &mut gpui::TestAppContext) {
|
||||
});
|
||||
}
|
||||
|
||||
#[gpui::test]
|
||||
async fn test_language_servers_disabled_by_default(cx: &mut gpui::TestAppContext) {
|
||||
init_test(cx);
|
||||
|
||||
async fn running_language_servers(
|
||||
settings_json_contents: serde_json::Value,
|
||||
cx: &mut gpui::TestAppContext,
|
||||
) -> Vec<LanguageServerName> {
|
||||
let fs = FakeFs::new(cx.executor());
|
||||
fs.insert_tree(
|
||||
path!("/the-root"),
|
||||
json!({
|
||||
".zed": {
|
||||
"settings.json": settings_json_contents.to_string(),
|
||||
},
|
||||
"main.rs": "",
|
||||
}),
|
||||
)
|
||||
.await;
|
||||
|
||||
let project = Project::test(fs.clone(), [path!("/the-root").as_ref()], cx).await;
|
||||
let language_registry = project.read_with(cx, |project, _| project.languages().clone());
|
||||
language_registry.add(rust_lang());
|
||||
|
||||
let _default_server = language_registry.register_fake_lsp(
|
||||
"Rust",
|
||||
FakeLspAdapter {
|
||||
name: "default-server",
|
||||
..Default::default()
|
||||
},
|
||||
);
|
||||
let _opt_in_server = language_registry.register_fake_lsp(
|
||||
"Rust",
|
||||
FakeLspAdapter {
|
||||
name: "opt-in-server",
|
||||
enabled_by_default: false,
|
||||
..Default::default()
|
||||
},
|
||||
);
|
||||
cx.run_until_parked();
|
||||
|
||||
let (buffer, _handle) = project
|
||||
.update(cx, |project, cx| {
|
||||
project.open_local_buffer_with_lsp(path!("/the-root/main.rs"), cx)
|
||||
})
|
||||
.await
|
||||
.unwrap();
|
||||
cx.run_until_parked();
|
||||
|
||||
project.update(cx, |project, cx| {
|
||||
project.lsp_store().update(cx, |lsp_store, cx| {
|
||||
buffer.update(cx, |buffer, cx| {
|
||||
lsp_store
|
||||
.running_language_servers_for_local_buffer(buffer, cx)
|
||||
.map(|(adapter, _)| adapter.name())
|
||||
.sorted()
|
||||
.collect()
|
||||
})
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
assert_eq!(
|
||||
running_language_servers(json!({}), cx).await,
|
||||
vec![LanguageServerName::new_static("default-server")],
|
||||
"servers disabled by default must not be started without explicit configuration"
|
||||
);
|
||||
assert_eq!(
|
||||
running_language_servers(
|
||||
json!({ "languages": { "Rust": { "language_servers": ["!default-server", "..."] } } }),
|
||||
cx
|
||||
)
|
||||
.await,
|
||||
Vec::<LanguageServerName>::new(),
|
||||
"the `...` wildcard must not include servers disabled by default"
|
||||
);
|
||||
assert_eq!(
|
||||
running_language_servers(
|
||||
json!({ "languages": { "Rust": { "language_servers": ["opt-in-server", "..."] } } }),
|
||||
cx
|
||||
)
|
||||
.await,
|
||||
vec![
|
||||
LanguageServerName::new_static("default-server"),
|
||||
LanguageServerName::new_static("opt-in-server"),
|
||||
],
|
||||
"servers disabled by default must start when listed explicitly"
|
||||
);
|
||||
}
|
||||
|
||||
#[gpui::test]
|
||||
async fn test_language_server_relative_path(cx: &mut gpui::TestAppContext) {
|
||||
init_test(cx);
|
||||
|
||||
@@ -128,6 +128,8 @@ In this example:
|
||||
|
||||
The `"..."` entry acts as a wildcard that includes any registered language server you haven't explicitly mentioned. Servers you list by name keep their position, and `"..."` fills in the remaining ones at that point in the list. Servers prefixed with `!` are excluded entirely. This means that if a new language server extension is installed or a new server is registered for a language, `"..."` will automatically include it. If you want full control over which servers are enabled, omit `"..."` — only the servers you list by name will be used.
|
||||
|
||||
Extensions can also mark a language server as [disabled by default](./extensions/languages.md#opt-in-language-servers) for some of its languages. Such servers are never included by `"..."`, regardless of your configuration, and only start when you list them by name, e.g. `["my-alternative-server", "..."]`.
|
||||
|
||||
#### Examples
|
||||
|
||||
Suppose you're working with Ruby. The default configuration is:
|
||||
|
||||
@@ -499,6 +499,31 @@ impl zed::Extension for MyExtension {
|
||||
}
|
||||
```
|
||||
|
||||
### Opt-In Language Servers
|
||||
|
||||
If your extension ships a language server that users should only run when they opt in (for example, an alternative to the primary language server), list the languages it should not start for by default in `opt_in_languages`. Every language listed there must also be listed in `languages`:
|
||||
|
||||
```toml
|
||||
[language_servers.my-alternative-server]
|
||||
name = "My Alternative LSP"
|
||||
languages = ["My Language", "My Other Language"]
|
||||
opt_in_languages = ["My Language"]
|
||||
```
|
||||
|
||||
For the languages listed in `opt_in_languages`, the language server is not covered by the `"..."` wildcard in the [`language_servers`](../configuring-languages.md#choosing-language-servers) setting. Users enable it by naming it explicitly:
|
||||
|
||||
```json [settings]
|
||||
{
|
||||
"languages": {
|
||||
"My Language": {
|
||||
"language_servers": ["my-alternative-server", "..."]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
> **Note:** Versions of Zed that do not support `opt_in_languages` ignore it and start the language server for all of its `languages`.
|
||||
|
||||
You can customize the handling of the language server using several optional methods in the `Extension` trait. For example, you can control how completions are styled using the `label_for_completion` method. For a complete list of methods, see the [API docs for the Zed extension API](https://docs.rs/zed_extension_api).
|
||||
|
||||
### Syntax Highlighting with Semantic Tokens
|
||||
|
||||
Reference in New Issue
Block a user