VS Code -> Zed tasks converter (#9538)
We can convert shell, npm and gulp tasks to a Zed format. Additionally, we convert a subset of task variables that VsCode supports. Release notes: - Zed can now load tasks in Visual Studio Code task format --------- Co-authored-by: Piotr Osiewicz <piotr@zed.dev> Co-authored-by: Piotr Osiewicz <24362066+osiewicz@users.noreply.github.com>
This commit is contained in:
Anthony Eid
GitHub
parent
269d2513ca
commit
88857f8149
11 changed files with 605 additions and 17 deletions
386
crates/task/src/vscode_format.rs
Normal file
386
crates/task/src/vscode_format.rs
Normal file
|
|
@ -0,0 +1,386 @@
|
|||
use anyhow::bail;
|
||||
use collections::HashMap;
|
||||
use serde::Deserialize;
|
||||
use util::ResultExt;
|
||||
|
||||
use crate::static_source::{Definition, DefinitionProvider};
|
||||
|
||||
#[derive(Clone, Debug, Deserialize, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
struct TaskOptions {
|
||||
cwd: Option<String>,
|
||||
#[serde(default)]
|
||||
env: HashMap<String, String>,
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, Deserialize, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
struct VsCodeTaskDefinition {
|
||||
label: String,
|
||||
#[serde(flatten)]
|
||||
command: Option<Command>,
|
||||
#[serde(flatten)]
|
||||
other_attributes: HashMap<String, serde_json_lenient::Value>,
|
||||
options: Option<TaskOptions>,
|
||||
}
|
||||
|
||||
#[derive(Clone, Deserialize, PartialEq, Debug)]
|
||||
#[serde(tag = "type")]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
enum Command {
|
||||
Npm {
|
||||
script: String,
|
||||
},
|
||||
Shell {
|
||||
command: String,
|
||||
#[serde(default)]
|
||||
args: Vec<String>,
|
||||
},
|
||||
Gulp {
|
||||
task: String,
|
||||
},
|
||||
}
|
||||
|
||||
type VsCodeEnvVariable = String;
|
||||
type ZedEnvVariable = String;
|
||||
|
||||
struct EnvVariableReplacer {
|
||||
variables: HashMap<VsCodeEnvVariable, ZedEnvVariable>,
|
||||
}
|
||||
|
||||
impl EnvVariableReplacer {
|
||||
fn new(variables: HashMap<VsCodeEnvVariable, ZedEnvVariable>) -> Self {
|
||||
Self { variables }
|
||||
}
|
||||
// Replaces occurrences of VsCode-specific environment variables with Zed equivalents.
|
||||
fn replace(&self, input: &str) -> String {
|
||||
shellexpand::env_with_context_no_errors(&input, |var: &str| {
|
||||
// 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.
|
||||
let colon_position = var.find(':').unwrap_or(var.len());
|
||||
let (variable_name, default) = var.split_at(colon_position);
|
||||
let append_previous_default = |ret: &mut String| {
|
||||
if !default.is_empty() {
|
||||
ret.push_str(default);
|
||||
}
|
||||
};
|
||||
if let Some(substitution) = self.variables.get(variable_name) {
|
||||
// Got a VSCode->Zed hit, perform a substitution
|
||||
let mut name = format!("${{{substitution}");
|
||||
append_previous_default(&mut name);
|
||||
name.push_str("}");
|
||||
return Some(name);
|
||||
}
|
||||
// This is an unknown variable.
|
||||
// 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.
|
||||
// If there's a default, we need to return the string verbatim as otherwise shellexpand will apply that default for us.
|
||||
if !default.is_empty() {
|
||||
return Some(format!("${{{var}}}"));
|
||||
}
|
||||
// Else we can just return None and that variable will be left as is.
|
||||
None
|
||||
})
|
||||
.into_owned()
|
||||
}
|
||||
}
|
||||
|
||||
impl VsCodeTaskDefinition {
|
||||
fn to_zed_format(self, replacer: &EnvVariableReplacer) -> anyhow::Result<Definition> {
|
||||
if self.other_attributes.contains_key("dependsOn") {
|
||||
bail!("Encountered unsupported `dependsOn` key during deserialization");
|
||||
}
|
||||
// `type` might not be set in e.g. tasks that use `dependsOn`; we still want to deserialize the whole object though (hence command is an Option),
|
||||
// as that way we can provide more specific description of why deserialization failed.
|
||||
// E.g. if the command is missing due to `dependsOn` presence, we can check other_attributes first before doing this (and provide nice error message)
|
||||
// catch-all if on value.command presence.
|
||||
let Some(command) = self.command else {
|
||||
bail!("Missing `type` field in task");
|
||||
};
|
||||
|
||||
let (command, args) = match command {
|
||||
Command::Npm { script } => ("npm".to_owned(), vec!["run".to_string(), script]),
|
||||
Command::Shell { command, args } => (command, args),
|
||||
Command::Gulp { task } => ("gulp".to_owned(), vec![task]),
|
||||
};
|
||||
// Per VSC docs, only `command`, `args` and `options` support variable substitution.
|
||||
let command = replacer.replace(&command);
|
||||
let args = args.into_iter().map(|arg| replacer.replace(&arg)).collect();
|
||||
let mut ret = Definition {
|
||||
label: self.label,
|
||||
command,
|
||||
args,
|
||||
..Default::default()
|
||||
};
|
||||
if let Some(options) = self.options {
|
||||
ret.cwd = options.cwd.map(|cwd| replacer.replace(&cwd));
|
||||
ret.env = options.env;
|
||||
}
|
||||
Ok(ret)
|
||||
}
|
||||
}
|
||||
|
||||
/// [`VsCodeTaskFile`] is a superset of Code's task definition format.
|
||||
#[derive(Debug, Deserialize, PartialEq)]
|
||||
pub struct VsCodeTaskFile {
|
||||
tasks: Vec<VsCodeTaskDefinition>,
|
||||
}
|
||||
|
||||
impl TryFrom<VsCodeTaskFile> for DefinitionProvider {
|
||||
type Error = anyhow::Error;
|
||||
|
||||
fn try_from(value: VsCodeTaskFile) -> Result<Self, Self::Error> {
|
||||
let replacer = EnvVariableReplacer::new(HashMap::from_iter([
|
||||
("workspaceFolder".to_owned(), "ZED_WORKTREE_ROOT".to_owned()),
|
||||
("file".to_owned(), "ZED_FILE".to_owned()),
|
||||
("lineNumber".to_owned(), "ZED_ROW".to_owned()),
|
||||
("selectedText".to_owned(), "ZED_SELECTED_TEXT".to_owned()),
|
||||
]));
|
||||
let definitions = value
|
||||
.tasks
|
||||
.into_iter()
|
||||
.filter_map(|vscode_definition| vscode_definition.to_zed_format(&replacer).log_err())
|
||||
.collect();
|
||||
Ok(Self(definitions))
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use std::collections::HashMap;
|
||||
|
||||
use crate::{
|
||||
static_source::{Definition, DefinitionProvider},
|
||||
vscode_format::{Command, VsCodeTaskDefinition},
|
||||
VsCodeTaskFile,
|
||||
};
|
||||
|
||||
use super::EnvVariableReplacer;
|
||||
|
||||
fn compare_without_other_attributes(lhs: VsCodeTaskDefinition, rhs: VsCodeTaskDefinition) {
|
||||
assert_eq!(
|
||||
VsCodeTaskDefinition {
|
||||
other_attributes: Default::default(),
|
||||
..lhs
|
||||
},
|
||||
VsCodeTaskDefinition {
|
||||
other_attributes: Default::default(),
|
||||
..rhs
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_variable_substitution() {
|
||||
let replacer = EnvVariableReplacer::new(Default::default());
|
||||
assert_eq!(replacer.replace("Food"), "Food");
|
||||
// Unknown variables are left in tact.
|
||||
assert_eq!(
|
||||
replacer.replace("$PATH is an environment variable"),
|
||||
"$PATH is an environment variable"
|
||||
);
|
||||
assert_eq!(replacer.replace("${PATH}"), "${PATH}");
|
||||
assert_eq!(replacer.replace("${PATH:food}"), "${PATH:food}");
|
||||
// And now, the actual replacing
|
||||
let replacer = EnvVariableReplacer::new(HashMap::from_iter([(
|
||||
"PATH".to_owned(),
|
||||
"ZED_PATH".to_owned(),
|
||||
)]));
|
||||
assert_eq!(replacer.replace("Food"), "Food");
|
||||
assert_eq!(
|
||||
replacer.replace("$PATH is an environment variable"),
|
||||
"${ZED_PATH} is an environment variable"
|
||||
);
|
||||
assert_eq!(replacer.replace("${PATH}"), "${ZED_PATH}");
|
||||
assert_eq!(replacer.replace("${PATH:food}"), "${ZED_PATH:food}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn can_deserialize_ts_tasks() {
|
||||
static TYPESCRIPT_TASKS: &'static str = include_str!("../test_data/typescript.json");
|
||||
let vscode_definitions: VsCodeTaskFile =
|
||||
serde_json_lenient::from_str(&TYPESCRIPT_TASKS).unwrap();
|
||||
|
||||
let expected = vec![
|
||||
VsCodeTaskDefinition {
|
||||
label: "gulp: tests".to_string(),
|
||||
command: Some(Command::Npm {
|
||||
script: "build:tests:notypecheck".to_string(),
|
||||
}),
|
||||
other_attributes: Default::default(),
|
||||
options: None,
|
||||
},
|
||||
VsCodeTaskDefinition {
|
||||
label: "tsc: watch ./src".to_string(),
|
||||
command: Some(Command::Shell {
|
||||
command: "node".to_string(),
|
||||
args: vec![
|
||||
"${workspaceFolder}/node_modules/typescript/lib/tsc.js".to_string(),
|
||||
"--build".to_string(),
|
||||
"${workspaceFolder}/src".to_string(),
|
||||
"--watch".to_string(),
|
||||
],
|
||||
}),
|
||||
other_attributes: Default::default(),
|
||||
options: None,
|
||||
},
|
||||
VsCodeTaskDefinition {
|
||||
label: "npm: build:compiler".to_string(),
|
||||
command: Some(Command::Npm {
|
||||
script: "build:compiler".to_string(),
|
||||
}),
|
||||
other_attributes: Default::default(),
|
||||
options: None,
|
||||
},
|
||||
VsCodeTaskDefinition {
|
||||
label: "npm: build:tests".to_string(),
|
||||
command: Some(Command::Npm {
|
||||
script: "build:tests:notypecheck".to_string(),
|
||||
}),
|
||||
other_attributes: Default::default(),
|
||||
options: None,
|
||||
},
|
||||
];
|
||||
|
||||
assert_eq!(vscode_definitions.tasks.len(), expected.len());
|
||||
vscode_definitions
|
||||
.tasks
|
||||
.iter()
|
||||
.zip(expected)
|
||||
.for_each(|(lhs, rhs)| compare_without_other_attributes(lhs.clone(), rhs));
|
||||
|
||||
let expected = vec![
|
||||
Definition {
|
||||
label: "gulp: tests".to_string(),
|
||||
command: "npm".to_string(),
|
||||
args: vec!["run".to_string(), "build:tests:notypecheck".to_string()],
|
||||
..Default::default()
|
||||
},
|
||||
Definition {
|
||||
label: "tsc: watch ./src".to_string(),
|
||||
command: "node".to_string(),
|
||||
args: vec![
|
||||
"${ZED_WORKTREE_ROOT}/node_modules/typescript/lib/tsc.js".to_string(),
|
||||
"--build".to_string(),
|
||||
"${ZED_WORKTREE_ROOT}/src".to_string(),
|
||||
"--watch".to_string(),
|
||||
],
|
||||
..Default::default()
|
||||
},
|
||||
Definition {
|
||||
label: "npm: build:compiler".to_string(),
|
||||
command: "npm".to_string(),
|
||||
args: vec!["run".to_string(), "build:compiler".to_string()],
|
||||
..Default::default()
|
||||
},
|
||||
Definition {
|
||||
label: "npm: build:tests".to_string(),
|
||||
command: "npm".to_string(),
|
||||
args: vec!["run".to_string(), "build:tests:notypecheck".to_string()],
|
||||
..Default::default()
|
||||
},
|
||||
];
|
||||
|
||||
let tasks: DefinitionProvider = vscode_definitions.try_into().unwrap();
|
||||
assert_eq!(tasks.0, expected);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn can_deserialize_rust_analyzer_tasks() {
|
||||
static RUST_ANALYZER_TASKS: &'static str = include_str!("../test_data/rust-analyzer.json");
|
||||
let vscode_definitions: VsCodeTaskFile =
|
||||
serde_json_lenient::from_str(&RUST_ANALYZER_TASKS).unwrap();
|
||||
let expected = vec![
|
||||
VsCodeTaskDefinition {
|
||||
label: "Build Extension in Background".to_string(),
|
||||
command: Some(Command::Npm {
|
||||
script: "watch".to_string(),
|
||||
}),
|
||||
options: None,
|
||||
other_attributes: Default::default(),
|
||||
},
|
||||
VsCodeTaskDefinition {
|
||||
label: "Build Extension".to_string(),
|
||||
command: Some(Command::Npm {
|
||||
script: "build".to_string(),
|
||||
}),
|
||||
options: None,
|
||||
other_attributes: Default::default(),
|
||||
},
|
||||
VsCodeTaskDefinition {
|
||||
label: "Build Server".to_string(),
|
||||
command: Some(Command::Shell {
|
||||
command: "cargo build --package rust-analyzer".to_string(),
|
||||
args: Default::default(),
|
||||
}),
|
||||
options: None,
|
||||
other_attributes: Default::default(),
|
||||
},
|
||||
VsCodeTaskDefinition {
|
||||
label: "Build Server (Release)".to_string(),
|
||||
command: Some(Command::Shell {
|
||||
command: "cargo build --release --package rust-analyzer".to_string(),
|
||||
args: Default::default(),
|
||||
}),
|
||||
options: None,
|
||||
other_attributes: Default::default(),
|
||||
},
|
||||
VsCodeTaskDefinition {
|
||||
label: "Pretest".to_string(),
|
||||
command: Some(Command::Npm {
|
||||
script: "pretest".to_string(),
|
||||
}),
|
||||
options: None,
|
||||
other_attributes: Default::default(),
|
||||
},
|
||||
VsCodeTaskDefinition {
|
||||
label: "Build Server and Extension".to_string(),
|
||||
command: None,
|
||||
options: None,
|
||||
other_attributes: Default::default(),
|
||||
},
|
||||
VsCodeTaskDefinition {
|
||||
label: "Build Server (Release) and Extension".to_string(),
|
||||
command: None,
|
||||
options: None,
|
||||
other_attributes: Default::default(),
|
||||
},
|
||||
];
|
||||
assert_eq!(vscode_definitions.tasks.len(), expected.len());
|
||||
vscode_definitions
|
||||
.tasks
|
||||
.iter()
|
||||
.zip(expected)
|
||||
.for_each(|(lhs, rhs)| compare_without_other_attributes(lhs.clone(), rhs));
|
||||
let expected = vec![
|
||||
Definition {
|
||||
label: "Build Extension in Background".to_string(),
|
||||
command: "npm".to_string(),
|
||||
args: vec!["run".to_string(), "watch".to_string()],
|
||||
..Default::default()
|
||||
},
|
||||
Definition {
|
||||
label: "Build Extension".to_string(),
|
||||
command: "npm".to_string(),
|
||||
args: vec!["run".to_string(), "build".to_string()],
|
||||
..Default::default()
|
||||
},
|
||||
Definition {
|
||||
label: "Build Server".to_string(),
|
||||
command: "cargo build --package rust-analyzer".to_string(),
|
||||
..Default::default()
|
||||
},
|
||||
Definition {
|
||||
label: "Build Server (Release)".to_string(),
|
||||
command: "cargo build --release --package rust-analyzer".to_string(),
|
||||
..Default::default()
|
||||
},
|
||||
Definition {
|
||||
label: "Pretest".to_string(),
|
||||
command: "npm".to_string(),
|
||||
args: vec!["run".to_string(), "pretest".to_string()],
|
||||
..Default::default()
|
||||
},
|
||||
];
|
||||
let tasks: DefinitionProvider = vscode_definitions.try_into().unwrap();
|
||||
assert_eq!(tasks.0, expected);
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue