feat: add logging verbosity flags to cli (#4471)

Co-authored-by: Maximilian Roos <[email protected]>

Author: m-span

Cargo.lock

@@ -16,6 +16,7 @@ cli = [
   "anyhow",
   "clap_complete_command",
   "clap_complete",
+  "clap-verbosity-flag",
   "clap",
   "clio",
   "color-eyre",
@@ -69,6 +70,8 @@ strum_macros = "0.26.2"
 anyhow = {version = "1.0.86", features = ["backtrace"], optional = true}
 clap = {version = "4.4.18", features = ["derive", "env", "wrap_help"], optional = true}
 clap_complete_command = {version = "0.5.1", optional = true}
+# Pinned for MSRV
+clap-verbosity-flag = {version = "=2.1.2", optional = true}
 clio = {version = "0.3.3", features = ['clap-parse'], optional = true}
 color-eyre = {version = "0.6.3", optional = true}
 colorchoice-clap = {version = "1.0.0", optional = true}
@@ -79,7 +82,9 @@ walkdir = {version = "2.5.0", optional = true}
 
 # Not direct dependencies, but pinning because of bugs in previous versions. Can
 # remove when dependencies no longer use it. (If CI passes, it can be removed.)
-clap_complete = {version = "4.4.9", optional = true}
+clap_builder = {version = "=4.4.18", optional = true}
+clap_complete = {version = "=4.4.10", optional = true}
+clap_complete_fig = {version = "=4.4.2", optional = true}
 
 # We use minijinja just for the Jinja lexer, which is not part of the
 # public interface which is covered by semver guarantees.

prqlc/prqlc/Cargo.toml

@@ -1,26 +1,24 @@
 #![cfg(not(target_family = "wasm"))]
 
-mod docs_generator;
-mod jinja;
-mod watch;
+use std::collections::HashMap;
+use std::env;
+use std::io::{Read, Write};
+use std::ops::Range;
+use std::path::Path;
+use std::process::exit;
+use std::str::FromStr;
 
 use anstream::{eprintln, println};
 use anyhow::anyhow;
 use anyhow::bail;
 use anyhow::Result;
 use ariadne::Source;
 use clap::{CommandFactory, Parser, Subcommand, ValueHint};
+use clap_verbosity_flag::LogLevel;
 use clio::has_extension;
 use clio::Output;
 use is_terminal::IsTerminal;
 use itertools::Itertools;
-use std::collections::HashMap;
-use std::env;
-use std::io::{Read, Write};
-use std::ops::Range;
-use std::path::Path;
-use std::process::exit;
-use std::str::FromStr;
 
 use prqlc::semantic;
 use prqlc::semantic::reporting::{collect_frames, label_references};
@@ -30,11 +28,18 @@ use prqlc::{ir::pl::Lineage, ir::Span};
 use prqlc::{pl_to_prql, pl_to_rq_tree, prql_to_pl, prql_to_pl_tree, rq_to_sql, SourceTree};
 use prqlc::{Options, Target};
 
+mod docs_generator;
+mod jinja;
+mod watch;
+
 /// Entrypoint called by [`crate::main`]
 pub fn main() -> color_eyre::eyre::Result<()> {
-    env_logger::builder().format_timestamp(None).init();
-    color_eyre::install()?;
     let mut cli = Cli::parse();
+    env_logger::builder()
+        .filter_level(cli.verbose.log_level_filter())
+        .format_timestamp(None)
+        .init();
+    color_eyre::install()?;
     cli.color.write_global();
 
     if let Err(error) = cli.command.run() {
@@ -66,6 +71,9 @@ struct Cli {
     command: Command,
     #[command(flatten)]
     color: colorchoice_clap::Color,
+
+    #[command(flatten)]
+    verbose: clap_verbosity_flag::Verbosity<LoggingHelp>,
 }
 
 #[derive(Subcommand, Debug, Clone)]
@@ -207,6 +215,37 @@ pub struct IoArgs {
     main_path: Option<String>,
 }
 
+#[derive(Copy, Clone, Debug, Default)]
+struct LoggingHelp;
+
+impl LogLevel for LoggingHelp {
+    /// By default, this will only report errors.
+    fn default() -> Option<log::Level> {
+        Some(log::Level::Error)
+    }
+    fn verbose_help() -> Option<&'static str> {
+        Some("Increase logging verbosity")
+    }
+
+    fn verbose_long_help() -> Option<&'static str> {
+        Some(
+            r#"More v's, More vebose logging:
+-v shows warnings
+-vv shows info
+-vvv shows debug
+-vvvv shows trace"#,
+        )
+    }
+
+    fn quiet_help() -> Option<&'static str> {
+        Some("Silences logging output")
+    }
+
+    fn quiet_long_help() -> Option<&'static str> {
+        Some("Silences logging output")
+    }
+}
+
 #[derive(clap::ValueEnum, Clone, Debug)]
 enum Format {
     Json,

prqlc/prqlc/src/cli/mod.rs

@@ -32,10 +32,27 @@ fn help() {
       help              Print this message or the help of the given subcommand(s)
 
     Options:
-          --color <WHEN>  Controls when to use color [default: auto] [possible values: auto, always,
-                          never]
-      -h, --help          Print help
-      -V, --version       Print version
+          --color <WHEN>
+              Controls when to use color
+              
+              [default: auto]
+              [possible values: auto, always, never]
+
+      -v, --verbose...
+              More v's, More vebose logging:
+              -v shows warnings
+              -vv shows info
+              -vvv shows debug
+              -vvvv shows trace
+
+      -q, --quiet...
+              Silences logging output
+
+      -h, --help
+              Print help (see a summary with '-h')
+
+      -V, --version
+              Print version
 
     ----- stderr -----
     "###);
@@ -123,6 +140,16 @@ fn compile_help() {
               [default: auto]
               [possible values: auto, always, never]
 
+      -v, --verbose...
+              More v's, More vebose logging:
+              -v shows warnings
+              -vv shows info
+              -vvv shows debug
+              -vvvv shows trace
+
+      -q, --quiet...
+              Silences logging output
+
       -h, --help
               Print help (see a summary with '-h')