Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(cli): command runner #4198

Merged
merged 3 commits into from
Oct 7, 2024
Merged

refactor(cli): command runner #4198

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc91071
refactor(cli): command runner
ematipico Oct 7, 2024
982aee5
chore: add schema derive for metadata
ematipico Oct 7, 2024
95b2409
bypass configuration diagnostics
ematipico Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
286 changes: 114 additions & 172 deletions crates/biome_cli/src/commands/check.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,24 @@
use super::{determine_fix_file_mode, FixFileModeOptions, LoadEditorConfig};
use crate::cli_options::CliOptions;
use crate::commands::{
get_files_to_process, get_stdin, resolve_manifest, validate_configuration_diagnostics,
};
use crate::execute::VcsTargeted;
use crate::{
execute_mode, setup_cli_subscriber, CliDiagnostic, CliSession, Execution, TraversalMode,
};
use crate::commands::{get_files_to_process, CommandRunner};
use crate::{CliDiagnostic, Execution, TraversalMode};
use biome_configuration::analyzer::assists::PartialAssistsConfiguration;
use biome_configuration::{
organize_imports::PartialOrganizeImports, PartialConfiguration, PartialFormatterConfiguration,
PartialLinterConfiguration,
};
use biome_console::{markup, ConsoleExt};
use biome_console::Console;
use biome_deserialize::Merge;
use biome_diagnostics::PrintDiagnostic;
use biome_service::configuration::{load_editorconfig, PartialConfigurationExt};
use biome_service::workspace::RegisterProjectFolderParams;
use biome_service::{
configuration::{load_configuration, LoadedConfiguration},
workspace::UpdateSettingsParams,
};
use biome_fs::FileSystem;
use biome_service::{configuration::LoadedConfiguration, DynRef, Workspace, WorkspaceError};
use std::ffi::OsString;

use super::{determine_fix_file_mode, FixFileModeOptions};

