Crate clap_logger

Source
Expand description

§Clap Logger

Simple env_logger integration for clap.

This create provides a simple way to allow the user to set the log level via a command line argument. Its directly implemented in clap, so it feels very naturally.

Please note this crate does not support clap_derive and won’t support it in the near future or possibly never, since Integrating with it is very hard to do.

§Features

  • Command line argument to set loglevel
  • Argument can be modified
  • Optional: Loglevel via Environment variables
  • directly embedded in clap::Command and clap::ArgMatches

§Status: Beta

§Finished

  • Feature complete (But Open for suggestions)
  • no panics

§TODO

  • Waiting for feedback
  • more tests
  • Complete documentation
  • more examples

§Backlog

  • Figure out if clap_derive support possible,

§Adding the Argument

§Base Implementation:

use clap::Command;
use log::LevelFilter;
use clap_logger::{ClapInitLogger, ClapLoglevelArg};

// Generate a clap command
let m: clap::ArgMatches = Command::new("clap_command_test")
  // add loglevel argument
	.add_loglevel_arg(LevelFilter::Info)
	.get_matches();

§loglevel Arg manipulation

You can also get the Arg directly in order to modify it before adding:`

use clap::{arg, Arg, Command};
use log::LevelFilter;
use clap_logger::{ClapInitLogger, get_loglevel_arg};

// Generate a clap command
let m: clap::ArgMatches = Command::new("clap_command_test")
  // add the add loglevel argument
 	.arg(get_loglevel_arg(LevelFilter::Info)
		// Adding a short version
		.short('l')
    // changing the long version of the argument just because I can
		.long("custom-loglevel")
		.default_value("INFO")
  )
	.get_matches();

Warning: Do NOT touch .possible_values, .id field of the argument or anything in that modifies the input.

§Initialising the logger

§Base implementation:

use clap::Command;
use log::LevelFilter;
use clap_logger::{ClapInitLogger, ClapLoglevelArg};

let m: clap::ArgMatches = Command::new("clap_command_test")
  // add the loglevel argument
 	.add_loglevel_arg(LevelFilter::Info)
	.get_matches();

m.init_logger().expect("Failed to initialize logger");

Macros§

debug
Logs a message at the debug level.
error
Logs a message at the error level.
info
Logs a message at the info level.
trace
Logs a message at the trace level.
warn
Logs a message at the warn level.

Enums§

LevelFilter
An enum representing the available verbosity level filters of the logger.

Traits§

ClapInitLogger
Clap Init Logger
ClapLoglevelArg
CLap LogLevel arg

Functions§

get_loglevel_arg
Get LogLevel Arg