1//! Baseline interface of Tasks in Zed: all tasks in Zed are intended to use those for implementing their own logic.
2
3mod adapter_schema;
4mod debug_format;
5mod serde_helpers;
6pub mod static_source;
7mod task_template;
8mod vscode_debug_format;
9mod vscode_format;
10
11use anyhow::Context as _;
12use collections::{HashMap, HashSet, hash_map};
13use gpui::SharedString;
14use serde::{Deserialize, Serialize};
15use std::borrow::Cow;
16use std::path::PathBuf;
17use std::str::FromStr;
18use std::sync::Arc;
19
20pub use adapter_schema::{AdapterSchema, AdapterSchemas};
21pub use debug_format::{
22 AttachRequest, BuildTaskDefinition, DebugRequest, DebugScenario, DebugTaskFile, LaunchRequest,
23 Request, TcpArgumentsTemplate, ZedDebugConfig,
24};
25pub use task_template::{
26 DebugArgsRequest, HideStrategy, RevealStrategy, TaskTemplate, TaskTemplates,
27 substitute_variables_in_map, substitute_variables_in_str,
28};
29pub use util::shell::{Shell, ShellKind};
30pub use util::shell_builder::ShellBuilder;
31pub use vscode_debug_format::VsCodeDebugTaskFile;
32pub use vscode_format::VsCodeTaskFile;
33pub use zed_actions::RevealTarget;
34
35/// Task identifier, unique within the application.
36/// Based on it, task reruns and terminal tabs are managed.
37#[derive(Default, Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, Deserialize)]
38pub struct TaskId(pub String);
39
40/// Contains all information needed by Zed to spawn a new terminal tab for the given task.
41#[derive(Default, Debug, Clone, PartialEq, Eq)]
42pub struct SpawnInTerminal {
43 /// Id of the task to use when determining task tab affinity.
44 pub id: TaskId,
45 /// Full unshortened form of `label` field.
46 pub full_label: String,
47 /// Human readable name of the terminal tab.
48 pub label: String,
49 /// Executable command to spawn.
50 pub command: Option<String>,
51 /// Arguments to the command, potentially unsubstituted,
52 /// to let the shell that spawns the command to do the substitution, if needed.
53 pub args: Vec<String>,
54 /// A human-readable label, containing command and all of its arguments, joined and substituted.
55 pub command_label: String,
56 /// Current working directory to spawn the command into.
57 pub cwd: Option<PathBuf>,
58 /// Env overrides for the command, will be appended to the terminal's environment from the settings.
59 pub env: HashMap<String, String>,
60 /// Whether to use a new terminal tab or reuse the existing one to spawn the process.
61 pub use_new_terminal: bool,
62 /// Whether to allow multiple instances of the same task to be run, or rather wait for the existing ones to finish.
63 pub allow_concurrent_runs: bool,
64 /// What to do with the terminal pane and tab, after the command was started.
65 pub reveal: RevealStrategy,
66 /// Where to show tasks' terminal output.
67 pub reveal_target: RevealTarget,
68 /// What to do with the terminal pane and tab, after the command had finished.
69 pub hide: HideStrategy,
70 /// Which shell to use when spawning the task.
71 pub shell: Shell,
72 /// Whether to show the task summary line in the task output (sucess/failure).
73 pub show_summary: bool,
74 /// Whether to show the command line in the task output.
75 pub show_command: bool,
76 /// Whether to show the rerun button in the terminal tab.
77 pub show_rerun: bool,
78}
79
80impl SpawnInTerminal {
81 pub fn to_proto(&self) -> proto::SpawnInTerminal {
82 proto::SpawnInTerminal {
83 label: self.label.clone(),
84 command: self.command.clone(),
85 args: self.args.clone(),
86 env: self
87 .env
88 .iter()
89 .map(|(k, v)| (k.clone(), v.clone()))
90 .collect(),
91 cwd: self
92 .cwd
93 .clone()
94 .map(|cwd| cwd.to_string_lossy().into_owned()),
95 }
96 }
97
98 pub fn from_proto(proto: proto::SpawnInTerminal) -> Self {
99 Self {
100 label: proto.label.clone(),
101 command: proto.command.clone(),
102 args: proto.args.clone(),
103 env: proto.env.into_iter().collect(),
104 cwd: proto.cwd.map(PathBuf::from),
105 ..Default::default()
106 }
107 }
108}
109
110/// A final form of the [`TaskTemplate`], that got resolved with a particular [`TaskContext`] and now is ready to spawn the actual task.
111#[derive(Clone, Debug, PartialEq, Eq)]
112pub struct ResolvedTask {
113 /// A way to distinguish tasks produced by the same template, but different contexts.
114 /// NOTE: Resolved tasks may have the same labels, commands and do the same things,
115 /// but still may have different ids if the context was different during the resolution.
116 /// Since the template has `env` field, for a generic task that may be a bash command,
117 /// so it's impossible to determine the id equality without more context in a generic case.
118 pub id: TaskId,
119 /// A template the task got resolved from.
120 original_task: TaskTemplate,
121 /// Full, unshortened label of the task after all resolutions are made.
122 pub resolved_label: String,
123 /// Variables that were substituted during the task template resolution.
124 substituted_variables: HashSet<VariableName>,
125 /// Further actions that need to take place after the resolved task is spawned,
126 /// with all task variables resolved.
127 pub resolved: SpawnInTerminal,
128}
129
130impl ResolvedTask {
131 /// A task template before the resolution.
132 pub fn original_task(&self) -> &TaskTemplate {
133 &self.original_task
134 }
135
136 /// Variables that were substituted during the task template resolution.
137 pub fn substituted_variables(&self) -> &HashSet<VariableName> {
138 &self.substituted_variables
139 }
140
141 /// A human-readable label to display in the UI.
142 pub fn display_label(&self) -> &str {
143 self.resolved.label.as_str()
144 }
145}
146
147/// Variables, available for use in [`TaskContext`] when a Zed's [`TaskTemplate`] gets resolved into a [`ResolvedTask`].
148/// Name of the variable must be a valid shell variable identifier, which generally means that it is
149/// a word consisting only of alphanumeric characters and underscores,
150/// and beginning with an alphabetic character or an underscore.
151#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize)]
152pub enum VariableName {
153 /// An absolute path of the currently opened file.
154 File,
155 /// A path of the currently opened file (relative to worktree root).
156 RelativeFile,
157 /// A path of the currently opened file's directory (relative to worktree root).
158 RelativeDir,
159 /// The currently opened filename.
160 Filename,
161 /// The path to a parent directory of a currently opened file.
162 Dirname,
163 /// Stem (filename without extension) of the currently opened file.
164 Stem,
165 /// An absolute path of the currently opened worktree, that contains the file.
166 WorktreeRoot,
167 /// A symbol text, that contains latest cursor/selection position.
168 Symbol,
169 /// A row with the latest cursor/selection position.
170 Row,
171 /// A column with the latest cursor/selection position.
172 Column,
173 /// Text from the latest selection.
174 SelectedText,
175 /// The symbol selected by the symbol tagging system, specifically the @run capture in a runnables.scm
176 RunnableSymbol,
177 /// Open a Picker to select a process ID to use in place
178 /// Can only be used to debug configurations
179 PickProcessId,
180 /// Custom variable, provided by the plugin or other external source.
181 /// Will be printed with `CUSTOM_` prefix to avoid potential conflicts with other variables.
182 Custom(Cow<'static, str>),
183}
184
185impl VariableName {
186 /// Generates a `$VARIABLE`-like string value to be used in templates.
187 pub fn template_value(&self) -> String {
188 format!("${self}")
189 }
190 /// Generates a `"$VARIABLE"`-like string, to be used instead of `Self::template_value` when expanded value could contain spaces or special characters.
191 pub fn template_value_with_whitespace(&self) -> String {
192 format!("\"${self}\"")
193 }
194}
195
196impl FromStr for VariableName {
197 type Err = ();
198
199 fn from_str(s: &str) -> Result<Self, Self::Err> {
200 let without_prefix = s.strip_prefix(ZED_VARIABLE_NAME_PREFIX).ok_or(())?;
201 let value = match without_prefix {
202 "FILE" => Self::File,
203 "FILENAME" => Self::Filename,
204 "RELATIVE_FILE" => Self::RelativeFile,
205 "RELATIVE_DIR" => Self::RelativeDir,
206 "DIRNAME" => Self::Dirname,
207 "STEM" => Self::Stem,
208 "WORKTREE_ROOT" => Self::WorktreeRoot,
209 "SYMBOL" => Self::Symbol,
210 "RUNNABLE_SYMBOL" => Self::RunnableSymbol,
211 "SELECTED_TEXT" => Self::SelectedText,
212 "ROW" => Self::Row,
213 "COLUMN" => Self::Column,
214 _ => {
215 if let Some(custom_name) =
216 without_prefix.strip_prefix(ZED_CUSTOM_VARIABLE_NAME_PREFIX)
217 {
218 Self::Custom(Cow::Owned(custom_name.to_owned()))
219 } else {
220 return Err(());
221 }
222 }
223 };
224 Ok(value)
225 }
226}
227
228/// A prefix that all [`VariableName`] variants are prefixed with when used in environment variables and similar template contexts.
229pub const ZED_VARIABLE_NAME_PREFIX: &str = "ZED_";
230const ZED_CUSTOM_VARIABLE_NAME_PREFIX: &str = "CUSTOM_";
231
232impl std::fmt::Display for VariableName {
233 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
234 match self {
235 Self::File => write!(f, "{ZED_VARIABLE_NAME_PREFIX}FILE"),
236 Self::Filename => write!(f, "{ZED_VARIABLE_NAME_PREFIX}FILENAME"),
237 Self::RelativeFile => write!(f, "{ZED_VARIABLE_NAME_PREFIX}RELATIVE_FILE"),
238 Self::RelativeDir => write!(f, "{ZED_VARIABLE_NAME_PREFIX}RELATIVE_DIR"),
239 Self::Dirname => write!(f, "{ZED_VARIABLE_NAME_PREFIX}DIRNAME"),
240 Self::Stem => write!(f, "{ZED_VARIABLE_NAME_PREFIX}STEM"),
241 Self::WorktreeRoot => write!(f, "{ZED_VARIABLE_NAME_PREFIX}WORKTREE_ROOT"),
242 Self::Symbol => write!(f, "{ZED_VARIABLE_NAME_PREFIX}SYMBOL"),
243 Self::Row => write!(f, "{ZED_VARIABLE_NAME_PREFIX}ROW"),
244 Self::Column => write!(f, "{ZED_VARIABLE_NAME_PREFIX}COLUMN"),
245 Self::SelectedText => write!(f, "{ZED_VARIABLE_NAME_PREFIX}SELECTED_TEXT"),
246 Self::RunnableSymbol => write!(f, "{ZED_VARIABLE_NAME_PREFIX}RUNNABLE_SYMBOL"),
247 Self::PickProcessId => write!(f, "{ZED_VARIABLE_NAME_PREFIX}PICK_PID"),
248 Self::Custom(s) => write!(
249 f,
250 "{ZED_VARIABLE_NAME_PREFIX}{ZED_CUSTOM_VARIABLE_NAME_PREFIX}{s}"
251 ),
252 }
253 }
254}
255
256/// Container for predefined environment variables that describe state of Zed at the time the task was spawned.
257#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize)]
258pub struct TaskVariables(HashMap<VariableName, String>);
259
260impl TaskVariables {
261 /// Inserts another variable into the container, overwriting the existing one if it already exists — in this case, the old value is returned.
262 pub fn insert(&mut self, variable: VariableName, value: String) -> Option<String> {
263 self.0.insert(variable, value)
264 }
265
266 /// Extends the container with another one, overwriting the existing variables on collision.
267 pub fn extend(&mut self, other: Self) {
268 self.0.extend(other.0);
269 }
270 /// Get the value associated with given variable name, if there is one.
271 pub fn get(&self, key: &VariableName) -> Option<&str> {
272 self.0.get(key).map(|s| s.as_str())
273 }
274 /// Clear out variables obtained from tree-sitter queries, which are prefixed with '_' character
275 pub fn sweep(&mut self) {
276 self.0.retain(|name, _| {
277 if let VariableName::Custom(name) = name {
278 !name.starts_with('_')
279 } else {
280 true
281 }
282 })
283 }
284
285 pub fn iter(&self) -> impl Iterator<Item = (&VariableName, &String)> {
286 self.0.iter()
287 }
288}
289
290impl FromIterator<(VariableName, String)> for TaskVariables {
291 fn from_iter<T: IntoIterator<Item = (VariableName, String)>>(iter: T) -> Self {
292 Self(HashMap::from_iter(iter))
293 }
294}
295
296impl IntoIterator for TaskVariables {
297 type Item = (VariableName, String);
298
299 type IntoIter = hash_map::IntoIter<VariableName, String>;
300
301 fn into_iter(self) -> Self::IntoIter {
302 self.0.into_iter()
303 }
304}
305
306/// Keeps track of the file associated with a task and context of tasks execution (i.e. current file or current function).
307/// Keeps all Zed-related state inside, used to produce a resolved task out of its template.
308#[derive(Clone, Debug, Default, PartialEq, Eq)]
309pub struct TaskContext {
310 /// A path to a directory in which the task should be executed.
311 pub cwd: Option<PathBuf>,
312 /// Additional environment variables associated with a given task.
313 pub task_variables: TaskVariables,
314 /// Environment variables obtained when loading the project into Zed.
315 /// This is the environment one would get when `cd`ing in a terminal
316 /// into the project's root directory.
317 pub project_env: HashMap<String, String>,
318}
319
320/// A shared reference to a [`TaskContext`], used to avoid cloning the context multiple times.
321#[derive(Clone, Debug, Default)]
322pub struct SharedTaskContext(Arc<TaskContext>);
323
324impl std::ops::Deref for SharedTaskContext {
325 type Target = TaskContext;
326
327 fn deref(&self) -> &Self::Target {
328 &self.0
329 }
330}
331
332impl From<TaskContext> for SharedTaskContext {
333 fn from(context: TaskContext) -> Self {
334 Self(Arc::new(context))
335 }
336}
337
338/// This is a new type representing a 'tag' on a 'runnable symbol', typically a test of main() function, found via treesitter.
339#[derive(Clone, Debug)]
340pub struct RunnableTag(pub SharedString);
341
342pub fn shell_from_proto(proto: proto::Shell) -> anyhow::Result<Shell> {
343 let shell_type = proto.shell_type.context("invalid shell type")?;
344 let shell = match shell_type {
345 proto::shell::ShellType::System(_) => Shell::System,
346 proto::shell::ShellType::Program(program) => Shell::Program(program),
347 proto::shell::ShellType::WithArguments(program) => Shell::WithArguments {
348 program: program.program,
349 args: program.args,
350 title_override: None,
351 },
352 };
353 Ok(shell)
354}
355
356pub fn shell_to_proto(shell: Shell) -> proto::Shell {
357 let shell_type = match shell {
358 Shell::System => proto::shell::ShellType::System(proto::System {}),
359 Shell::Program(program) => proto::shell::ShellType::Program(program),
360 Shell::WithArguments {
361 program,
362 args,
363 title_override: _,
364 } => proto::shell::ShellType::WithArguments(proto::shell::WithArguments { program, args }),
365 };
366 proto::Shell {
367 shell_type: Some(shell_type),
368 }
369}
370
371type VsCodeEnvVariable = String;
372type VsCodeCommand = String;
373type ZedEnvVariable = String;
374
375struct EnvVariableReplacer {
376 variables: HashMap<VsCodeEnvVariable, ZedEnvVariable>,
377 commands: HashMap<VsCodeCommand, ZedEnvVariable>,
378}
379
380impl EnvVariableReplacer {
381 fn new(variables: HashMap<VsCodeEnvVariable, ZedEnvVariable>) -> Self {
382 Self {
383 variables,
384 commands: HashMap::default(),
385 }
386 }
387
388 fn with_commands(
389 mut self,
390 commands: impl IntoIterator<Item = (VsCodeCommand, ZedEnvVariable)>,
391 ) -> Self {
392 self.commands = commands.into_iter().collect();
393 self
394 }
395
396 fn replace_value(&self, input: serde_json::Value) -> serde_json::Value {
397 match input {
398 serde_json::Value::String(s) => serde_json::Value::String(self.replace(&s)),
399 serde_json::Value::Array(arr) => {
400 serde_json::Value::Array(arr.into_iter().map(|v| self.replace_value(v)).collect())
401 }
402 serde_json::Value::Object(obj) => serde_json::Value::Object(
403 obj.into_iter()
404 .map(|(k, v)| (self.replace(&k), self.replace_value(v)))
405 .collect(),
406 ),
407 _ => input,
408 }
409 }
410 // Replaces occurrences of VsCode-specific environment variables with Zed equivalents.
411 fn replace(&self, input: &str) -> String {
412 shellexpand::env_with_context_no_errors(&input, |var: &str| {
413 // Colons denote a default value in case the variable is not set. We want to preserve that default, as otherwise shellexpand will substitute it for us.
414 let colon_position = var.find(':').unwrap_or(var.len());
415 let (left, right) = var.split_at(colon_position);
416 if left == "env" && !right.is_empty() {
417 let variable_name = &right[1..];
418 return Some(format!("${{{variable_name}}}"));
419 } else if left == "command" && !right.is_empty() {
420 let command_name = &right[1..];
421 if let Some(replacement_command) = self.commands.get(command_name) {
422 return Some(format!("${{{replacement_command}}}"));
423 }
424 }
425
426 let (variable_name, default) = (left, right);
427 let append_previous_default = |ret: &mut String| {
428 if !default.is_empty() {
429 ret.push_str(default);
430 }
431 };
432 if let Some(substitution) = self.variables.get(variable_name) {
433 // Got a VSCode->Zed hit, perform a substitution
434 let mut name = format!("${{{substitution}");
435 append_previous_default(&mut name);
436 name.push('}');
437 return Some(name);
438 }
439 // This is an unknown variable.
440 // We should not error out, as they may come from user environment (e.g. $PATH). That means that the variable substitution might not be perfect.
441 // If there's a default, we need to return the string verbatim as otherwise shellexpand will apply that default for us.
442 if !default.is_empty() {
443 return Some(format!("${{{var}}}"));
444 }
445 // Else we can just return None and that variable will be left as is.
446 None
447 })
448 .into_owned()
449 }
450}