pub(crate) struct CheckCommandPayload {
pub(crate) apply: bool,
pub(crate) apply_unsafe: bool,
pub(crate) write: bool,
pub(crate) fix: bool,
pub(crate) unsafe_: bool,
pub(crate) cli_options: CliOptions,
pub(crate) configuration: Option<PartialConfiguration>,
pub(crate) paths: Vec<OsString>,
pub(crate) stdin_file_path: Option<String>,
Expand All @@ -43,174 +31,128 @@ pub(crate) struct CheckCommandPayload {
pub(crate) since: Option<String>,
}

/// Handler for the "check" command of the Biome CLI
pub(crate) fn check(
session: CliSession,
payload: CheckCommandPayload,
) -> Result<(), CliDiagnostic> {
let CheckCommandPayload {
apply,
apply_unsafe,
write,
fix,
unsafe_,
cli_options,
configuration,
paths,
stdin_file_path,
linter_enabled,
organize_imports_enabled,
formatter_enabled,
since,
assists_enabled,
staged,
changed,
} = payload;
setup_cli_subscriber(cli_options.log_level, cli_options.log_kind);

let fix_file_mode = determine_fix_file_mode(
FixFileModeOptions {
apply,
apply_unsafe,
write,
fix,
unsafe_,
},
session.app.console,
)?;

let loaded_configuration =
load_configuration(&session.app.fs, cli_options.as_configuration_path_hint())?;
validate_configuration_diagnostics(
&loaded_configuration,
session.app.console,
cli_options.verbose,
)?;

let editorconfig_search_path = loaded_configuration.directory_path.clone();
let LoadedConfiguration {
configuration: biome_configuration,
directory_path: configuration_path,
..
} = loaded_configuration;

let should_use_editorconfig = configuration
.as_ref()
.and_then(|c| c.use_editorconfig())
.unwrap_or(biome_configuration.use_editorconfig().unwrap_or_default());
let mut fs_configuration = if should_use_editorconfig {
let (editorconfig, editorconfig_diagnostics) = {
let search_path = editorconfig_search_path.unwrap_or_else(|| {
let fs = &session.app.fs;
fs.working_directory().unwrap_or_default()
});
load_editorconfig(&session.app.fs, search_path)?
};
for diagnostic in editorconfig_diagnostics {
session.app.console.error(markup! {
{PrintDiagnostic::simple(&diagnostic)}
})
}
editorconfig.unwrap_or_default()
} else {
Default::default()
};
// this makes biome configuration take precedence over editorconfig configuration
fs_configuration.merge_with(biome_configuration);

let formatter = fs_configuration
.formatter
.get_or_insert_with(PartialFormatterConfiguration::default);

if formatter_enabled.is_some() {
formatter.enabled = formatter_enabled;
impl LoadEditorConfig for CheckCommandPayload {
fn should_load_editor_config(&self, fs_configuration: &PartialConfiguration) -> bool {
self.configuration
.as_ref()
.and_then(|c| c.use_editorconfig())
.unwrap_or(fs_configuration.use_editorconfig().unwrap_or_default())
}
}

let linter = fs_configuration
.linter
.get_or_insert_with(PartialLinterConfiguration::default);
impl CommandRunner for CheckCommandPayload {
const COMMAND_NAME: &'static str = "check";

fn merge_configuration(
&mut self,
loaded_configuration: LoadedConfiguration,
fs: &DynRef<'_, dyn FileSystem>,
console: &mut dyn Console,
) -> Result<PartialConfiguration, WorkspaceError> {
let editorconfig_search_path = loaded_configuration.directory_path.clone();
let LoadedConfiguration {
configuration: biome_configuration,
..
} = loaded_configuration;
let mut fs_configuration =
self.load_editor_config(editorconfig_search_path, &biome_configuration, fs, console)?;
// this makes biome configuration take precedence over editorconfig configuration
fs_configuration.merge_with(biome_configuration);

let formatter = fs_configuration
.formatter
.get_or_insert_with(PartialFormatterConfiguration::default);

if self.formatter_enabled.is_some() {
formatter.enabled = self.formatter_enabled;
}

if linter_enabled.is_some() {
linter.enabled = linter_enabled;
}
let linter = fs_configuration
.linter
.get_or_insert_with(PartialLinterConfiguration::default);

let organize_imports = fs_configuration
.organize_imports
.get_or_insert_with(PartialOrganizeImports::default);
if self.linter_enabled.is_some() {
linter.enabled = self.linter_enabled;
}

if organize_imports_enabled.is_some() {
organize_imports.enabled = organize_imports_enabled;
}
let organize_imports = fs_configuration
.organize_imports
.get_or_insert_with(PartialOrganizeImports::default);

let assists = fs_configuration
.assists
.get_or_insert_with(PartialAssistsConfiguration::default);
if self.organize_imports_enabled.is_some() {
organize_imports.enabled = self.organize_imports_enabled;
}

let assists = fs_configuration
.assists
.get_or_insert_with(PartialAssistsConfiguration::default);

if assists_enabled.is_some() {
assists.enabled = assists_enabled;
if self.assists_enabled.is_some() {
assists.enabled = self.assists_enabled;
}

if let Some(mut configuration) = self.configuration.clone() {
if let Some(linter) = configuration.linter.as_mut() {
// Don't overwrite rules from the CLI configuration.
// Otherwise, rules that are disabled in the config file might
// become re-enabled due to the defaults included in the CLI
// configuration.
linter.rules = None;
}
fs_configuration.merge_with(configuration);
}

Ok(fs_configuration)
}

if let Some(mut configuration) = configuration {
if let Some(linter) = configuration.linter.as_mut() {
// Don't overwrite rules from the CLI configuration.
// Otherwise, rules that are disabled in the config file might
// become re-enabled due to the defaults included in the CLI
// configuration.
linter.rules = None;
fn get_files_to_process(
&self,
fs: &DynRef<'_, dyn FileSystem>,
configuration: &PartialConfiguration,
) -> Result<Vec<OsString>, CliDiagnostic> {
if let Some(paths) = get_files_to_process(
self.since.as_deref(),
self.changed,
self.staged,
fs,
configuration,
)? {
Ok(paths)
} else {
Ok(self.paths.clone())
}
fs_configuration.merge_with(configuration);
}

// check if support of git ignore files is enabled
let vcs_base_path = configuration_path.or(session.app.fs.working_directory());
let (vcs_base_path, gitignore_matches) =
fs_configuration.retrieve_gitignore_matches(&session.app.fs, vcs_base_path.as_deref())?;

let stdin = get_stdin(stdin_file_path, &mut *session.app.console, "check")?;

let vcs_targeted_paths = get_files_to_process(
since.as_deref(),
changed,
staged,
&session.app.fs,
&fs_configuration,
)?;

session
.app
.workspace
.register_project_folder(RegisterProjectFolderParams {
path: session.app.fs.working_directory(),
set_as_current_workspace: true,
})?;
let manifest_data = resolve_manifest(&session.app.fs)?;

if let Some(manifest_data) = manifest_data {
session
.app
.workspace
.set_manifest_for_project(manifest_data.into())?;
fn get_stdin_file_path(&self) -> Option<&str> {
self.stdin_file_path.as_deref()
}

fn should_write(&self) -> bool {
self.write || self.fix
}

session
.app
.workspace
.update_settings(UpdateSettingsParams {
workspace_directory: session.app.fs.working_directory(),
configuration: fs_configuration,
vcs_base_path,
gitignore_matches,
})?;

execute_mode(
Execution::new(TraversalMode::Check {
fn get_execution(
&self,
cli_options: &CliOptions,
console: &mut dyn Console,
_workspace: &dyn Workspace,
) -> Result<Execution, CliDiagnostic> {
let fix_file_mode = determine_fix_file_mode(
FixFileModeOptions {
apply: self.apply,
apply_unsafe: self.apply_unsafe,
write: self.write,
fix: self.fix,
unsafe_: self.unsafe_,
},
console,
)?;

Ok(Execution::new(TraversalMode::Check {
fix_file_mode,
stdin,
vcs_targeted: VcsTargeted { staged, changed },
stdin: self.get_stdin(console)?,
vcs_targeted: (self.staged, self.changed).into(),
})
.set_report(&cli_options),
session,
&cli_options,
vcs_targeted_paths.unwrap_or(paths),
)
.set_report(cli_options))
}
}
Loading
Loading