rabe/helpers-functions-cli
11
0
Fork 0
mirror of https://github.com/n3w/helpers-functions-cli.git synced 2025-12-19 12:43:22 +00:00
Code Issues Projects Releases Wiki Activity

Using readable_debug_backtrace (provided by pointybeard/helpers-functions-debug) to produce a trace if one is provided

Browse source
This commit is contained in:
Alannah Kearney 2019-05-26 20:19:25 +10:00
commit 558ea1ba2c
1 changed files with 22 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

58
src/Cli/Cli.php
View file

@ -9,6 +9,7 @@ use pointybeard\Helpers\Cli\Colour;
use pointybeard\Helpers\Functions\Flags; use pointybeard\Helpers\Functions\Flags;
use pointybeard\Helpers\Functions\Strings; use pointybeard\Helpers\Functions\Strings;
use pointybeard\Helpers\Functions\Arrays; use pointybeard\Helpers\Functions\Arrays;
use pointybeard\Helpers\Functions\Debug;
/* /*
* Checks if bash can be invoked. * Checks if bash can be invoked.
@ -139,7 +140,7 @@ if (!function_exists(__NAMESPACE__.'manpage')) {
} }
if (!function_exists(__NAMESPACE__."\display_error_and_exit")) { if (!function_exists(__NAMESPACE__."\display_error_and_exit")) {
function display_error_and_exit($message, $heading = 'Error', $background = Colour\Colour::BG_RED): void function display_error_and_exit($message, $heading = 'Error', $background = Colour\Colour::BG_RED, ?array $trace = null): void
{ {
$padCharacter = ' '; $padCharacter = ' ';
$paddingBufferSize = 0.15; // 15% $paddingBufferSize = 0.15; // 15%
@ -147,17 +148,7 @@ if (!function_exists(__NAMESPACE__."\display_error_and_exit")) {
$edgePaddingLength = 5; $edgePaddingLength = 5;
$edgePadding = str_repeat($padCharacter, $edgePaddingLength); $edgePadding = str_repeat($padCharacter, $edgePaddingLength);
// Get the window dimensions but restrict width to minimum // Convenience function for adding the background to a line.
// of $minimumWindowWidth
$window = get_window_size();
$window['cols'] = max($minimumWindowWidth, $window['cols']);
// This shrinks the total line length (derived by the window width) by
// $paddingBufferSize
$paddingBuffer = (int) ceil($window['cols'] * $paddingBufferSize);
$lineLength = $window['cols'] - (2 * $edgePaddingLength) - $paddingBuffer;
$add_background = function (string $string, bool $bold = false) use ($padCharacter, $edgePadding, $background): string { $add_background = function (string $string, bool $bold = false) use ($padCharacter, $edgePadding, $background): string {
$string = $edgePadding.$string.$edgePadding; $string = $edgePadding.$string.$edgePadding;
@ -172,6 +163,17 @@ if (!function_exists(__NAMESPACE__."\display_error_and_exit")) {
); );
}; };
// Get the window dimensions but restrict width to minimum
// of $minimumWindowWidth
$window = get_window_size();
$window['cols'] = max($minimumWindowWidth, $window['cols']);
// This shrinks the total line length (derived by the window width) by
// $paddingBufferSize
$paddingBuffer = (int) ceil($window['cols'] * $paddingBufferSize);
$lineLength = $window['cols'] - (2 * $edgePaddingLength) - $paddingBuffer;
$emptyLine = $add_background(str_repeat($padCharacter, $lineLength), true); $emptyLine = $add_background(str_repeat($padCharacter, $lineLength), true);
$heading = Strings\mb_str_pad(trim($heading), $lineLength, $padCharacter, \STR_PAD_RIGHT); $heading = Strings\mb_str_pad(trim($heading), $lineLength, $padCharacter, \STR_PAD_RIGHT);
@ -186,20 +188,8 @@ if (!function_exists(__NAMESPACE__."\display_error_and_exit")) {
// Reset array indicies // Reset array indicies
$message = array_values($message); $message = array_values($message);
// Check for a backtrace and get it's index if there is one. Trace // Wrap everything in red
// will most likely have been provided by the
// Helpers\Exceptions\ReadableTrace\ReadableTraceException
$traceArrayIndex = array_search('Trace', $message);
if (false !== $traceArrayIndex) {
// Purely cosmetic; add a new line before the trace starts
$message[$traceArrayIndex] = PHP_EOL.$message[$traceArrayIndex];
}
// Wrap everything (except the trace) in red
for ($ii = 0; $ii < count($message); ++$ii) { for ($ii = 0; $ii < count($message); ++$ii) {
if (false !== $traceArrayIndex && $ii == $traceArrayIndex) {
break;
}
$message[$ii] = $add_background(Strings\mb_str_pad( $message[$ii] = $add_background(Strings\mb_str_pad(
$message[$ii], $message[$ii],
mb_strlen($heading), mb_strlen($heading),
@ -208,22 +198,18 @@ if (!function_exists(__NAMESPACE__."\display_error_and_exit")) {
)); ));
} }
// Add an empty red line before the trace (or at the end if there // Add an empty red line at the end
// is no trace) array_push($message, $emptyLine);
Arrays\array_insert_at_index(
$message,
false !== $traceArrayIndex
? $traceArrayIndex
: count($message),
$emptyLine
);
// Print the error message, starting with an empty red line // Print the error message, starting with an empty red line
printf( printf(
"\r\n%s\r\n%s\r\n%s\r\n", "\r\n%s\r\n%s\r\n%s\r\n%s",
$emptyLine, $emptyLine,
$add_background($heading, true), $add_background($heading, true),
implode($message, PHP_EOL) implode($message, PHP_EOL),
!empty($trace) && count($trace) > 0
? PHP_EOL . sprintf("Trace\r\n==========\r\n%s\r\n", Debug\readable_debug_backtrace($trace))
: ''
); );
exit(1); exit(1);