feat: replace --verbose with --quiet (#370)

* Replace --verbose with --quiet

* Replaced last remaining "verbose" with "quiet"

* Fix capitalization of "Print"

* fix: spacing in readme

* Run "cargo clippy --fix"

---------

Co-authored-by: Esteban Borai <[email protected]>

Author: Antosser

README.md

@@ -48,7 +48,7 @@ FLAGS:
         --logger               Prints HTTP request and response details to stdout
         --tls                  Enables HTTPS serving using TLS
     -V, --version              Prints version information
-    -v, --verbose              Turns on stdout/stderr logging
+    -q, --quiet                Turns off stdout/stderr logging
 
 OPTIONS:
     -c, --config <config>                          Path to TOML configuration file
@@ -84,7 +84,7 @@ Configuration File | Specifies a configuration file. [Example](https://github.co
 HTTPS (TLS) | HTTPS Secure connection configuration. Refer to [TLS (HTTPS)](https://github.com/http-server-rs/http-server#tls-https) reference | Disabled
 CORS | Cross-Origin-Resource-Sharing headers support. Refer to [CORS](https://github.com/http-server-rs/http-server#cross-origin-resource-sharing-cors) reference | Disabled
 Compression | GZip compression for HTTP Response Bodies. Refer to [Compression](https://github.com/http-server-rs/http-server#compression) reference | Disabled
-Verbose | Print server details when running. This doesn't include any logging capabilities. | Disabled
+Quiet | Don't print server details when running. This doesn't include any logging capabilities. | Disabled
 Basic Authentication | Authorize requests using Basic Authentication. Refer to [Basic Authentication](https://github.com/http-server-rs/http-server#basic-authentication)  | Disabled
 Logger | Prints HTTP request and response details to stdout | Disabled
 
@@ -110,7 +110,7 @@ Graceful Shutdown | N/A | `--graceful-shutdown` | Wait for all requests to be fu
 Help | N/A | `--help` | Print help information
 Logger | `-l` | `--logger` | Print HTTP request and response details to stdout
 Version | `-V` | `--version` | Print version information
-Verbose | `-v` | `--verbose` | Print output to console
+Quiet | `-q` | `--quiet` | Don't print output to console
 
 ### Options
 

fixtures/config.toml

@@ -4,7 +4,7 @@
 host = "127.0.0.1"
 port = 7878
 
-# verbose = false
+# quiet = false
 # root_dir = "./"
 # graceful_shutdown = false
 

rustfmt.toml

@@ -1,6 +1,6 @@
-# Use verbose output.
+# Use quiet output.
 # Default: false
-#   verbose = 
+#   quiet = 
 
 # Do not reformat out of line modules.
 # Default: false
@@ -275,4 +275,4 @@
 
 # Replace strings of _ wildcards by a single .. in tuple patterns.
 # Default: false
-#   condense_wildcard_suffices = 
+#   condense_wildcard_suffices =

src/cli.rs

@@ -24,9 +24,9 @@ pub struct Cli {
     /// Directory to serve files from
     #[structopt(parse(from_os_str), default_value = "./")]
     pub root_dir: PathBuf,
-    /// Turns on stdout/stderr logging
-    #[structopt(short = "v", long = "verbose")]
-    pub verbose: bool,
+    /// Turns off stdout/stderr logging
+    #[structopt(short = "q", long = "quiet")]
+    pub quiet: bool,
     /// Enables HTTPS serving using TLS
     #[structopt(long = "tls")]
     pub tls: bool,
@@ -75,7 +75,7 @@ impl Default for Cli {
             host: "127.0.0.1".parse().unwrap(),
             port: 7878_u16,
             root_dir: PathBuf::from_str("./").unwrap(),
-            verbose: false,
+            quiet: false,
             tls: false,
             tls_cert: PathBuf::from_str("cert.pem").unwrap(),
             tls_key: PathBuf::from_str("key.rsa").unwrap(),
@@ -142,11 +142,11 @@ mod tests {
     }
 
     #[test]
-    fn with_verbose() {
-        let from_args = Cli::from_str_args(vec!["http-server", "--verbose"]);
+    fn with_quiet() {
+        let from_args = Cli::from_str_args(vec!["http-server", "--quiet"]);
         let mut expect = Cli::default();
 
-        expect.verbose = true;
+        expect.quiet = true;
 
         assert_eq!(from_args, expect);
     }

src/config/file.rs

@@ -15,7 +15,7 @@ use super::tls::TlsConfigFile;
 pub struct ConfigFile {
     pub host: IpAddr,
     pub port: u16,
-    pub verbose: Option<bool>,
+    pub quiet: Option<bool>,
     #[serde(default = "current_working_dir")]
     #[serde(deserialize_with = "canonicalize_some")]
     pub root_dir: Option<PathBuf>,
@@ -76,7 +76,7 @@ mod tests {
         let file_contents = r#"
             host = "192.168.0.1"
             port = 7878
-            verbose = true
+            quiet = true
             root_dir = "./fixtures"
         "#;
         let host = IpAddr::V4(Ipv4Addr::new(192, 168, 0, 1));
@@ -91,7 +91,7 @@ mod tests {
         assert!(config.compression.is_none());
         assert_eq!(config.host, host);
         assert_eq!(config.port, port);
-        assert_eq!(config.verbose, Some(true));
+        assert_eq!(config.quiet, Some(true));
         assert_eq!(config.root_dir, Some(root_dir));
     }
 
@@ -111,7 +111,7 @@ mod tests {
         let file_contents = r#"
             host = "192.168.0.1"
             port = 7878
-            verbose = false
+            quiet = false
 
             [tls]
             cert = "cert_123.pem"
@@ -132,7 +132,7 @@ mod tests {
         assert_eq!(config.port, port);
         assert_eq!(config.root_dir, root_dir);
         assert_eq!(config.tls.unwrap(), tls);
-        assert_eq!(config.verbose, Some(false));
+        assert_eq!(config.quiet, Some(false));
     }
 
     #[test]

src/config/mod.rs

@@ -27,7 +27,7 @@ pub struct Config {
     host: IpAddr,
     port: u16,
     root_dir: PathBuf,
-    verbose: bool,
+    quiet: bool,
     tls: Option<TlsConfig>,
     cors: Option<CorsConfig>,
     compression: Option<CompressionConfig>,
@@ -54,8 +54,8 @@ impl Config {
         self.root_dir.clone()
     }
 
-    pub fn verbose(&self) -> bool {
-        self.verbose
+    pub fn quiet(&self) -> bool {
+        self.quiet
     }
 
     pub fn tls(&self) -> Option<TlsConfig> {
@@ -99,7 +99,7 @@ impl Default for Config {
             port,
             address,
             root_dir,
-            verbose: false,
+            quiet: false,
             tls: None,
             cors: None,
             compression: None,
@@ -115,7 +115,7 @@ impl TryFrom<Cli> for Config {
     type Error = anyhow::Error;
 
     fn try_from(cli_arguments: Cli) -> Result<Self, Self::Error> {
-        let verbose = cli_arguments.verbose;
+        let quiet = cli_arguments.quiet;
         let root_dir = if cli_arguments.root_dir.to_str().unwrap() == "./" {
             current_dir().unwrap()
         } else {
@@ -181,7 +181,7 @@ impl TryFrom<Cli> for Config {
             port: cli_arguments.port,
             address: SocketAddr::new(cli_arguments.host, cli_arguments.port),
             root_dir,
-            verbose,
+            quiet,
             tls,
             cors,
             compression,
@@ -198,7 +198,7 @@ impl TryFrom<ConfigFile> for Config {
 
     fn try_from(file: ConfigFile) -> Result<Self, Self::Error> {
         let root_dir = file.root_dir.unwrap_or_default();
-        let verbose = file.verbose.unwrap_or(false);
+        let quiet = file.quiet.unwrap_or(false);
         let tls: Option<TlsConfig> = if let Some(https_config) = file.tls {
             Some(TlsConfig::new(
                 https_config.cert,
@@ -213,7 +213,7 @@ impl TryFrom<ConfigFile> for Config {
             host: file.host,
             port: file.port,
             address: SocketAddr::new(file.host, file.port),
-            verbose,
+            quiet,
             root_dir,
             tls,
             cors: file.cors,
@@ -249,6 +249,6 @@ mod tests {
             "default socket address: {}",
             address
         );
-        assert!(!config.verbose, "verbose is off by default");
+        assert!(!config.quiet, "quiet is off by default");
     }
 }

src/server/mod.rs

@@ -73,7 +73,7 @@ impl Server {
             }
         }));
 
-        if self.config.verbose() {
+        if !self.config.quiet() {
             println!("Serving HTTP: http://{}", address);
 
             if self.config.address().ip() == Ipv4Addr::from_str("0.0.0.0").unwrap() {
@@ -118,7 +118,7 @@ impl Server {
             }
         }));
 
-        if self.config.verbose() {
+        if !self.config.quiet() {
             println!("Serving HTTPS: http://{}", address);
 
             if self.config.address().ip() == Ipv4Addr::from_str("0.0.0.0").unwrap() {