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, SaveStrategy, 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 /// Which edited buffers to save before running the task.
79 pub save: SaveStrategy,
80}
81
82impl SpawnInTerminal {
83 pub fn to_proto(&self) -> proto::SpawnInTerminal {
84 proto::SpawnInTerminal {
85 label: self.label.clone(),
86 command: self.command.clone(),
87 args: self.args.clone(),
88 env: self
89 .env
90 .iter()
91 .map(|(k, v)| (k.clone(), v.clone()))
92 .collect(),
93 cwd: self
94 .cwd
95 .clone()
96 .map(|cwd| cwd.to_string_lossy().into_owned()),
97 }
98 }
99
100 pub fn from_proto(proto: proto::SpawnInTerminal) -> Self {
101 Self {
102 label: proto.label.clone(),
103 command: proto.command.clone(),
104 args: proto.args.clone(),
105 env: proto.env.into_iter().collect(),
106 cwd: proto.cwd.map(PathBuf::from),
107 ..Default::default()
108 }
109 }
110}
111
112/// A final form of the [`TaskTemplate`], that got resolved with a particular [`TaskContext`] and now is ready to spawn the actual task.
113#[derive(Clone, Debug, PartialEq, Eq)]
114pub struct ResolvedTask {
115 /// A way to distinguish tasks produced by the same template, but different contexts.
116 /// NOTE: Resolved tasks may have the same labels, commands and do the same things,
117 /// but still may have different ids if the context was different during the resolution.
118 /// Since the template has `env` field, for a generic task that may be a bash command,
119 /// so it's impossible to determine the id equality without more context in a generic case.
120 pub id: TaskId,
121 /// A template the task got resolved from.
122 original_task: TaskTemplate,
123 /// Full, unshortened label of the task after all resolutions are made.
124 pub resolved_label: String,
125 /// Variables that were substituted during the task template resolution.
126 substituted_variables: HashSet<VariableName>,
127 /// Further actions that need to take place after the resolved task is spawned,
128 /// with all task variables resolved.
129 pub resolved: SpawnInTerminal,
130}
131
132impl ResolvedTask {
133 /// A task template before the resolution.
134 pub fn original_task(&self) -> &TaskTemplate {
135 &self.original_task
136 }
137
138 /// Variables that were substituted during the task template resolution.
139 pub fn substituted_variables(&self) -> &HashSet<VariableName> {
140 &self.substituted_variables
141 }
142
143 /// A human-readable label to display in the UI.
144 pub fn display_label(&self) -> &str {
145 self.resolved.label.as_str()
146 }
147}
148
149/// Variables, available for use in [`TaskContext`] when a Zed's [`TaskTemplate`] gets resolved into a [`ResolvedTask`].
150/// Name of the variable must be a valid shell variable identifier, which generally means that it is
151/// a word consisting only of alphanumeric characters and underscores,
152/// and beginning with an alphabetic character or an underscore.
153#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize)]
154pub enum VariableName {
155 /// An absolute path of the currently opened file.
156 File,
157 /// A path of the currently opened file (relative to worktree root).
158 RelativeFile,
159 /// A path of the currently opened file's directory (relative to worktree root).
160 RelativeDir,
161 /// The currently opened filename.
162 Filename,
163 /// The path to a parent directory of a currently opened file.
164 Dirname,
165 /// Stem (filename without extension) of the currently opened file.
166 Stem,
167 /// An absolute path of the currently opened worktree, that contains the file.
168 WorktreeRoot,
169 /// A symbol text, that contains latest cursor/selection position.
170 Symbol,
171 /// A row with the latest cursor/selection position.
172 Row,
173 /// A column with the latest cursor/selection position.
174 Column,
175 /// Text from the latest selection.
176 SelectedText,
177 /// The language of the currently opened buffer (e.g., "Rust", "Python").
178 Language,
179 /// The symbol selected by the symbol tagging system, specifically the @run capture in a runnables.scm
180 RunnableSymbol,
181 /// Open a Picker to select a process ID to use in place
182 /// Can only be used to debug configurations
183 PickProcessId,
184 /// Custom variable, provided by the plugin or other external source.
185 /// Will be printed with `CUSTOM_` prefix to avoid potential conflicts with other variables.
186 Custom(Cow<'static, str>),
187}
188
189impl VariableName {
190 /// Generates a `$VARIABLE`-like string value to be used in templates.
191 pub fn template_value(&self) -> String {
192 format!("${self}")
193 }
194 /// Generates a `"$VARIABLE"`-like string, to be used instead of `Self::template_value` when expanded value could contain spaces or special characters.
195 pub fn template_value_with_whitespace(&self) -> String {
196 format!("\"${self}\"")
197 }
198}
199
200impl FromStr for VariableName {
201 type Err = ();
202
203 fn from_str(s: &str) -> Result<Self, Self::Err> {
204 let without_prefix = s.strip_prefix(ZED_VARIABLE_NAME_PREFIX).ok_or(())?;
205 let value = match without_prefix {
206 "FILE" => Self::File,
207 "FILENAME" => Self::Filename,
208 "RELATIVE_FILE" => Self::RelativeFile,
209 "RELATIVE_DIR" => Self::RelativeDir,
210 "DIRNAME" => Self::Dirname,
211 "STEM" => Self::Stem,
212 "WORKTREE_ROOT" => Self::WorktreeRoot,
213 "SYMBOL" => Self::Symbol,
214 "RUNNABLE_SYMBOL" => Self::RunnableSymbol,
215 "SELECTED_TEXT" => Self::SelectedText,
216 "LANGUAGE" => Self::Language,
217 "ROW" => Self::Row,
218 "COLUMN" => Self::Column,
219 _ => {
220 if let Some(custom_name) =
221 without_prefix.strip_prefix(ZED_CUSTOM_VARIABLE_NAME_PREFIX)
222 {
223 Self::Custom(Cow::Owned(custom_name.to_owned()))
224 } else {
225 return Err(());
226 }
227 }
228 };
229 Ok(value)
230 }
231}
232
233/// A prefix that all [`VariableName`] variants are prefixed with when used in environment variables and similar template contexts.
234pub const ZED_VARIABLE_NAME_PREFIX: &str = "ZED_";
235const ZED_CUSTOM_VARIABLE_NAME_PREFIX: &str = "CUSTOM_";
236
237impl std::fmt::Display for VariableName {
238 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
239 match self {
240 Self::File => write!(f, "{ZED_VARIABLE_NAME_PREFIX}FILE"),
241 Self::Filename => write!(f, "{ZED_VARIABLE_NAME_PREFIX}FILENAME"),
242 Self::RelativeFile => write!(f, "{ZED_VARIABLE_NAME_PREFIX}RELATIVE_FILE"),
243 Self::RelativeDir => write!(f, "{ZED_VARIABLE_NAME_PREFIX}RELATIVE_DIR"),
244 Self::Dirname => write!(f, "{ZED_VARIABLE_NAME_PREFIX}DIRNAME"),
245 Self::Stem => write!(f, "{ZED_VARIABLE_NAME_PREFIX}STEM"),
246 Self::WorktreeRoot => write!(f, "{ZED_VARIABLE_NAME_PREFIX}WORKTREE_ROOT"),
247 Self::Symbol => write!(f, "{ZED_VARIABLE_NAME_PREFIX}SYMBOL"),
248 Self::Row => write!(f, "{ZED_VARIABLE_NAME_PREFIX}ROW"),
249 Self::Column => write!(f, "{ZED_VARIABLE_NAME_PREFIX}COLUMN"),
250 Self::SelectedText => write!(f, "{ZED_VARIABLE_NAME_PREFIX}SELECTED_TEXT"),
251 Self::Language => write!(f, "{ZED_VARIABLE_NAME_PREFIX}LANGUAGE"),
252 Self::RunnableSymbol => write!(f, "{ZED_VARIABLE_NAME_PREFIX}RUNNABLE_SYMBOL"),
253 Self::PickProcessId => write!(f, "{ZED_VARIABLE_NAME_PREFIX}PICK_PID"),
254 Self::Custom(s) => write!(
255 f,
256 "{ZED_VARIABLE_NAME_PREFIX}{ZED_CUSTOM_VARIABLE_NAME_PREFIX}{s}"
257 ),
258 }
259 }
260}
261
262/// Container for predefined environment variables that describe state of Zed at the time the task was spawned.
263#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize)]
264pub struct TaskVariables(HashMap<VariableName, String>);
265
266impl TaskVariables {
267 /// Inserts another variable into the container, overwriting the existing one if it already exists — in this case, the old value is returned.
268 pub fn insert(&mut self, variable: VariableName, value: String) -> Option<String> {
269 self.0.insert(variable, value)
270 }
271
272 /// Extends the container with another one, overwriting the existing variables on collision.
273 pub fn extend(&mut self, other: Self) {
274 self.0.extend(other.0);
275 }
276 /// Get the value associated with given variable name, if there is one.
277 pub fn get(&self, key: &VariableName) -> Option<&str> {
278 self.0.get(key).map(|s| s.as_str())
279 }
280 /// Clear out variables obtained from tree-sitter queries, which are prefixed with '_' character
281 pub fn sweep(&mut self) {
282 self.0.retain(|name, _| {
283 if let VariableName::Custom(name) = name {
284 !name.starts_with('_')
285 } else {
286 true
287 }
288 })
289 }
290
291 pub fn iter(&self) -> impl Iterator<Item = (&VariableName, &String)> {
292 self.0.iter()
293 }
294}
295
296impl FromIterator<(VariableName, String)> for TaskVariables {
297 fn from_iter<T: IntoIterator<Item = (VariableName, String)>>(iter: T) -> Self {
298 Self(HashMap::from_iter(iter))
299 }
300}
301
302impl IntoIterator for TaskVariables {
303 type Item = (VariableName, String);
304
305 type IntoIter = hash_map::IntoIter<VariableName, String>;
306
307 fn into_iter(self) -> Self::IntoIter {
308 self.0.into_iter()
309 }
310}
311
312/// Keeps track of the file associated with a task and context of tasks execution (i.e. current file or current function).
313/// Keeps all Zed-related state inside, used to produce a resolved task out of its template.
314#[derive(Clone, Debug, Default, PartialEq, Eq)]
315pub struct TaskContext {
316 /// A path to a directory in which the task should be executed.
317 pub cwd: Option<PathBuf>,
318 /// Additional environment variables associated with a given task.
319 pub task_variables: TaskVariables,
320 /// Environment variables obtained when loading the project into Zed.
321 /// This is the environment one would get when `cd`ing in a terminal
322 /// into the project's root directory.
323 pub project_env: HashMap<String, String>,
324}
325
326/// A shared reference to a [`TaskContext`], used to avoid cloning the context multiple times.
327#[derive(Clone, Debug, Default)]
328pub struct SharedTaskContext(Arc<TaskContext>);
329
330impl std::ops::Deref for SharedTaskContext {
331 type Target = TaskContext;
332
333 fn deref(&self) -> &Self::Target {
334 &self.0
335 }
336}
337
338impl From<TaskContext> for SharedTaskContext {
339 fn from(context: TaskContext) -> Self {
340 Self(Arc::new(context))
341 }
342}
343
344/// This is a new type representing a 'tag' on a 'runnable symbol', typically a test of main() function, found via treesitter.
345#[derive(Clone, Debug)]
346pub struct RunnableTag(pub SharedString);
347
348pub fn shell_from_proto(proto: proto::Shell) -> anyhow::Result<Shell> {
349 let shell_type = proto.shell_type.context("invalid shell type")?;
350 let shell = match shell_type {
351 proto::shell::ShellType::System(_) => Shell::System,
352 proto::shell::ShellType::Program(program) => Shell::Program(program),
353 proto::shell::ShellType::WithArguments(program) => Shell::WithArguments {
354 program: program.program,
355 args: program.args,
356 title_override: None,
357 },
358 };
359 Ok(shell)
360}
361
362pub fn shell_to_proto(shell: Shell) -> proto::Shell {
363 let shell_type = match shell {
364 Shell::System => proto::shell::ShellType::System(proto::System {}),
365 Shell::Program(program) => proto::shell::ShellType::Program(program),
366 Shell::WithArguments {
367 program,
368 args,
369 title_override: _,
370 } => proto::shell::ShellType::WithArguments(proto::shell::WithArguments { program, args }),
371 };
372 proto::Shell {
373 shell_type: Some(shell_type),
374 }
375}
376
377type VsCodeEnvVariable = String;
378type VsCodeCommand = String;
379type ZedEnvVariable = String;
380
381struct EnvVariableReplacer {
382 variables: HashMap<VsCodeEnvVariable, ZedEnvVariable>,
383 commands: HashMap<VsCodeCommand, ZedEnvVariable>,
384}
385
386impl EnvVariableReplacer {
387 fn new(variables: HashMap<VsCodeEnvVariable, ZedEnvVariable>) -> Self {
388 Self {
389 variables,
390 commands: HashMap::default(),
391 }
392 }
393
394 fn with_commands(
395 mut self,
396 commands: impl IntoIterator<Item = (VsCodeCommand, ZedEnvVariable)>,
397 ) -> Self {
398 self.commands = commands.into_iter().collect();
399 self
400 }
401
402 fn replace_value(&self, input: serde_json::Value) -> serde_json::Value {
403 match input {
404 serde_json::Value::String(s) => serde_json::Value::String(self.replace(&s)),
405 serde_json::Value::Array(arr) => {
406 serde_json::Value::Array(arr.into_iter().map(|v| self.replace_value(v)).collect())
407 }
408 serde_json::Value::Object(obj) => serde_json::Value::Object(
409 obj.into_iter()
410 .map(|(k, v)| (self.replace(&k), self.replace_value(v)))
411 .collect(),
412 ),
413 _ => input,
414 }
415 }
416 // Replaces occurrences of VsCode-specific environment variables with Zed equivalents.
417 fn replace(&self, input: &str) -> String {
418 shellexpand::env_with_context_no_errors(&input, |var: &str| {
419 // 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.
420 let colon_position = var.find(':').unwrap_or(var.len());
421 let (left, right) = var.split_at(colon_position);
422 if left == "env" && !right.is_empty() {
423 let variable_name = &right[1..];
424 return Some(format!("${{{variable_name}}}"));
425 } else if left == "command" && !right.is_empty() {
426 let command_name = &right[1..];
427 if let Some(replacement_command) = self.commands.get(command_name) {
428 return Some(format!("${{{replacement_command}}}"));
429 }
430 }
431
432 let (variable_name, default) = (left, right);
433 let append_previous_default = |ret: &mut String| {
434 if !default.is_empty() {
435 ret.push_str(default);
436 }
437 };
438 if let Some(substitution) = self.variables.get(variable_name) {
439 // Got a VSCode->Zed hit, perform a substitution
440 let mut name = format!("${{{substitution}");
441 append_previous_default(&mut name);
442 name.push('}');
443 return Some(name);
444 }
445 // This is an unknown variable.
446 // 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.
447 // If there's a default, we need to return the string verbatim as otherwise shellexpand will apply that default for us.
448 if !default.is_empty() {
449 return Some(format!("${{{var}}}"));
450 }
451 // Else we can just return None and that variable will be left as is.
452 None
453 })
454 .into_owned()
455 }
456}