perf(lsp): scan project based on ScanKind (#6099)

Co-authored-by: arendjr <[email protected]>

Author: ematipico

crates/biome_cli/examples/text_reporter.rs

@@ -1,26 +1,21 @@
 use biome_cli::{
     DiagnosticsPayload, Execution, Reporter, ReporterVisitor, TraversalSummary, VcsTargeted,
 };
-use biome_service::projects::ProjectKey;
 
 /// This will be the visitor, which where we **write** the data
 struct BufferVisitor(String);
 
 /// This is the reporter, which will be a type that will hold the information needed to the reporter
 struct TextReport {
-    project_key: ProjectKey,
     summary: TraversalSummary,
 }
 
 impl Reporter for TextReport {
     fn write(self, visitor: &mut dyn ReporterVisitor) -> std::io::Result<()> {
-        let execution = Execution::new_format(
-            self.project_key,
-            VcsTargeted {
-                staged: false,
-                changed: false,
-            },
-        );
+        let execution = Execution::new_format(VcsTargeted {
+            staged: false,
+            changed: false,
+        });
         visitor.report_summary(&execution, self.summary, false)?;
         Ok(())
     }
@@ -50,19 +45,13 @@ impl ReporterVisitor for BufferVisitor {
 
 pub fn main() {
     // In a real scenario, the project key is obtained from the
-    // `Workspace::open_project()` call.
-    let project_key = ProjectKey::new();
-
     let summary = TraversalSummary {
         changed: 32,
         unchanged: 28,
         ..TraversalSummary::default()
     };
     let mut visitor = BufferVisitor(String::new());
-    let reporter = TextReport {
-        project_key,
-        summary,
-    };
+    let reporter = TextReport { summary };
     reporter.write(&mut visitor).unwrap();
 
     assert_eq!(visitor.0.as_str(), "Total is 64")

crates/biome_cli/src/commands/check.rs

@@ -9,7 +9,6 @@ use biome_configuration::{Configuration, FormatterConfiguration, LinterConfigura
 use biome_console::Console;
 use biome_deserialize::Merge;
 use biome_fs::FileSystem;
-use biome_service::projects::ProjectKey;
 use biome_service::{Workspace, WorkspaceError, configuration::LoadedConfiguration};
 use std::ffi::OsString;
 
@@ -123,7 +122,6 @@ impl CommandRunner for CheckCommandPayload {
         cli_options: &CliOptions,
         console: &mut dyn Console,
         _workspace: &dyn Workspace,
-        project_key: ProjectKey,
     ) -> Result<Execution, CliDiagnostic> {
         let fix_file_mode = determine_fix_file_mode(FixFileModeOptions {
             write: self.write,
@@ -134,7 +132,6 @@ impl CommandRunner for CheckCommandPayload {
         })?;
 
         Ok(Execution::new(TraversalMode::Check {
-            project_key,
             fix_file_mode,
             stdin: self.get_stdin(console)?,
             vcs_targeted: (self.staged, self.changed).into(),

crates/biome_cli/src/commands/ci.rs

@@ -10,7 +10,6 @@ use biome_console::Console;
 use biome_deserialize::Merge;
 use biome_fs::FileSystem;
 use biome_service::configuration::LoadedConfiguration;
-use biome_service::projects::ProjectKey;
 use biome_service::{Workspace, WorkspaceError};
 use std::ffi::OsString;
 
@@ -114,10 +113,8 @@ impl CommandRunner for CiCommandPayload {
         cli_options: &CliOptions,
         _console: &mut dyn Console,
         _workspace: &dyn Workspace,
-        project_key: ProjectKey,
     ) -> Result<Execution, CliDiagnostic> {
         Ok(Execution::new_ci(
-            project_key,
             (false, self.changed).into(),
             self.enforce_assist,
             cli_options.skip_parse_errors,

crates/biome_cli/src/commands/format.rs

@@ -12,7 +12,6 @@ use biome_console::Console;
 use biome_deserialize::Merge;
 use biome_fs::FileSystem;
 use biome_service::configuration::LoadedConfiguration;
-use biome_service::projects::ProjectKey;
 use biome_service::{Workspace, WorkspaceError};
 use std::ffi::OsString;
 
@@ -138,10 +137,8 @@ impl CommandRunner for FormatCommandPayload {
         cli_options: &CliOptions,
         console: &mut dyn Console,
         _workspace: &dyn Workspace,
-        project_key: ProjectKey,
     ) -> Result<Execution, CliDiagnostic> {
         Ok(Execution::new(TraversalMode::Format {
-            project_key,
             skip_parse_errors: cli_options.skip_parse_errors,
             write: self.should_write(),
             stdin: self.get_stdin(console)?,

crates/biome_cli/src/commands/lint.rs

@@ -13,7 +13,6 @@ use biome_console::Console;
 use biome_deserialize::Merge;
 use biome_fs::FileSystem;
 use biome_service::configuration::LoadedConfiguration;
-use biome_service::projects::ProjectKey;
 use biome_service::{Workspace, WorkspaceError};
 use std::ffi::OsString;
 
@@ -127,7 +126,6 @@ impl CommandRunner for LintCommandPayload {
         cli_options: &CliOptions,
         console: &mut dyn Console,
         _workspace: &dyn Workspace,
-        project_key: ProjectKey,
     ) -> Result<Execution, CliDiagnostic> {
         let fix_file_mode = determine_fix_file_mode(FixFileModeOptions {
             write: self.write,
@@ -137,7 +135,6 @@ impl CommandRunner for LintCommandPayload {
             suppression_reason: self.suppression_reason.clone(),
         })?;
         Ok(Execution::new(TraversalMode::Lint {
-            project_key,
             fix_file_mode,
             stdin: self.get_stdin(console)?,
             only: self.only.clone(),

crates/biome_cli/src/commands/migrate.rs

@@ -9,7 +9,6 @@ use biome_configuration::Configuration;
 use biome_console::{Console, ConsoleExt, markup};
 use biome_fs::FileSystem;
 use biome_service::configuration::LoadedConfiguration;
-use biome_service::projects::ProjectKey;
 use biome_service::{Workspace, WorkspaceError};
 use camino::Utf8PathBuf;
 use std::ffi::OsString;
@@ -57,11 +56,9 @@ impl CommandRunner for MigrateCommandPayload {
         _cli_options: &CliOptions,
         console: &mut dyn Console,
         _workspace: &dyn Workspace,
-        project_key: ProjectKey,
     ) -> Result<Execution, CliDiagnostic> {
         if let Some(path) = self.configuration_file_path.clone() {
             Ok(Execution::new(TraversalMode::Migrate {
-                project_key,
                 write: self.should_write(),
                 configuration_file_path: path,
                 sub_command: self.sub_command.clone(),

crates/biome_cli/src/commands/mod.rs

@@ -4,7 +4,8 @@ use crate::commands::scan_kind::compute_scan_kind;
 use crate::execute::Stdin;
 use crate::logging::LoggingKind;
 use crate::{
-    CliDiagnostic, CliSession, Execution, LoggingLevel, VERSION, execute_mode, setup_cli_subscriber,
+    CliDiagnostic, CliSession, Execution, LoggingLevel, TraversalMode, VERSION, execute_mode,
+    setup_cli_subscriber,
 };
 use biome_configuration::analyzer::assist::AssistEnabled;
 use biome_configuration::analyzer::{LinterEnabled, RuleSelector};
@@ -34,7 +35,7 @@ use biome_service::configuration::{LoadedConfiguration, load_configuration, load
 use biome_service::documentation::Doc;
 use biome_service::projects::ProjectKey;
 use biome_service::workspace::{
-    FixFileMode, OpenProjectParams, ScanProjectFolderParams, UpdateSettingsParams,
+    FixFileMode, OpenProjectParams, ScanKind, ScanProjectFolderParams, UpdateSettingsParams,
 };
 use biome_service::{Workspace, WorkspaceError};
 use bpaf::Bpaf;
@@ -791,6 +792,7 @@ pub(crate) trait CommandRunner: Sized {
             paths,
             duration,
             configuration_files,
+            project_key,
         } = self.configure_workspace(fs, console, workspace, cli_options)?;
         execute_mode(
             execution,
@@ -799,6 +801,7 @@ pub(crate) trait CommandRunner: Sized {
             paths,
             duration,
             configuration_files,
+            project_key,
         )
     }
 
@@ -837,16 +840,37 @@ pub(crate) trait CommandRunner: Sized {
             .working_directory()
             .map(BiomePath::from)
             .unwrap_or_default();
-        let project_key = workspace.open_project(OpenProjectParams {
-            path: project_path.clone(),
-            open_uninitialized: true,
-        })?;
 
-        let execution = self.get_execution(cli_options, console, workspace, project_key)?;
-        let scan_kind = compute_scan_kind(&execution, &configuration);
+        let execution = self.get_execution(cli_options, console, workspace)?;
+
+        let params = if let TraversalMode::Lint { only, skip, .. } = execution.traversal_mode() {
+            OpenProjectParams {
+                path: project_path.clone(),
+                open_uninitialized: true,
+                only_rules: Some(only.clone()),
+                skip_rules: Some(skip.clone()),
+            }
+        } else {
+            OpenProjectParams {
+                path: project_path.clone(),
+                open_uninitialized: true,
+                only_rules: None,
+                skip_rules: None,
+            }
+        };
+
+        let open_project_result = workspace.open_project(params)?;
+
+        let scan_kind = compute_scan_kind(&execution, &configuration).unwrap_or({
+            if open_project_result.scan_kind == ScanKind::None && configuration.use_ignore_file() {
+                ScanKind::KnownFiles
+            } else {
+                open_project_result.scan_kind
+            }
+        });
 
         let result = workspace.update_settings(UpdateSettingsParams {
-            project_key,
+            project_key: open_project_result.project_key,
             // When the user provides the path to the configuration, we can't use its directory because
             // it might be outside the project, so we need to use the current project directory.
             workspace_directory: if is_configuration_from_user {
@@ -865,7 +889,7 @@ pub(crate) trait CommandRunner: Sized {
         }
 
         let result = workspace.scan_project_folder(ScanProjectFolderParams {
-            project_key,
+            project_key: open_project_result.project_key,
             path: Some(project_path.clone()),
             watch: cli_options.use_server,
             force: false, // TODO: Maybe we'll want a CLI flag for this.
@@ -886,6 +910,7 @@ pub(crate) trait CommandRunner: Sized {
             paths,
             duration: Some(result.duration),
             configuration_files: result.configuration_files,
+            project_key: open_project_result.project_key,
         })
     }
 
@@ -941,7 +966,6 @@ pub(crate) trait CommandRunner: Sized {
         cli_options: &CliOptions,
         console: &mut dyn Console,
         workspace: &dyn Workspace,
-        project_key: ProjectKey,
     ) -> Result<Execution, CliDiagnostic>;
 
     // Below, methods that consumers can implement
@@ -968,6 +992,8 @@ pub(crate) struct ConfiguredWorkspace {
     pub duration: Option<Duration>,
     /// Configuration files found inside the project
     pub configuration_files: Vec<BiomePath>,
+    /// The unique identifier of the project
+    pub project_key: ProjectKey,
 }
 
 pub trait LoadEditorConfig: CommandRunner {