adjust

Author: juleswritescode

crates/pg_cli/src/cli_options.rs

@@ -18,7 +18,7 @@ pub struct CliOptions {
     #[bpaf(long("use-server"), switch, fallback(false))]
     pub use_server: bool,
 
-    /// Skip over files containing syntax errors instead of emitting an error diagnostic.
+    /// Skip connecting to the database and only run checks that don't require a database connection.
     #[bpaf(long("skip-db"), switch, fallback(false))]
     pub skip_db: bool,
 

crates/pg_cli/src/execute/mod.rs

@@ -9,7 +9,6 @@ use crate::reporter::github::{GithubReporter, GithubReporterVisitor};
 use crate::reporter::gitlab::{GitLabReporter, GitLabReporterVisitor};
 use crate::reporter::junit::{JunitReporter, JunitReporterVisitor};
 use crate::reporter::terminal::{ConsoleReporter, ConsoleReporterVisitor};
-use crate::reporter::UserHintsPayload;
 use crate::{CliDiagnostic, CliSession, DiagnosticsPayload, Reporter};
 use pg_diagnostics::{category, Category};
 use pg_fs::PgLspPath;
@@ -243,7 +242,6 @@ pub fn execute_mode(
             summary,
             evaluated_paths,
             diagnostics,
-            user_hints,
         } = traverse(&execution, &mut session, cli_options, paths)?;
         let console = session.app.console;
         let errors = summary.errors;
@@ -262,7 +260,6 @@ pub fn execute_mode(
                     },
                     execution: execution.clone(),
                     evaluated_paths,
-                    user_hints_payload: UserHintsPayload { hints: user_hints },
                 };
                 reporter.write(&mut ConsoleReporterVisitor(console))?;
             }
@@ -274,7 +271,6 @@ pub fn execute_mode(
                         diagnostics,
                     },
                     execution: execution.clone(),
-                    user_hints: UserHintsPayload { hints: user_hints },
                 };
                 reporter.write(&mut GithubReporterVisitor(console))?;
             }
@@ -286,7 +282,6 @@ pub fn execute_mode(
                         diagnostics,
                     },
                     execution: execution.clone(),
-                    user_hints: UserHintsPayload { hints: user_hints },
                 };
                 reporter.write(&mut GitLabReporterVisitor::new(
                     console,
@@ -302,7 +297,6 @@ pub fn execute_mode(
                         diagnostics,
                     },
                     execution: execution.clone(),
-                    user_hints: UserHintsPayload { hints: user_hints },
                 };
                 reporter.write(&mut JunitReporterVisitor::new(console))?;
             }

crates/pg_cli/src/execute/process_file.rs

@@ -46,7 +46,6 @@ pub(crate) enum Message {
         diagnostics: Vec<Error>,
         skipped_diagnostics: u32,
     },
