This commit is contained in:
Joseph T. Lyons 2023-08-30 13:30:05 -04:00
parent e7ba5a1edb
commit 53046e6a0b
3 changed files with 81 additions and 51 deletions

View File

@ -334,22 +334,37 @@
// "custom": 2
// },
"line_height": "comfortable",
// Activate the python virtual environment, if one is found, in the
// terminal's working directory (as resolved by the working_directory
// setting). Set this to "off" to disable this behavior.
"detect_venv": {
// Activate the python virtual environment, using a specified activation
// method. Set this to "off" to disable this behavior.
"activate_venv": {
"on": {
// Default directories to search for virtual environments, relative
// to the current working directory. We recommend overriding this
// in your project's settings, rather than globally.
"directories": [
".env",
"env",
".venv",
"venv"
],
// Can also be 'csh' and 'fish'
"activate_script": "default"
// The method to use to activate the virtual environment.
// May take 2 values:
// 1. Activate the python virtual environment, if one is found, in the
// terminal's working directory (as resolved by the working_directory
// setting).
// "activation_method": {
// "directories": [
// ...
// ],
// "activate_script": "default"
// }
// 2. Use Poetry to activate the virtual environment, by running
// `poetry shell`
// "activation_method": "poetry"
"activation_method": {
// Default directories to search for virtual environments, relative
// to the current working directory. We recommend overriding this
// in your project's settings, rather than globally.
"directories": [
".env",
"env",
".venv",
"venv"
],
// Can also be 'csh' and 'fish'
"activate_script": "default"
}
}
}
// Set the terminal's font size. If this option is not included,

View File

@ -2,7 +2,7 @@ use crate::Project;
use gpui::{AnyWindowHandle, ModelContext, ModelHandle, WeakModelHandle};
use std::path::{Path, PathBuf};
use terminal::{
terminal_settings::{self, TerminalSettings, VenvSettingsContent},
terminal_settings::{self, ActivationMethod, TerminalSettings},
Terminal, TerminalBuilder,
};
@ -26,7 +26,7 @@ impl Project {
));
} else {
let settings = settings::get::<TerminalSettings>(cx);
let python_settings = settings.detect_venv.clone();
let python_settings = settings.activate_venv.clone();
let shell = settings.shell.clone();
let terminal = TerminalBuilder::new(
@ -55,15 +55,31 @@ impl Project {
})
.detach();
if let Some(python_settings) = &python_settings.as_option() {
let activate_script_path =
self.find_activate_script_path(&python_settings, working_directory);
self.activate_python_virtual_environment(
activate_script_path,
&terminal_handle,
cx,
);
if let terminal_settings::ActivateVenvSettings::On { activation_method } =
&python_settings
{
match activation_method {
ActivationMethod::Custom {
activate_script,
directories,
} => {
let activate_script_path = self.find_activate_script_path(
&activate_script.unwrap_or_default(),
directories.as_deref().unwrap_or(&[]),
working_directory,
);
self.activate_python_virtual_environment(
activate_script_path,
&terminal_handle,
cx,
);
}
ActivationMethod::Poetry => {
self.run_poetry_shell_command(&terminal_handle, cx);
}
}
}
terminal_handle
});
@ -73,20 +89,21 @@ impl Project {
pub fn find_activate_script_path(
&mut self,
settings: &VenvSettingsContent,
activate_script: &terminal_settings::ActivateScript,
directories: &[PathBuf],
working_directory: Option<PathBuf>,
) -> Option<PathBuf> {
// When we are unable to resolve the working directory, the terminal builder
// defaults to '/'. We should probably encode this directly somewhere, but for
// now, let's just hard code it here.
let working_directory = working_directory.unwrap_or_else(|| Path::new("/").to_path_buf());
let activate_script_name = match settings.activate_script {
let activate_script_name = match activate_script {
terminal_settings::ActivateScript::Default => "activate",
terminal_settings::ActivateScript::Csh => "activate.csh",
terminal_settings::ActivateScript::Fish => "activate.fish",
};
for virtual_environment_name in settings.directories {
for virtual_environment_name in directories {
let mut path = working_directory.join(virtual_environment_name);
path.push("bin/");
path.push(activate_script_name);
@ -115,6 +132,15 @@ impl Project {
}
}
fn run_poetry_shell_command(
&mut self,
terminal_handle: &ModelHandle<Terminal>,
cx: &mut ModelContext<Project>,
) {
let command = "poetry shell\n".to_string();
terminal_handle.update(cx, |this, _| this.input(command));
}
pub fn local_terminal_handles(&self) -> &Vec<WeakModelHandle<terminal::Terminal>> {
&self.terminals.local_handles
}

View File

@ -28,38 +28,27 @@ pub struct TerminalSettings {
pub dock: TerminalDockPosition,
pub default_width: f32,
pub default_height: f32,
pub detect_venv: VenvSettings,
pub activate_venv: ActivateVenvSettings,
}
#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum VenvSettings {
pub enum ActivateVenvSettings {
#[default]
Off,
On {
activate_script: Option<ActivateScript>,
directories: Option<Vec<PathBuf>>,
activation_method: ActivationMethod,
},
}
pub struct VenvSettingsContent<'a> {
pub activate_script: ActivateScript,
pub directories: &'a [PathBuf],
}
impl VenvSettings {
pub fn as_option(&self) -> Option<VenvSettingsContent> {
match self {
VenvSettings::Off => None,
VenvSettings::On {
activate_script,
directories,
} => Some(VenvSettingsContent {
activate_script: activate_script.unwrap_or(ActivateScript::Default),
directories: directories.as_deref().unwrap_or(&[]),
}),
}
}
#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ActivationMethod {
Custom {
activate_script: Option<ActivateScript>,
directories: Option<Vec<PathBuf>>,
},
Poetry,
}
#[derive(Clone, Copy, Debug, Default, Serialize, Deserialize, JsonSchema)]
@ -87,7 +76,7 @@ pub struct TerminalSettingsContent {
pub dock: Option<TerminalDockPosition>,
pub default_width: Option<f32>,
pub default_height: Option<f32>,
pub detect_venv: Option<VenvSettings>,
pub activate_venv: Option<ActivateVenvSettings>,
}
impl TerminalSettings {