Compare commits

...

6 Commits

Author SHA1 Message Date
crazywhalecc
26dc5fa8c3
Enhance output handling in ConsoleLogger to use STDERR for specific log levels 2025-12-16 10:56:19 +08:00
crazywhalecc
e75fa01ca5
Enhance output handling in ConsoleLogger to use STDERR for specific log levels 2025-12-16 10:56:09 +08:00
crazywhalecc
b28c0c26d5
Add setLevel function 2025-11-08 23:38:01 +08:00
crazywhalecc
2551b3e1db
phpstan 2025-08-02 21:44:27 +08:00
crazywhalecc
81ab0b98f6
Update to 1.1.3 2025-08-02 21:43:12 +08:00
crazywhalecc
1d7427abd8
Add short level format 2025-04-24 10:02:28 +08:00
3 changed files with 46 additions and 28 deletions

View File

@ -1,6 +1,6 @@
{ {
"name": "zhamao/logger", "name": "zhamao/logger",
"description": "Another Console Logger for CLI Applications", "description": "Another Colorful Console Logger for CLI Applications",
"type": "library", "type": "library",
"license": "Apache-2.0", "license": "Apache-2.0",
"autoload": { "autoload": {
@ -16,7 +16,7 @@
"authors": [ "authors": [
{ {
"name": "jerry", "name": "jerry",
"email": "admin@zhamao.me" "email": "github@cwcc.me"
}, },
{ {
"name": "sunxyw", "name": "sunxyw",

View File

@ -10,7 +10,7 @@ use Psr\Log\LogLevel;
class ConsoleLogger extends AbstractLogger class ConsoleLogger extends AbstractLogger
{ {
public const VERSION = '1.1.1'; public const VERSION = '1.1.5';
/** /**
* 日志输出格式 * 日志输出格式
@ -93,13 +93,15 @@ class ConsoleLogger extends AbstractLogger
*/ */
protected $decorated; protected $decorated;
protected $use_stderr = false;
/** /**
* 创建一个 ConsoleLogger 实例 * 创建一个 ConsoleLogger 实例
* *
* @param string $level 日志等级 * @param string $level 日志等级
* @param null|resource $stream * @param null|resource $stream
*/ */
public function __construct(string $level = LogLevel::INFO, $stream = null, bool $decorated = true) public function __construct(string $level = LogLevel::INFO, $stream = null, bool $decorated = true, bool $use_stderr = false)
{ {
$this->decorated = $decorated; $this->decorated = $decorated;
self::$log_level = $this->castLogLevel($level); self::$log_level = $this->castLogLevel($level);
@ -113,12 +115,18 @@ class ConsoleLogger extends AbstractLogger
if (($stat['mode'] & 0170000) === 0100000) { // whether is regular file if (($stat['mode'] & 0170000) === 0100000) { // whether is regular file
$this->decorated = false; $this->decorated = false;
} else { } else {
$this->decorated = $this->decorated
PHP_OS_FAMILY !== 'Windows' // linux or unix = PHP_OS_FAMILY !== 'Windows' // linux or unix
&& function_exists('posix_isatty') && function_exists('posix_isatty')
&& posix_isatty($stream); // whether is interactive terminal && posix_isatty($stream); // whether is interactive terminal
} }
$this->stream = $stream; $this->stream = $stream;
$this->use_stderr = $use_stderr;
}
public function setLevel(string $level): void
{
self::$log_level = $this->castLogLevel($level);
} }
/** /**
@ -162,7 +170,7 @@ class ConsoleLogger extends AbstractLogger
{ {
$log = 'Stack trace:' . PHP_EOL; $log = 'Stack trace:' . PHP_EOL;
$trace = debug_backtrace(); $trace = debug_backtrace();
//array_shift($trace); // array_shift($trace);
foreach ($trace as $i => $t) { foreach ($trace as $i => $t) {
if (!isset($t['file'])) { if (!isset($t['file'])) {
$t['file'] = 'unknown'; $t['file'] = 'unknown';
@ -171,6 +179,7 @@ class ConsoleLogger extends AbstractLogger
$t['line'] = 0; $t['line'] = 0;
} }
$log .= "#{$i} {$t['file']}({$t['line']}): "; $log .= "#{$i} {$t['file']}({$t['line']}): ";
/* @phpstan-ignore-next-line */
if (isset($t['object']) && is_object($t['object'])) { if (isset($t['object']) && is_object($t['object'])) {
$log .= get_class($t['object']) . '->'; $log .= get_class($t['object']) . '->';
} }
@ -203,30 +212,30 @@ class ConsoleLogger extends AbstractLogger
return ConsoleColor::apply($styles, $string)->__toString(); return ConsoleColor::apply($styles, $string)->__toString();
} }
/**
* {@inheritDoc}
*/
public function log($level, $message, array $context = []): void public function log($level, $message, array $context = []): void
{ {
$level = $this->castLogLevel($level); $level = $this->castLogLevel($level);
if (!$this->shouldLog($level)) { $log_replace = [
return; '%date%' => date(self::$date_format),
} '%level%' => strtoupper(substr(self::$levels[$level], 0, 4)),
'%body%' => $message,
'%level_short%' => strtoupper(substr(self::$levels[$level], 0, 1)),
];
$output = str_replace( $output = str_replace(array_keys($log_replace), array_values($log_replace), self::$format);
['%date%', '%level%', '%body%'],
[date(self::$date_format), strtoupper(substr(self::$levels[$level], 0, 4)), $message],
self::$format
);
$output = $this->interpolate($output, array_merge($this->static_context, $context)); $output = $this->interpolate($output, array_merge($this->static_context, $context));
foreach ($this->log_callbacks as $callback) { foreach ($this->log_callbacks as $callback) {
if ($callback($level, $output, $message, $context) === false) { if ($callback($level, $output, $message, $context, $this->shouldLog($level)) === false) {
return; return;
} }
} }
if (!$this->shouldLog($level)) {
return;
}
if ($this->decorated) { if ($this->decorated) {
$output = $this->colorize($output, $level) . PHP_EOL; $output = $this->colorize($output, $level) . PHP_EOL;
} else { } else {
@ -237,21 +246,30 @@ class ConsoleLogger extends AbstractLogger
fwrite($this->stream, $output); fwrite($this->stream, $output);
fflush($this->stream); fflush($this->stream);
} else { } else {
// use plain text output if ($level <= 4 && $this->use_stderr) {
echo $output; fwrite(STDERR, $output);
} else {
// use plain text output
echo $output;
}
} }
} }
public function setDecorated(bool $decorated): void
{
$this->decorated = $decorated;
}
/** /**
* 转换日志等级 * 转换日志等级
*/ */
private function castLogLevel(string $level): int protected function castLogLevel(string $level): int
{ {
if (in_array($level, self::$levels, true)) { if (in_array($level, self::$levels, true)) {
return array_flip(self::$levels)[$level]; return array_flip(self::$levels)[$level];
} }
throw new InvalidArgumentException('无效的日志等级'); throw new InvalidArgumentException('Invalid log level: ' . $level);
} }
/** /**
@ -259,7 +277,7 @@ class ConsoleLogger extends AbstractLogger
* *
* @param mixed $item 日志内容 * @param mixed $item 日志内容
*/ */
private function stringify($item): string protected function stringify($item): string
{ {
switch (true) { switch (true) {
case is_callable($item): case is_callable($item):
@ -293,7 +311,7 @@ class ConsoleLogger extends AbstractLogger
/** /**
* 判断是否应该记录该等级日志 * 判断是否应该记录该等级日志
*/ */
private function shouldLog(int $level): bool protected function shouldLog(int $level): bool
{ {
return $level <= self::$log_level; return $level <= self::$log_level;
} }
@ -304,7 +322,7 @@ class ConsoleLogger extends AbstractLogger
* @param string $message 日志内容 * @param string $message 日志内容
* @param array $context 变量列表 * @param array $context 变量列表
*/ */
private function interpolate(string $message, array $context = []): string protected function interpolate(string $message, array $context = []): string
{ {
$replace = []; $replace = [];
foreach ($context as $key => $value) { foreach ($context as $key => $value) {

View File

@ -137,8 +137,8 @@ class TablePrinter
$line_data[$current_line] = [ $line_data[$current_line] = [
'used' => $valid_width - $k_len - 2 - $partial_v_len, 'used' => $valid_width - $k_len - 2 - $partial_v_len,
'can_put_second' => false, 'can_put_second' => false,
'lines' => $k . ': ' . 'lines' => $k . ': '
ConsoleColor::apply([$this->value_color], $partial_v . str_pad('', $valid_width - $k_len - 2 - $partial_v_len, '.')), . ConsoleColor::apply([$this->value_color], $partial_v . str_pad('', $valid_width - $k_len - 2 - $partial_v_len, '.')),
]; ];
++$current_line; ++$current_line;
// 下一个参数 // 下一个参数