Skip to content

armgit / zed

Public Imported from GitHub
0

Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.

languages: Stop treating .env files as shell scripts (#64242)

PleahMaCakacad56bd65ac5
diff --git a/assets/settings/default.json b/assets/settings/default.json
index 40173f5840e..fe87add3b99 100644
--- a/assets/settings/default.json
+++ b/assets/settings/default.json
@@ -2314,7 +2314,7 @@
"tsconfig*.json",
],
"Markdown": [".rules", ".cursorrules", ".windsurfrules", ".clinerules"],
- "Shell Script": [".env.*"],
+ "Env": [".env.*"],
},
// Settings for which version of Node.js and NPM to use when installing
// language servers and Copilot.
diff --git a/crates/edit_prediction_cli/src/filter_languages.rs b/crates/edit_prediction_cli/src/filter_languages.rs
index 1379f543452..a6cf1ce9327 100644
--- a/crates/edit_prediction_cli/src/filter_languages.rs
+++ b/crates/edit_prediction_cli/src/filter_languages.rs
@@ -506,11 +506,8 @@ mod tests {
detect_language("project/PKGBUILD", &map),
Some("Shell Script".to_string())
);
- // .env files are also Shell Script
- assert_eq!(
- detect_language(".env", &map),
- Some("Shell Script".to_string())
- );
+ // .env files hold data, not shell scripts
+ assert_eq!(detect_language(".env", &map), Some("Env".to_string()));
// Gentoo ebuild files are a subset of bash
assert_eq!(
detect_language("app-editors/zed-1.5.4.ebuild", &map),
diff --git a/crates/grammars/src/bash/config.toml b/crates/grammars/src/bash/config.toml
index 193a515f871..ebaca29cb86 100644
--- a/crates/grammars/src/bash/config.toml
+++ b/crates/grammars/src/bash/config.toml
@@ -1,7 +1,7 @@
name = "Shell Script"
code_fence_block_name = "bash"
grammar = "bash"
-path_suffixes = ["sh", "bash", "bashrc", "bash_profile", "bash_aliases", "bash_login", "bash_logout", "brushrc", "bats", "envrc", "profile", "zsh", "zshrc", "zshenv", "zsh_profile", "zsh_aliases", "zsh_histfile", "zlogin", "zprofile", ".env", "PKGBUILD", "APKBUILD", "ebuild"]
+path_suffixes = ["sh", "bash", "bashrc", "bash_profile", "bash_aliases", "bash_login", "bash_logout", "brushrc", "bats", "envrc", "profile", "zsh", "zshrc", "zshenv", "zsh_profile", "zsh_aliases", "zsh_histfile", "zlogin", "zprofile", "PKGBUILD", "APKBUILD", "ebuild"]
modeline_aliases = ["sh", "shell", "shell-script", "zsh"]
line_comments = ["# "]
first_line_pattern = '^#!.*\b(?:ash|bash|bats|dash|sh|zsh)\b'
diff --git a/crates/grammars/src/env/brackets.scm b/crates/grammars/src/env/brackets.scm
new file mode 100644
index 00000000000..09b438ef9ef
--- /dev/null
+++ b/crates/grammars/src/env/brackets.scm
@@ -0,0 +1,6 @@
+("{" @open
+ "}" @close)
+
+(("\"" @open
+ "\"" @close)
+ (#set! rainbow.exclude))
diff --git a/crates/grammars/src/env/config.toml b/crates/grammars/src/env/config.toml
new file mode 100644
index 00000000000..f3e52fefbe2
--- /dev/null
+++ b/crates/grammars/src/env/config.toml
@@ -0,0 +1,10 @@
+name = "Env"
+grammar = "bash"
+path_suffixes = [".env"]
+line_comments = ["# "]
+autoclose_before = "}"
+brackets = [
+ { start = "{", end = "}", close = true, newline = false },
+ { start = "\"", end = "\"", close = true, newline = false, not_in = ["comment", "string"] },
+ { start = "'", end = "'", close = true, newline = false, not_in = ["string", "comment"] },
+]
diff --git a/crates/grammars/src/env/highlights.scm b/crates/grammars/src/env/highlights.scm
new file mode 100644
index 00000000000..a1220e053f4
--- /dev/null
+++ b/crates/grammars/src/env/highlights.scm
@@ -0,0 +1,42 @@
+[
+ (string)
+ (raw_string)
+ (ansi_c_string)
+ (word)
+] @string
+
+(variable_name) @variable
+
+(special_variable_name) @variable.special
+
+"export" @keyword
+
+(comment) @comment
+
+(number) @number
+
+[
+ (command_substitution)
+ (expansion)
+] @embedded
+
+[
+ "$"
+ "="
+] @operator
+
+[
+ "{"
+ "}"
+] @punctuation.bracket
+
+(simple_expansion
+ "$" @punctuation.special)
+
+(expansion
+ "${" @punctuation.special
+ "}" @punctuation.special) @embedded
+
+(command_substitution
+ "$(" @punctuation.special
+ ")" @punctuation.special)
diff --git a/crates/grammars/src/env/injections.scm b/crates/grammars/src/env/injections.scm
new file mode 100644
index 00000000000..2f0e58eb643
--- /dev/null
+++ b/crates/grammars/src/env/injections.scm
@@ -0,0 +1,2 @@
+((comment) @injection.content
+ (#set! injection.language "comment"))
diff --git a/crates/grammars/src/env/overrides.scm b/crates/grammars/src/env/overrides.scm
new file mode 100644
index 00000000000..544e9876f8e
--- /dev/null
+++ b/crates/grammars/src/env/overrides.scm
@@ -0,0 +1,3 @@
+(comment) @comment.inclusive
+
+(string) @string
diff --git a/crates/grammars/src/env/redactions.scm b/crates/grammars/src/env/redactions.scm
new file mode 100644
index 00000000000..5c2c83aa666
--- /dev/null
+++ b/crates/grammars/src/env/redactions.scm
@@ -0,0 +1,2 @@
+(variable_assignment
+ value: (_) @redact)
diff --git a/crates/languages/Cargo.toml b/crates/languages/Cargo.toml
index 17ed9024fda..a21f473ffae 100644
--- a/crates/languages/Cargo.toml
+++ b/crates/languages/Cargo.toml
@@ -69,6 +69,7 @@ util.workspace = true
[dev-dependencies]
fs = { workspace = true, features = ["test-support"] }
+language = { workspace = true, features = ["test-support"] }
pretty_assertions.workspace = true
tempfile = { workspace = true}
settings = { workspace = true, features = ["test-support"] }
diff --git a/crates/languages/src/lib.rs b/crates/languages/src/lib.rs
index b3993ee4811..a449ae34fe8 100644
--- a/crates/languages/src/lib.rs
+++ b/crates/languages/src/lib.rs
@@ -115,6 +115,11 @@ pub fn init(languages: Arc<LanguageRegistry>, fs: Arc<dyn Fs>, node: NodeRuntime
adapters: vec![],
..Default::default()
},
+ LanguageInfo {
+ name: "env",
+ adapters: vec![],
+ ..Default::default()
+ },
LanguageInfo {
name: "go",
adapters: vec![go_lsp_adapter.clone()],
@@ -395,3 +400,38 @@ fn load_config(name: &str) -> LanguageConfig {
let grammars_loaded = cfg!(any(feature = "load-grammars", test));
grammars::load_config_for_feature(name, grammars_loaded)
}
+
+#[cfg(test)]
+mod tests {
+ use gpui::App;
+ use language::{File, LanguageRegistry, TestFile};
+ use settings::SettingsStore;
+ use std::sync::Arc;
+ use util::rel_path::rel_path;
+
+ #[gpui::test]
+ fn test_env_files_are_not_shell_scripts(cx: &mut App) {
+ let settings_store = SettingsStore::test(cx);
+ cx.set_global(settings_store);
+
+ let registry = Arc::new(LanguageRegistry::test(cx.background_executor().clone()));
+ registry.add(crate::language("env", tree_sitter_bash::LANGUAGE.into()));
+ registry.add(crate::language("bash", tree_sitter_bash::LANGUAGE.into()));
+
+ let language_of = |path: &str, cx: &App| {
+ let file: Arc<dyn File> = Arc::new(TestFile {
+ path: Arc::from(rel_path(path)),
+ root_name: "zed".into(),
+ local_root: None,
+ });
+
+ registry
+ .language_for_file(&file, None, cx)
+ .and_then(|id| registry.language_name_for_id(id))
+ };
+
+ assert_eq!(language_of(".env", cx), Some("Env".into()));
+ assert_eq!(language_of(".envrc", cx), Some("Shell Script".into()));
+ assert_eq!(language_of("deploy.sh", cx), Some("Shell Script".into()));
+ }
+}
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
index 44c42fc3cc7..e1fb975e898 100644
--- a/docs/src/SUMMARY.md
+++ b/docs/src/SUMMARY.md
@@ -131,6 +131,7 @@
- [Elixir](./languages/elixir.md)
- [Elm](./languages/elm.md)
- [Emmet](./languages/emmet.md)
+- [Env](./languages/env.md)
- [Erlang](./languages/erlang.md)
- [Fish](./languages/fish.md)
- [GDScript](./languages/gdscript.md)
diff --git a/docs/src/languages.md b/docs/src/languages.md
index 4c471ef5dd3..0453452bcca 100644
--- a/docs/src/languages.md
+++ b/docs/src/languages.md
@@ -29,6 +29,7 @@ Some work out-of-the-box and others rely on [3rd party extensions](./extensions/
- [Elixir](./languages/elixir.md)
- [Elm](./languages/elm.md)
- [Emmet](./languages/emmet.md)
+- [Env](./languages/env.md) \*
- [Erlang](./languages/erlang.md)
- [Fish](./languages/fish.md)
- [GDScript](./languages/gdscript.md)
diff --git a/docs/src/languages/env.md b/docs/src/languages/env.md
new file mode 100644
index 00000000000..02e97746e69
--- /dev/null
+++ b/docs/src/languages/env.md
@@ -0,0 +1,34 @@
+---
+title: Env
+description: "Configure Env language support in Zed, including file type detection and highlighting."
+---
+
+# Env
+
+Env support is available natively in Zed.
+
+- Tree-sitter: [tree-sitter/tree-sitter-bash](https://github.com/tree-sitter/tree-sitter-bash)
+
+Zed recognizes `.env` and `.env.*` files as Env. Files named `.envrc` are [Shell Script](./sh.md), because [`direnv`](https://direnv.net) executes them as shell.
+
+## Configuration
+
+Env files are highlighted but no language server is started for them. To run shell tooling on them, map them to Shell Script in your Zed settings.json:
+
+```json [settings]
+ "file_types": {
+ "Shell Script": [".env", ".env.*"]
+ },
+```
+
+To recognize other file names as Env files:
+
+```json [settings]
+ "file_types": {
+ "Env": ["*.dotenv"]
+ },
+```
+
+## See also:
+
+- [Zed Docs: Language Support: Shell Script](./sh.md)
diff --git a/docs/src/languages/sh.md b/docs/src/languages/sh.md
index b122274673c..de413f6bfe1 100644
--- a/docs/src/languages/sh.md
+++ b/docs/src/languages/sh.md
@@ -64,4 +64,5 @@ shfmt --version
## See also:
- [Zed Docs: Language Support: Bash](./bash.md)
+- [Zed Docs: Language Support: Env](./env.md)
- [Zed Docs: Language Support: Fish](./fish.md)
diff --git a/docs/src/reference/all-settings.md b/docs/src/reference/all-settings.md
index a247070f8b7..46e9643e76e 100644
--- a/docs/src/reference/all-settings.md
+++ b/docs/src/reference/all-settings.md
@@ -2492,7 +2492,7 @@ When set to `expanded`, symbolic links are only scanned after you explicitly exp
"**/Zed/**/*.json",
"**/.vscode/**/*.json"
],
- "Shell Script": [".env.*"]
+ "Env": [".env.*"]
}
}
```