-    Hint(String),
 }
 
 impl Message {

crates/pg_cli/src/execute/traverse.rs

@@ -14,7 +14,7 @@ use pg_workspace::workspace::IsPathIgnoredParams;
 use pg_workspace::{Workspace, WorkspaceError};
 use rustc_hash::FxHashSet;
 use std::collections::BTreeSet;
-use std::sync::atomic::{AtomicBool, AtomicU32};
+use std::sync::atomic::AtomicU32;
 use std::sync::RwLock;
 use std::{
     env::current_dir,
@@ -33,7 +33,6 @@ pub(crate) struct TraverseResult {
     pub(crate) summary: TraversalSummary,
     pub(crate) evaluated_paths: BTreeSet<PgLspPath>,
     pub(crate) diagnostics: Vec<Error>,
-    pub(crate) user_hints: Vec<String>,
 }
 
 pub(crate) fn traverse(
@@ -73,7 +72,6 @@ pub(crate) fn traverse(
     let unchanged = AtomicUsize::new(0);
     let matches = AtomicUsize::new(0);
     let skipped = AtomicUsize::new(0);
-    let skipped_db_conn = AtomicBool::new(false);
 
     let fs = &*session.app.fs;
     let workspace = &*session.app.workspace;
@@ -86,7 +84,7 @@ pub(crate) fn traverse(
         .with_diagnostic_level(cli_options.diagnostic_level)
         .with_max_diagnostics(max_diagnostics);
 
-    let (duration, evaluated_paths, diagnostics, mut user_hints) = thread::scope(|s| {
+    let (duration, evaluated_paths, diagnostics) = thread::scope(|s| {
         let handler = thread::Builder::new()
             .name(String::from("pglsp::console"))
             .spawn_scoped(s, || printer.run(receiver, recv_files))
@@ -106,16 +104,15 @@ pub(crate) fn traverse(
                 changed: &changed,
                 unchanged: &unchanged,
                 skipped: &skipped,
-                skipped_db_conn: &skipped_db_conn,
                 messages: sender,
                 remaining_diagnostics: &remaining_diagnostics,
                 evaluated_paths: RwLock::default(),
             },
         );
         // wait for the main thread to finish
-        let (diagnostics, user_hints) = handler.join().unwrap();
+        let diagnostics = handler.join().unwrap();
 
-        (elapsed, evaluated_paths, diagnostics, user_hints)
+        (elapsed, evaluated_paths, diagnostics)
     });
 
     let errors = printer.errors();
@@ -127,19 +124,6 @@ pub(crate) fn traverse(
     let suggested_fixes_skipped = printer.skipped_fixes();
     let diagnostics_not_printed = printer.not_printed_diagnostics();
 
-    if duration.as_secs() >= 2 {
-        user_hints.push(format!(
-            "The traversal took longer than expected ({}s). Consider using the `--skip-db` option if your Postgres connection is slow.",
-            duration.as_secs()
-        ));
-    }
-
-    if skipped_db_conn.load(Ordering::Relaxed) {
-        user_hints.push(format!(
-            "Skipped all checks requiring database connections.",
-        ));
-    }
-
     Ok(TraverseResult {
         summary: TraversalSummary {
             changed,
@@ -154,7 +138,6 @@ pub(crate) fn traverse(
         },
         evaluated_paths,
         diagnostics,
-        user_hints,
     })
 }
 
@@ -306,15 +289,10 @@ impl<'ctx> DiagnosticsPrinter<'ctx> {
         should_print
     }
 
-    fn run(
-        &self,
-        receiver: Receiver<Message>,
-        interner: Receiver<PathBuf>,
-    ) -> (Vec<Error>, Vec<String>) {
+    fn run(&self, receiver: Receiver<Message>, interner: Receiver<PathBuf>) -> Vec<Error> {
         let mut paths: FxHashSet<String> = FxHashSet::default();
 
         let mut diagnostics_to_print = vec![];
-        let mut hints_to_print = vec![];
 
         while let Ok(msg) = receiver.recv() {
             match msg {
@@ -329,10 +307,6 @@ impl<'ctx> DiagnosticsPrinter<'ctx> {
                     self.errors.fetch_add(1, Ordering::Relaxed);
                 }
 
-                Message::Hint(hint) => {
-                    hints_to_print.push(hint);
-                }
-
                 Message::Error(mut err) => {
                     let location = err.location();
                     if self.should_skip_diagnostic(err.severity(), err.tags()) {
@@ -409,7 +383,7 @@ impl<'ctx> DiagnosticsPrinter<'ctx> {
             }
         }
 
-        (diagnostics_to_print, hints_to_print)
+        diagnostics_to_print
     }
 }
 
@@ -431,8 +405,6 @@ pub(crate) struct TraversalOptions<'ctx, 'app> {
     matches: &'ctx AtomicUsize,
     /// Shared atomic counter storing the number of skipped files
     skipped: &'ctx AtomicUsize,
-    /// Shared atomic bool tracking whether we used a DB connection
-    skipped_db_conn: &'ctx AtomicBool,
     /// Channel sending messages to the display thread
     pub(crate) messages: Sender<Message>,
     /// The approximate number of diagnostics the console will print before
@@ -464,10 +436,6 @@ impl TraversalOptions<'_, '_> {
         self.messages.send(msg.into()).ok();
     }
 
-    pub(crate) fn set_skipped_db_conn(&self, has_skipped: bool) {
-        self.skipped_db_conn.store(has_skipped, Ordering::Relaxed);
-    }
-
     pub(crate) fn protected_file(&self, pglsp_path: &PgLspPath) {
         self.push_diagnostic(
             WorkspaceError::protected_file(pglsp_path.display().to_string()).into(),

crates/pg_cli/src/reporter/github.rs

@@ -3,18 +3,14 @@ use pg_console::{markup, Console, ConsoleExt};
 use pg_diagnostics::PrintGitHubDiagnostic;
 use std::io;
 
-use super::UserHintsPayload;
-
 pub(crate) struct GithubReporter {
     pub(crate) diagnostics_payload: DiagnosticsPayload,
     pub(crate) execution: Execution,
-    pub(crate) user_hints: UserHintsPayload,
 }
 
 impl Reporter for GithubReporter {
     fn write(self, visitor: &mut dyn ReporterVisitor) -> io::Result<()> {
         visitor.report_diagnostics(&self.execution, self.diagnostics_payload)?;
-        visitor.report_user_hints(&self.execution, self.user_hints)?;
         Ok(())
     }
 }
@@ -46,15 +42,4 @@ impl ReporterVisitor for GithubReporterVisitor<'_> {
 
         Ok(())
     }
-
-    fn report_user_hints(
-        &mut self,
-        _execution: &Execution,
-        payload: super::UserHintsPayload,
-    ) -> io::Result<()> {
-        for hint in payload.hints {
-            self.0.log(markup! {{hint}});
-        }
-        Ok(())
-    }
 }

crates/pg_cli/src/reporter/gitlab.rs

@@ -12,18 +12,14 @@ use std::{
     path::{Path, PathBuf},
 };
 
-use super::UserHintsPayload;
-
 pub struct GitLabReporter {
     pub(crate) execution: Execution,
     pub(crate) diagnostics: DiagnosticsPayload,
-    pub(crate) user_hints: UserHintsPayload,
 }
 
 impl Reporter for GitLabReporter {
     fn write(self, visitor: &mut dyn ReporterVisitor) -> std::io::Result<()> {
         visitor.report_diagnostics(&self.execution, self.diagnostics)?;
-        visitor.report_user_hints(&self.execution, self.user_hints)?;
         Ok(())
     }
 }
@@ -76,17 +72,6 @@ impl ReporterVisitor for GitLabReporterVisitor<'_> {
         self.console.log(markup!({ diagnostics }));
         Ok(())
     }
-
-    fn report_user_hints(
-        &mut self,
-        _execution: &Execution,
-        payload: super::UserHintsPayload,
-    ) -> std::io::Result<()> {
-        for hint in payload.hints {
-            self.console.log(markup! {{hint}});
-        }
-        Ok(())
-    }
 }
 
 struct GitLabDiagnostics<'a>(

crates/pg_cli/src/reporter/junit.rs

@@ -6,20 +6,16 @@ use quick_junit::{NonSuccessKind, Report, TestCase, TestCaseStatus, TestSuite};
 use std::fmt::{Display, Formatter};
 use std::io;
 
-use super::UserHintsPayload;
-
 pub(crate) struct JunitReporter {
     pub(crate) diagnostics_payload: DiagnosticsPayload,
     pub(crate) execution: Execution,
     pub(crate) summary: TraversalSummary,
-    pub(crate) user_hints: UserHintsPayload,
 }
 
 impl Reporter for JunitReporter {
     fn write(self, visitor: &mut dyn ReporterVisitor) -> io::Result<()> {
         visitor.report_summary(&self.execution, self.summary)?;
         visitor.report_diagnostics(&self.execution, self.diagnostics_payload)?;
-        visitor.report_user_hints(&self.execution, self.user_hints)?;
         Ok(())
     }
 }
@@ -122,17 +118,4 @@ impl ReporterVisitor for JunitReporterVisitor<'_> {
 
         Ok(())
     }
-
-    fn report_user_hints(
-        &mut self,
-        _execution: &Execution,
-        payload: super::UserHintsPayload,
-    ) -> io::Result<()> {
-        for hint in payload.hints {
-            self.1.log(markup! {
-                {hint}
-            });
-        }
-        Ok(())
-    }
 }

crates/pg_cli/src/reporter/mod.rs

@@ -17,10 +17,6 @@ pub struct DiagnosticsPayload {
     pub diagnostic_level: Severity,
 }
 
-pub struct UserHintsPayload {
-    pub hints: Vec<String>,
-}
-
 /// A type that holds the result of the traversal
 #[derive(Debug, Default, Serialize, Copy, Clone)]
 pub struct TraversalSummary {
@@ -64,11 +60,4 @@ pub trait ReporterVisitor {
         execution: &Execution,
         payload: DiagnosticsPayload,
     ) -> io::Result<()>;
-
-    /// Writes a diagnostics
-    fn report_user_hints(
-        &mut self,
-        execution: &Execution,
-        payload: UserHintsPayload,
-    ) -> io::Result<()>;
 }

crates/pg_cli/src/reporter/terminal.rs

@@ -10,22 +10,18 @@ use std::collections::BTreeSet;
 use std::io;
 use std::time::Duration;
 
-use super::UserHintsPayload;
-
 pub(crate) struct ConsoleReporter {
     pub(crate) summary: TraversalSummary,
     pub(crate) diagnostics_payload: DiagnosticsPayload,
     pub(crate) execution: Execution,
     pub(crate) evaluated_paths: BTreeSet<PgLspPath>,
-    pub(crate) user_hints_payload: UserHintsPayload,
 }
 
 impl Reporter for ConsoleReporter {
     fn write(self, visitor: &mut dyn ReporterVisitor) -> io::Result<()> {
         let verbose = self.diagnostics_payload.verbose;
         visitor.report_diagnostics(&self.execution, self.diagnostics_payload)?;
         visitor.report_summary(&self.execution, self.summary)?;
-        visitor.report_user_hints(&self.execution, self.user_hints_payload)?;
         if verbose {
             visitor.report_handled_paths(self.evaluated_paths)?;
         }
@@ -119,18 +115,6 @@ impl ReporterVisitor for ConsoleReporterVisitor<'_> {
 
         Ok(())
     }
-
-    fn report_user_hints(
-        &mut self,
-        _execution: &Execution,
-        payload: UserHintsPayload,
-    ) -> io::Result<()> {
-        for hint in payload.hints {
-            self.0.log(markup! {{hint}});
-        }
-        self.0.log(markup! {{"\n"}});
-        Ok(())
-    }
 }
 
 struct Files(usize);