From 12b12ba17a380e321d47704d487b5d4cdca7877a Mon Sep 17 00:00:00 2001 From: d1y Date: Mon, 19 Feb 2024 02:44:54 +0800 Subject: [PATCH] Add syntax highlighting and LSP for Dockerfiles(#6905) (#7977) Release Notes: - Added Dockerfile syntax highlighting and LSP support --------- Co-authored-by: Bryce Palmer Co-authored-by: Kirill Bulatov --- Cargo.lock | 10 ++ Cargo.toml | 1 + crates/zed/Cargo.toml | 1 + crates/zed/src/languages.rs | 9 ++ crates/zed/src/languages/dockerfile.rs | 124 ++++++++++++++++++ .../zed/src/languages/dockerfile/config.toml | 9 ++ .../src/languages/dockerfile/highlights.scm | 63 +++++++++ .../src/languages/dockerfile/injections.scm | 6 + docs/src/languages/dockerfile.md | 4 + 9 files changed, 227 insertions(+) create mode 100644 crates/zed/src/languages/dockerfile.rs create mode 100644 crates/zed/src/languages/dockerfile/config.toml create mode 100644 crates/zed/src/languages/dockerfile/highlights.scm create mode 100644 crates/zed/src/languages/dockerfile/injections.scm create mode 100644 docs/src/languages/dockerfile.md diff --git a/Cargo.lock b/Cargo.lock index 79790b0a6d..2a88f523d4 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -10091,6 +10091,15 @@ dependencies = [ "tree-sitter", ] +[[package]] +name = "tree-sitter-dockerfile" +version = "0.1.0" +source = "git+https://github.com/camdencheek/tree-sitter-dockerfile?rev=33e22c33bcdbfc33d42806ee84cfd0b1248cc392#33e22c33bcdbfc33d42806ee84cfd0b1248cc392" +dependencies = [ + "cc", + "tree-sitter", +] + [[package]] name = "tree-sitter-elixir" version = "0.1.0" @@ -11954,6 +11963,7 @@ dependencies = [ "tree-sitter-clojure", "tree-sitter-cpp", "tree-sitter-css", + "tree-sitter-dockerfile", "tree-sitter-elixir", "tree-sitter-elm", "tree-sitter-embedded-template", diff --git a/Cargo.toml b/Cargo.toml index 917447b14a..6a63ded8f1 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -231,6 +231,7 @@ tree-sitter-clojure = { git = "https://github.com/prcastro/tree-sitter-clojure", tree-sitter-c-sharp = { git = "https://github.com/tree-sitter/tree-sitter-c-sharp", rev = "dd5e59721a5f8dae34604060833902b882023aaf" } tree-sitter-cpp = { git = "https://github.com/tree-sitter/tree-sitter-cpp", rev = "f44509141e7e483323d2ec178f2d2e6c0fc041c1" } tree-sitter-css = { git = "https://github.com/tree-sitter/tree-sitter-css", rev = "769203d0f9abe1a9a691ac2b9fe4bb4397a73c51" } +tree-sitter-dockerfile = { git = "https://github.com/camdencheek/tree-sitter-dockerfile", rev = "33e22c33bcdbfc33d42806ee84cfd0b1248cc392" } tree-sitter-elixir = { git = "https://github.com/elixir-lang/tree-sitter-elixir", rev = "a2861e88a730287a60c11ea9299c033c7d076e30" } tree-sitter-elm = { git = "https://github.com/elm-tooling/tree-sitter-elm", rev = "692c50c0b961364c40299e73c1306aecb5d20f40" } tree-sitter-embedded-template = "0.20.0" diff --git a/crates/zed/Cargo.toml b/crates/zed/Cargo.toml index dd0d84ef44..24b63900af 100644 --- a/crates/zed/Cargo.toml +++ b/crates/zed/Cargo.toml @@ -116,6 +116,7 @@ tree-sitter-c.workspace = true tree-sitter-clojure.workspace = true tree-sitter-cpp.workspace = true tree-sitter-css.workspace = true +tree-sitter-dockerfile.workspace = true tree-sitter-elixir.workspace = true tree-sitter-elm.workspace = true tree-sitter-embedded-template.workspace = true diff --git a/crates/zed/src/languages.rs b/crates/zed/src/languages.rs index e5a8f5bac2..aa3f2166c7 100644 --- a/crates/zed/src/languages.rs +++ b/crates/zed/src/languages.rs @@ -15,6 +15,7 @@ mod clojure; mod csharp; mod css; mod deno; +mod dockerfile; mod elixir; mod elm; mod erlang; @@ -73,6 +74,7 @@ pub fn init( ("clojure", tree_sitter_clojure::language()), ("cpp", tree_sitter_cpp::language()), ("css", tree_sitter_css::language()), + ("dockerfile", tree_sitter_dockerfile::language()), ("elixir", tree_sitter_elixir::language()), ("elm", tree_sitter_elm::language()), ( @@ -151,6 +153,13 @@ pub fn init( ], ); + language( + "dockerfile", + vec![Arc::new(dockerfile::DockerfileLspAdapter::new( + node_runtime.clone(), + ))], + ); + match &ElixirSettings::get(None, cx).lsp { elixir::ElixirLspSetting::ElixirLs => language( "elixir", diff --git a/crates/zed/src/languages/dockerfile.rs b/crates/zed/src/languages/dockerfile.rs new file mode 100644 index 0000000000..9ffbeee946 --- /dev/null +++ b/crates/zed/src/languages/dockerfile.rs @@ -0,0 +1,124 @@ +use anyhow::{anyhow, Result}; +use async_trait::async_trait; +use futures::StreamExt; +use language::{LanguageServerName, LspAdapter, LspAdapterDelegate}; +use lsp::LanguageServerBinary; +use node_runtime::NodeRuntime; +use smol::fs; +use std::{ + any::Any, + ffi::OsString, + path::{Path, PathBuf}, + sync::Arc, +}; +use util::{async_maybe, ResultExt}; + +const SERVER_PATH: &'static str = + "node_modules/dockerfile-language-server-nodejs/bin/docker-langserver"; + +fn server_binary_arguments(server_path: &Path) -> Vec { + vec![server_path.into(), "--stdio".into()] +} + +pub struct DockerfileLspAdapter { + node: Arc, +} + +impl DockerfileLspAdapter { + pub fn new(node: Arc) -> Self { + Self { node } + } +} + +#[async_trait] +impl LspAdapter for DockerfileLspAdapter { + fn name(&self) -> LanguageServerName { + LanguageServerName("docker-langserver".into()) + } + + fn short_name(&self) -> &'static str { + "dockerfile" + } + + async fn fetch_latest_server_version( + &self, + _: &dyn LspAdapterDelegate, + ) -> Result> { + Ok(Box::new( + self.node + .npm_package_latest_version("dockerfile-language-server-nodejs") + .await?, + ) as Box<_>) + } + + async fn fetch_server_binary( + &self, + version: Box, + container_dir: PathBuf, + _: &dyn LspAdapterDelegate, + ) -> Result { + let version = version.downcast::().unwrap(); + let server_path = container_dir.join(SERVER_PATH); + + if fs::metadata(&server_path).await.is_err() { + self.node + .npm_install_packages( + &container_dir, + &[("dockerfile-language-server-nodejs", version.as_str())], + ) + .await?; + } + + Ok(LanguageServerBinary { + path: self.node.binary_path().await?, + arguments: server_binary_arguments(&server_path), + }) + } + + async fn cached_server_binary( + &self, + container_dir: PathBuf, + _: &dyn LspAdapterDelegate, + ) -> Option { + get_cached_server_binary(container_dir, &*self.node).await + } + + async fn installation_test_binary( + &self, + container_dir: PathBuf, + ) -> Option { + get_cached_server_binary(container_dir, &*self.node).await + } +} + +async fn get_cached_server_binary( + container_dir: PathBuf, + node: &dyn NodeRuntime, +) -> Option { + async_maybe!({ + let mut last_version_dir = None; + let mut entries = fs::read_dir(&container_dir).await?; + while let Some(entry) = entries.next().await { + let entry = entry?; + if entry.file_type().await?.is_dir() { + last_version_dir = Some(entry.path()); + } + } + + let last_version_dir = last_version_dir.ok_or_else(|| anyhow!("no cached binary"))?; + let server_path = last_version_dir.join(SERVER_PATH); + if server_path.exists() { + Ok(LanguageServerBinary { + path: node.binary_path().await?, + arguments: server_binary_arguments(&server_path), + }) + } else { + Err(anyhow!( + "missing executable in directory {:?}", + last_version_dir + )) + } + }) + .await + .log_err() +} diff --git a/crates/zed/src/languages/dockerfile/config.toml b/crates/zed/src/languages/dockerfile/config.toml new file mode 100644 index 0000000000..afddf08b02 --- /dev/null +++ b/crates/zed/src/languages/dockerfile/config.toml @@ -0,0 +1,9 @@ +name = "Dockerfile" +grammar = "dockerfile" +path_suffixes = ["Dockerfile"] +line_comments = ["# "] +brackets = [ + { start = "{", end = "}", close = true, newline = true }, + { start = "[", end = "]", close = true, newline = true }, + { start = "\"", end = "\"", close = true, newline = false, not_in = ["string"] }, +] diff --git a/crates/zed/src/languages/dockerfile/highlights.scm b/crates/zed/src/languages/dockerfile/highlights.scm new file mode 100644 index 0000000000..fbe9427dce --- /dev/null +++ b/crates/zed/src/languages/dockerfile/highlights.scm @@ -0,0 +1,63 @@ +; Dockerfile instructions set taken from: +; https://docs.docker.com/engine/reference/builder/#overview +; https://github.com/helix-editor/helix/blob/78c34194b5c83beb26ca04f12bf9d53fd5aba801/runtime/queries/dockerfile/highlights.scm +[ + "ADD" + "ARG" + "CMD" + "COPY" + "ENTRYPOINT" + "ENV" + "EXPOSE" + "FROM" + "HEALTHCHECK" + "LABEL" + "MAINTAINER" + "ONBUILD" + "RUN" + "SHELL" + "STOPSIGNAL" + "USER" + "VOLUME" + "WORKDIR" + + ; "as" for multi-stage builds + "AS" +] @keyword + +[ + ":" + "@" +] @operator + +(comment) @comment + +(image_spec + (image_tag + ":" @punctuation.special) + (image_digest + "@" @punctuation.special)) + +[ + (double_quoted_string) + (single_quoted_string) + (json_string) +] @string + +[ + (env_pair) + (label_pair) +] @constant + +[ + (param) + (mount_param) +] @function + +(expansion + [ + "$" + "{" + "}" + ] @punctuation.special +) @constant diff --git a/crates/zed/src/languages/dockerfile/injections.scm b/crates/zed/src/languages/dockerfile/injections.scm new file mode 100644 index 0000000000..50c7294b6d --- /dev/null +++ b/crates/zed/src/languages/dockerfile/injections.scm @@ -0,0 +1,6 @@ +; We need impl this +; ((comment) @injection.content +; (#set! injection.language "comment")) + +((shell_command) @content + (#set! "language" "bash")) diff --git a/docs/src/languages/dockerfile.md b/docs/src/languages/dockerfile.md new file mode 100644 index 0000000000..76c05ff6a6 --- /dev/null +++ b/docs/src/languages/dockerfile.md @@ -0,0 +1,4 @@ +# Dockerfile + +- Tree Sitter: [tree-sitter-dockerfile](https://github.com/camdencheek/tree-sitter-dockerfile) +- Language Server: [dockerfile-language-server](https://github.com/rcjsuen/dockerfile-language-server)