Extract TOML support into an extension (#9940)

This PR extracts TOML support into an extension and removes the built-in
TOML support from Zed.

There's a small workaround necessary in order for us to set the file
permissions on the `taplo` binary so that it can be run. Eventually
we'll want to build this into the extension API, but for now we're just
hard-coding it on the host side.

Release Notes:

- Removed built-in support for TOML, in favor of making it available as
an extension. The TOML extension will be suggested for download when you
open a `.toml` or `Cargo.lock` file.
This commit is contained in:
Marshall Bowers 2024-03-28 18:40:12 -04:00 committed by GitHub
parent 90cf73b746
commit d074586fbf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
18 changed files with 156 additions and 142 deletions

View file

@ -0,0 +1,16 @@
[package]
name = "zed_toml"
version = "0.0.1"
edition = "2021"
publish = false
license = "Apache-2.0"
[lints]
workspace = true
[lib]
path = "src/toml.rs"
crate-type = ["cdylib"]
[dependencies]
zed_extension_api = "0.0.4"

View file

@ -0,0 +1 @@
../../LICENSE-APACHE

View file

@ -0,0 +1,18 @@
id = "toml"
name = "TOML"
description = "TOML support."
version = "0.0.2"
schema_version = 1
authors = [
"Max Brunsfeld <max@zed.dev>",
"Ammar Arif <evergreenkary@gmail.com>"
]
repository = "https://github.com/zed-industries/zed"
[language_servers.taplo]
name = "Taplo"
language = "TOML"
[grammars.toml]
repository = "https://github.com/tree-sitter/tree-sitter-toml"
commit = "342d9be207c2dba869b9967124c679b5e6fd0ebe"

View file

@ -0,0 +1,3 @@
("[" @open "]" @close)
("{" @open "}" @close)
("\"" @open "\"" @close)

View file

@ -0,0 +1,11 @@
name = "TOML"
grammar = "toml"
path_suffixes = ["Cargo.lock", "toml"]
line_comments = ["# "]
autoclose_before = ",]}"
brackets = [
{ start = "{", end = "}", close = true, newline = true },
{ start = "[", end = "]", close = true, newline = true },
{ start = "\"", end = "\"", close = true, newline = false, not_in = ["comment", "string"] },
{ start = "'", end = "'", close = true, newline = false, not_in = ["comment", "string"] },
]

View file

@ -0,0 +1,37 @@
; Properties
;-----------
(bare_key) @property
(quoted_key) @property
; Literals
;---------
(boolean) @constant
(comment) @comment
(string) @string
(integer) @number
(float) @number
(offset_date_time) @string.special
(local_date_time) @string.special
(local_date) @string.special
(local_time) @string.special
; Punctuation
;------------
[
"."
","
] @punctuation.delimiter
"=" @operator
[
"["
"]"
"[["
"]]"
"{"
"}"
] @punctuation.bracket

View file

@ -0,0 +1,15 @@
(table
.
"["
.
(_) @name) @item
(table_array_element
.
"[["
.
(_) @name) @item
(pair
.
(_) @name) @item

View file

@ -0,0 +1,2 @@
(comment) @comment
(string) @string

View file

@ -0,0 +1 @@
(pair (bare_key) "=" (_) @redact)

110
extensions/toml/src/toml.rs Normal file
View file

@ -0,0 +1,110 @@
use std::fs;
use zed_extension_api::{self as zed, Result};
struct TomlExtension {
cached_binary_path: Option<String>,
}
impl TomlExtension {
fn language_server_binary_path(&mut self, config: zed::LanguageServerConfig) -> Result<String> {
if let Some(path) = &self.cached_binary_path {
if fs::metadata(path).map_or(false, |stat| stat.is_file()) {
return Ok(path.clone());
}
}
zed::set_language_server_installation_status(
&config.name,
&zed::LanguageServerInstallationStatus::CheckingForUpdate,
);
let release = zed::latest_github_release(
"tamasfe/taplo",
zed::GithubReleaseOptions {
require_assets: true,
pre_release: false,
},
)?;
let (platform, arch) = zed::current_platform();
let asset_name = format!(
"taplo-full-{os}-{arch}.{extension}",
arch = match arch {
zed::Architecture::Aarch64 => "aarch64",
zed::Architecture::X86 => "x86",
zed::Architecture::X8664 => "x86_64",
},
os = match platform {
zed::Os::Mac => "darwin",
zed::Os::Linux => "linux",
zed::Os::Windows => "windows",
},
extension = match platform {
zed::Os::Mac | zed::Os::Linux => "gz",
zed::Os::Windows => "zip",
}
);
let asset = release
.assets
.iter()
.find(|asset| asset.name == asset_name)
.ok_or_else(|| format!("no asset found matching {:?}", asset_name))?;
let version_dir = format!("taplo-{}", release.version);
fs::create_dir_all(&version_dir)
.map_err(|err| format!("failed to create directory '{version_dir}': {err}"))?;
let binary_path = format!("{version_dir}/taplo");
if !fs::metadata(&binary_path).map_or(false, |stat| stat.is_file()) {
zed::set_language_server_installation_status(
&config.name,
&zed::LanguageServerInstallationStatus::Downloading,
);
zed::download_file(
&asset.download_url,
&binary_path,
match platform {
zed::Os::Mac | zed::Os::Linux => zed::DownloadedFileType::Gzip,
zed::Os::Windows => zed::DownloadedFileType::Zip,
},
)
.map_err(|err| format!("failed to download file: {err}"))?;
let entries = fs::read_dir(".")
.map_err(|err| format!("failed to list working directory {err}"))?;
for entry in entries {
let entry = entry.map_err(|err| format!("failed to load directory entry {err}"))?;
if entry.file_name().to_str() != Some(&version_dir) {
fs::remove_dir_all(&entry.path()).ok();
}
}
}
self.cached_binary_path = Some(binary_path.clone());
Ok(binary_path)
}
}
impl zed::Extension for TomlExtension {
fn new() -> Self {
Self {
cached_binary_path: None,
}
}
fn language_server_command(
&mut self,
config: zed::LanguageServerConfig,
_worktree: &zed::Worktree,
) -> Result<zed::Command> {
Ok(zed::Command {
command: self.language_server_binary_path(config)?,
args: vec!["lsp".to_string(), "stdio".to_string()],
env: Default::default(),
})
}
}
zed::register_extension!(TomlExtension);