From 1218a846c152a86938dcb9c2dd0949215c48d602 Mon Sep 17 00:00:00 2001 From: Piotr Osiewicz <24362066+osiewicz@users.noreply.github.com> Date: Sat, 20 Jul 2024 15:18:02 +0200 Subject: [PATCH] extensions: Add Ruff extension (#14198) Release Notes: - Added extension for [Ruff](https://docs.astral.sh/ruff/), an extremely fast Python linter and code formatter, written in Rust. --- Cargo.lock | 7 ++ Cargo.toml | 1 + extensions/ruff/Cargo.toml | 16 +++++ extensions/ruff/LICENSE-APACHE | 1 + extensions/ruff/extension.toml | 11 +++ extensions/ruff/src/ruff.rs | 122 +++++++++++++++++++++++++++++++++ 6 files changed, 158 insertions(+) create mode 100644 extensions/ruff/Cargo.toml create mode 120000 extensions/ruff/LICENSE-APACHE create mode 100644 extensions/ruff/extension.toml create mode 100644 extensions/ruff/src/ruff.rs diff --git a/Cargo.lock b/Cargo.lock index 40f9c59228..9cd3b1eee1 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -14011,6 +14011,13 @@ dependencies = [ "zed_extension_api 0.0.6", ] +[[package]] +name = "zed_ruff" +version = "0.0.1" +dependencies = [ + "zed_extension_api 0.0.6", +] + [[package]] name = "zed_snippets" version = "0.0.5" diff --git a/Cargo.toml b/Cargo.toml index 1df8affd08..c564ffcb3a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -141,6 +141,7 @@ members = [ "extensions/php", "extensions/prisma", "extensions/purescript", + "extensions/ruff", "extensions/ruby", "extensions/snippets", "extensions/svelte", diff --git a/extensions/ruff/Cargo.toml b/extensions/ruff/Cargo.toml new file mode 100644 index 0000000000..0c8ef12401 --- /dev/null +++ b/extensions/ruff/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "zed_ruff" +version = "0.0.1" +edition = "2021" +publish = false +license = "Apache-2.0" + +[lints] +workspace = true + +[lib] +path = "src/ruff.rs" +crate-type = ["cdylib"] + +[dependencies] +zed_extension_api = "0.0.6" diff --git a/extensions/ruff/LICENSE-APACHE b/extensions/ruff/LICENSE-APACHE new file mode 120000 index 0000000000..1cd601d0a3 --- /dev/null +++ b/extensions/ruff/LICENSE-APACHE @@ -0,0 +1 @@ +../../LICENSE-APACHE \ No newline at end of file diff --git a/extensions/ruff/extension.toml b/extensions/ruff/extension.toml new file mode 100644 index 0000000000..55c1c59732 --- /dev/null +++ b/extensions/ruff/extension.toml @@ -0,0 +1,11 @@ +id = "ruff" +name = "Ruff" +description = "Support for Ruff, the Python linter and formatter" +version = "0.0.1" +schema_version = 1 +authors = [] +repository = "https://github.com/zed-industries/zed" + +[language_servers.ruff] +name = "Ruff" +languages = ["Python"] diff --git a/extensions/ruff/src/ruff.rs b/extensions/ruff/src/ruff.rs new file mode 100644 index 0000000000..960c263214 --- /dev/null +++ b/extensions/ruff/src/ruff.rs @@ -0,0 +1,122 @@ +use std::fs; +use zed::LanguageServerId; +use zed_extension_api::{self as zed, settings::LspSettings, Result}; + +struct RuffExtension { + cached_binary_path: Option, +} + +impl RuffExtension { + fn language_server_binary_path( + &mut self, + language_server_id: &LanguageServerId, + worktree: &zed::Worktree, + ) -> Result { + if let Some(path) = worktree.which("ruff") { + return Ok(path); + } + + zed::set_language_server_installation_status( + &language_server_id, + &zed::LanguageServerInstallationStatus::CheckingForUpdate, + ); + let release = zed::latest_github_release( + "astral-sh/ruff", + zed::GithubReleaseOptions { + require_assets: true, + pre_release: false, + }, + )?; + + let (platform, arch) = zed::current_platform(); + + let asset_stem = format!( + "ruff-{arch}-{os}", + arch = match arch { + zed::Architecture::Aarch64 => "aarch64", + zed::Architecture::X86 => "x86", + zed::Architecture::X8664 => "x86_64", + }, + os = match platform { + zed::Os::Mac => "apple-darwin", + zed::Os::Linux => "unknown-linux-gnu", + zed::Os::Windows => "pc-windows-msvc", + } + ); + let asset_name = format!( + "{asset_stem}.{suffix}", + suffix = match platform { + zed::Os::Windows => "zip", + _ => "tar.gz", + } + ); + + 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!("ruff-{}", release.version); + let binary_path = format!("{version_dir}/{asset_stem}/ruff"); + + if !fs::metadata(&binary_path).map_or(false, |stat| stat.is_file()) { + zed::set_language_server_installation_status( + &language_server_id, + &zed::LanguageServerInstallationStatus::Downloading, + ); + let file_kind = match platform { + zed::Os::Windows => zed::DownloadedFileType::Zip, + _ => zed::DownloadedFileType::GzipTar, + }; + zed::download_file(&asset.download_url, &version_dir, file_kind) + .map_err(|e| format!("failed to download file: {e}"))?; + + let entries = + fs::read_dir(".").map_err(|e| format!("failed to list working directory {e}"))?; + for entry in entries { + let entry = entry.map_err(|e| format!("failed to load directory entry {e}"))?; + 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 RuffExtension { + fn new() -> Self { + Self { + cached_binary_path: None, + } + } + + fn language_server_command( + &mut self, + language_server_id: &LanguageServerId, + worktree: &zed::Worktree, + ) -> Result { + Ok(zed::Command { + command: self.language_server_binary_path(language_server_id, worktree)?, + args: vec!["server".into(), "--preview".into()], + env: vec![], + }) + } + + fn language_server_workspace_configuration( + &mut self, + server_id: &LanguageServerId, + worktree: &zed_extension_api::Worktree, + ) -> Result> { + let settings = LspSettings::for_worktree(server_id.as_ref(), worktree) + .ok() + .and_then(|lsp_settings| lsp_settings.settings.clone()) + .unwrap_or_default(); + Ok(Some(settings)) + } +} + +zed::register_extension!(RuffExtension);