Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

extensions: Add Ruff extension #14198

Merged
merged 4 commits into from
Jul 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ members = [
"extensions/php",
"extensions/prisma",
"extensions/purescript",
"extensions/ruff",
"extensions/ruby",
"extensions/snippets",
"extensions/svelte",
Expand Down
16 changes: 16 additions & 0 deletions extensions/ruff/Cargo.toml
Original file line number Diff line number Diff line change
@@ -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"
1 change: 1 addition & 0 deletions extensions/ruff/LICENSE-APACHE
11 changes: 11 additions & 0 deletions extensions/ruff/extension.toml
Original file line number Diff line number Diff line change
@@ -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"]
122 changes: 122 additions & 0 deletions extensions/ruff/src/ruff.rs
Original file line number Diff line number Diff line change
@@ -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<String>,
}

impl RuffExtension {
fn language_server_binary_path(
&mut self,
language_server_id: &LanguageServerId,
worktree: &zed::Worktree,
) -> Result<String> {
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<zed::Command> {
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<Option<zed_extension_api::serde_json::Value>> {
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);
Loading