
Things this doesn't currently handle: - [x] ~testing~ - ~we really need an snapshot test that takes a vscode settings file with all options that we support, and verifies the zed settings file you get from importing it, both from an empty starting file or one with lots of conflicts. that way we can open said vscode settings file in vscode to ensure that those options all still exist in the future.~ - Discussed this, we don't think this will meaningfully protect us from future failures, and we will just do this as a manual validation step before merging this PR. Any imports that have meaningfully complex translation steps should still be tested. - [x] confirmation (right now it just clobbers your settings file silently) - it'd be really cool if we could show a diff multibuffer of your current settings with the result of the vscode import and let you pick "hunks" to keep, but that's probably too much effort for this feature, especially given that we expect most of the people using it to have an empty/barebones zed config when they run the import. - [x] ~UI in the "welcome" page~ - we're planning on redoing our welcome/walkthrough experience anyways, but in the meantime it'd be nice to conditionally show a button there if we see a user level vscode config - we'll add it to the UI when we land the new walkthrough experience, for now it'll be accessible through the action - [ ] project-specific settings - handling translation of `.vscode/settings.json` or `.code-workspace` settings to `.zed/settings.json` will come in a future PR, along with UI to prompt the user for those actions when opening a project with local vscode settings for the first time - [ ] extension settings - we probably want to do a best-effort pass of popular extensions like vim and git lens - it's also possible to look for installed/enabled extensions with `code --list-extensions`, but we'd have to maintain some sort of mapping of those to our settings and/or extensions - [ ] LSP settings - these are tricky without access to the json schemas for various language server extensions. we could probably manage to do translations for a couple popular languages and avoid solving it in the general case. - [ ] platform specific settings (`[macos].blah`) - this is blocked on #16392 which I'm hoping to address soon - [ ] language specific settings (`[rust].foo`) - totally doable, just haven't gotten to it yet ~We may want to put this behind some kind of flag and/or not land it until some of the above issues are addressed, given that we expect people to only run this importer once there's an incentive to get it right the first time. Maybe we land it alongside a keymap importer so you don't have to go through separate imports for those?~ We are gonna land this as-is, all these unchecked items at the bottom will be addressed in followup PRs, so maybe don't run the importer for now if you have a large and complex VsCode settings file you'd like to import. Release Notes: - Added a VSCode settings importer, available via a `zed::ImportVsCodeSettings` action --------- Co-authored-by: Mikayla Maki <mikayla@zed.dev> Co-authored-by: Kirill Bulatov <kirill@zed.dev> Co-authored-by: Mikayla Maki <mikayla.c.maki@gmail.com> Co-authored-by: Marshall Bowers <git@maxdeviant.com>
130 lines
4.1 KiB
Rust
130 lines
4.1 KiB
Rust
use editor::ShowScrollbar;
|
|
use gpui::Pixels;
|
|
use schemars::JsonSchema;
|
|
use serde::{Deserialize, Serialize};
|
|
use settings::{Settings, SettingsSources};
|
|
|
|
#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, Copy, PartialEq)]
|
|
#[serde(rename_all = "snake_case")]
|
|
pub enum OutlinePanelDockPosition {
|
|
Left,
|
|
Right,
|
|
}
|
|
|
|
#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
|
|
#[serde(rename_all = "snake_case")]
|
|
pub enum ShowIndentGuides {
|
|
Always,
|
|
Never,
|
|
}
|
|
|
|
#[derive(Deserialize, Debug, Clone, Copy, PartialEq)]
|
|
pub struct OutlinePanelSettings {
|
|
pub button: bool,
|
|
pub default_width: Pixels,
|
|
pub dock: OutlinePanelDockPosition,
|
|
pub file_icons: bool,
|
|
pub folder_icons: bool,
|
|
pub git_status: bool,
|
|
pub indent_size: f32,
|
|
pub indent_guides: IndentGuidesSettings,
|
|
pub auto_reveal_entries: bool,
|
|
pub auto_fold_dirs: bool,
|
|
pub scrollbar: ScrollbarSettings,
|
|
}
|
|
|
|
#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
|
|
pub struct ScrollbarSettings {
|
|
/// When to show the scrollbar in the project panel.
|
|
///
|
|
/// Default: inherits editor scrollbar settings
|
|
pub show: Option<ShowScrollbar>,
|
|
}
|
|
|
|
#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
|
|
pub struct ScrollbarSettingsContent {
|
|
/// When to show the scrollbar in the project panel.
|
|
///
|
|
/// Default: inherits editor scrollbar settings
|
|
pub show: Option<Option<ShowScrollbar>>,
|
|
}
|
|
|
|
#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
|
|
pub struct IndentGuidesSettings {
|
|
pub show: ShowIndentGuides,
|
|
}
|
|
|
|
#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
|
|
pub struct IndentGuidesSettingsContent {
|
|
/// When to show the scrollbar in the outline panel.
|
|
pub show: Option<ShowIndentGuides>,
|
|
}
|
|
|
|
#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, Debug)]
|
|
pub struct OutlinePanelSettingsContent {
|
|
/// Whether to show the outline panel button in the status bar.
|
|
///
|
|
/// Default: true
|
|
pub button: Option<bool>,
|
|
/// Customize default width (in pixels) taken by outline panel
|
|
///
|
|
/// Default: 240
|
|
pub default_width: Option<f32>,
|
|
/// The position of outline panel
|
|
///
|
|
/// Default: left
|
|
pub dock: Option<OutlinePanelDockPosition>,
|
|
/// Whether to show file icons in the outline panel.
|
|
///
|
|
/// Default: true
|
|
pub file_icons: Option<bool>,
|
|
/// Whether to show folder icons or chevrons for directories in the outline panel.
|
|
///
|
|
/// Default: true
|
|
pub folder_icons: Option<bool>,
|
|
/// Whether to show the git status in the outline panel.
|
|
///
|
|
/// Default: true
|
|
pub git_status: Option<bool>,
|
|
/// Amount of indentation (in pixels) for nested items.
|
|
///
|
|
/// Default: 20
|
|
pub indent_size: Option<f32>,
|
|
/// Whether to reveal it in the outline panel automatically,
|
|
/// when a corresponding project entry becomes active.
|
|
/// Gitignored entries are never auto revealed.
|
|
///
|
|
/// Default: true
|
|
pub auto_reveal_entries: Option<bool>,
|
|
/// Whether to fold directories automatically
|
|
/// when directory has only one directory inside.
|
|
///
|
|
/// Default: true
|
|
pub auto_fold_dirs: Option<bool>,
|
|
/// Settings related to indent guides in the outline panel.
|
|
pub indent_guides: Option<IndentGuidesSettingsContent>,
|
|
/// Scrollbar-related settings
|
|
pub scrollbar: Option<ScrollbarSettingsContent>,
|
|
}
|
|
|
|
impl Settings for OutlinePanelSettings {
|
|
const KEY: Option<&'static str> = Some("outline_panel");
|
|
|
|
type FileContent = OutlinePanelSettingsContent;
|
|
|
|
fn load(
|
|
sources: SettingsSources<Self::FileContent>,
|
|
_: &mut gpui::App,
|
|
) -> anyhow::Result<Self> {
|
|
sources.json_merge()
|
|
}
|
|
|
|
fn import_from_vscode(vscode: &settings::VsCodeSettings, current: &mut Self::FileContent) {
|
|
if let Some(b) = vscode.read_bool("outline.icons") {
|
|
current.file_icons = Some(b);
|
|
current.folder_icons = Some(b);
|
|
}
|
|
|
|
vscode.bool_setting("git.decorations.enabled", &mut current.git_status);
|
|
}
|
|
}
|