Skip to content

Add initial PHPStan configuration #201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
swissspidy merged 14 commits into from
Apr 8, 2026
Merged

Add initial PHPStan configuration #201

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
49635f4
Add initial PHPStan configuration
swissspidy Mar 31, 2026
8ae5b11
Level 2
swissspidy Apr 1, 2026
4b91c1f
Level 3
swissspidy Apr 1, 2026
97bd54b
Level 4
swissspidy Apr 1, 2026
7327bea
Level 5
swissspidy Apr 2, 2026
4fd98bf
Level 6
swissspidy Apr 2, 2026
2668466
Level 7
swissspidy Apr 7, 2026
ca8ddaa
Level 8
swissspidy Apr 7, 2026
74c6f83
Level 9
swissspidy Apr 7, 2026
bab9c04
float
swissspidy Apr 8, 2026
1c5d5e5
Address code review feedback for table headers
swissspidy Apr 8, 2026
0360379
Address HelpScreen feedback
swissspidy Apr 8, 2026
0bfc6c5
Update docblock
swissspidy Apr 8, 2026
709d6ba
fix
swissspidy Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 80 additions & 16 deletions lib/cli/Arguments.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,23 @@

/**
* Parses command line arguments.
*
* @implements \ArrayAccess<string, mixed>
*/
class Arguments implements \ArrayAccess {
/** @var array<string, array<string, mixed>> */
protected $_flags = array();
/** @var array<string, array<string, mixed>> */
protected $_options = array();
/** @var bool */
protected $_strict = false;
/** @var array<int, string> */
protected $_input = array();
/** @var array<int, string> */
protected $_invalid = array();
/** @var array<string, mixed>|null */
protected $_parsed;
/** @var Lexer|null */
protected $_lexer;

/**
Expand All @@ -36,7 +45,7 @@ class Arguments implements \ArrayAccess {
*
* `'help'` is `true` by default, `'strict'` is false by default.
*
* @param array $options An array of options for this parser.
* @param array<string, mixed> $options An array of options for this parser.
*/
public function __construct($options = array()) {
$options += array(
Expand All @@ -58,7 +67,7 @@ public function __construct($options = array()) {
/**
* Get the list of arguments found by the defined definitions.
*
* @return array
* @return array<string, mixed>
*/
public function getArguments() {
if (!isset($this->_parsed)) {
Expand All @@ -67,6 +76,11 @@ public function getArguments() {
return $this->_parsed;
}

/**
* Get the help screen.
*
* @return HelpScreen
*/
public function getHelpScreen() {
return new HelpScreen($this);
}
Expand Down Expand Up @@ -110,6 +124,8 @@ public function offsetGet($offset) {
if (isset($this->_parsed[$offset])) {
return $this->_parsed[$offset];
}

return null;
}

/**
Expand Down Expand Up @@ -145,7 +161,7 @@ public function offsetUnset($offset) {
* Adds a flag (boolean argument) to the argument list.
*
* @param mixed $flag A string representing the flag, or an array of strings.
* @param array $settings An array of settings for this flag.
* @param array<string, mixed>|string $settings An array of settings for this flag.
* @setting string description A description to be shown in --help.
* @setting bool default The default value for this flag.
* @setting bool stackable Whether the flag is repeatable to increase the value.
Expand Down Expand Up @@ -181,7 +197,7 @@ public function addFlag($flag, $settings = array()) {
* primary flag character, and the values should be the settings array
* used by {addFlag}.
*
* @param array $flags An array of flags to add
* @param array<string, array<string, mixed>|string> $flags An array of flags to add
* @return $this
*/
public function addFlags($flags) {
Expand All @@ -201,7 +217,7 @@ public function addFlags($flags) {
* Adds an option (string argument) to the argument list.
*
* @param mixed $option A string representing the option, or an array of strings.
* @param array $settings An array of settings for this option.
* @param array<string, mixed>|string $settings An array of settings for this option.
* @setting string description A description to be shown in --help.
* @setting bool default The default value for this option.
* @setting array aliases Other ways to trigger this option.
Expand Down Expand Up @@ -235,7 +251,7 @@ public function addOption($option, $settings = array()) {
* primary option string, and the values should be the settings array
* used by {addOption}.
*
* @param array $options An array of options to add
* @param array<string, array<string, mixed>|string> $options An array of options to add
* @return $this
*/
public function addOptions($options) {
Expand Down Expand Up @@ -269,7 +285,7 @@ public function setStrict($strict) {
/**
* Get the list of invalid arguments the parser found.
*
* @return array
* @return array<int, string>
*/
public function getInvalidArguments() {
return $this->_invalid;
Expand All @@ -280,12 +296,12 @@ public function getInvalidArguments() {
*
* @param mixed $flag Either a string representing the flag or an
* cli\arguments\Argument object.
* @return array
* @return array<string, mixed>|null
*/
public function getFlag($flag) {
if ($flag instanceOf Argument) {
$obj = $flag;
$flag = $flag->value;
$flag = $flag->value();
}

if (isset($this->_flags[$flag])) {
Expand All @@ -302,12 +318,24 @@ public function getFlag($flag) {
return $settings;
}
}

return null;
}

/**
* Get all flags.
*
* @return array<string, array<string, mixed>>
*/
public function getFlags() {
return $this->_flags;
}

/**
* Check if there are any flags defined.
*
* @return bool
*/
public function hasFlags() {
return !empty($this->_flags);
}
Expand Down Expand Up @@ -341,12 +369,12 @@ public function isStackable($flag) {
*
* @param mixed $option Either a string representing the option or an
* cli\arguments\Argument object.
* @return array
* @return array<string, mixed>|null
*/
public function getOption($option) {
if ($option instanceOf Argument) {
$obj = $option;
$option = $option->value;
$option = $option->value();
}

if (isset($this->_options[$option])) {
Expand All @@ -362,12 +390,24 @@ public function getOption($option) {
return $settings;
}
}

return null;
}

/**
* Get all options.
*
* @return array<string, array<string, mixed>>
*/
public function getOptions() {
return $this->_options;
}

/**
* Check if there are any options defined.
*
* @return bool
*/
public function hasOptions() {
return !empty($this->_options);
}
Expand All @@ -388,7 +428,7 @@ public function isOption($argument) {
* will use either the first long name given or the first name in the list
* if a long name is not given.
*
* @return array
* @return void
* @throws arguments\InvalidArguments
*/
public function parse() {
Expand All @@ -406,7 +446,7 @@ public function parse() {
continue;
}

array_push($this->_invalid, $argument->raw);
array_push($this->_invalid, $argument->raw());
}

if ($this->_strict && !empty($this->_invalid)) {
Expand All @@ -418,6 +458,8 @@ public function parse() {
* This applies the default values, if any, of all of the
* flags and options, so that if there is a default value
* it will be available.
*
* @return void
*/
private function _applyDefaults() {
foreach($this->_flags as $flag => $settings) {
Expand All @@ -432,10 +474,22 @@ private function _applyDefaults() {
}
}

/**
* Warn about something.
*
* @param string $message
* @return void
*/
private function _warn($message) {
trigger_error('[' . __CLASS__ .'] ' . $message, E_USER_WARNING);
}

/**
* Parse a flag.
*
* @param Argument $argument
* @return bool
*/
private function _parseFlag($argument) {
if (!$this->isFlag($argument)) {
return false;
Expand All @@ -454,6 +508,12 @@ private function _parseFlag($argument) {
return true;
}

/**
* Parse an option.
*
* @param Argument $option
* @return bool
*/
private function _parseOption($option) {
if (!$this->isOption($option)) {
return false;
Expand All @@ -477,13 +537,17 @@ private function _parseOption($option) {
// Store as array and join to string after looping for values
$values = array();

$this->_lexer->next();

// Loop until we find a flag in peak-ahead
foreach ($this->_lexer as $value) {
array_push($values, $value->raw);
while ( $this->_lexer->valid() ) {
$value = $this->_lexer->current();
array_push( $values, $value->raw );

if (!$this->_lexer->end() && !$this->_lexer->peek->isValue) {
if ( ! $this->_lexer->end() && ! $this->_lexer->peek->isValue ) {
break;
}
$this->_lexer->next();
}

$this[$option->key] = join(' ', $values);
Expand Down
31 changes: 26 additions & 5 deletions lib/cli/Colors.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
* Reference: http://graphcomp.com/info/specs/ansi_col.html#colors
*/
class Colors {
/** @var array<string, array<string, int>> */
static protected $_colors = array(
'color' => array(
'black' => 30,
Expand Down Expand Up @@ -48,14 +49,28 @@ class Colors {
'white' => 47
)
);
/** @var bool|null */
static protected $_enabled = null;

/** @var array<string, array<string, string>> */
static protected $_string_cache = array();

/**
* Enable colorized output.
*
* @param bool $force Force enable.
* @return void
*/
static public function enable($force = true) {
self::$_enabled = $force === true ? true : null;
}

/**
* Disable colorized output.
*
* @param bool $force Force disable.
* @return void
*/
static public function disable($force = true) {
self::$_enabled = $force === true ? false : null;
}
Expand All @@ -64,6 +79,9 @@ static public function disable($force = true) {
* Check if we should colorize output based on local flags and shell type.
*
* Only check the shell type if `Colors::$_enabled` is null and `$colored` is null.
*
* @param bool|null $colored Force enable or disable the colorized output.
* @return bool
*/
static public function shouldColorize($colored = null) {
return self::$_enabled === true ||
Expand All @@ -75,8 +93,8 @@ static public function shouldColorize($colored = null) {
/**
* Set the color.
*
* @param string $color The name of the color or style to set.
* @return string
* @param string|array<string, string|int> $color The name of the color or style to set, or an array of options.
* @return string
*/
static public function color($color) {
if (!is_array($color)) {
Expand Down Expand Up @@ -171,6 +189,7 @@ static public function decolorize( $string, $keep = 0 ) {
* @param string $passed The original string before colorization.
* @param string $colorized The string after running through self::colorize.
* @param string $deprecated Optional. Not used. Default null.
* @return void
*/
static public function cacheString( $passed, $colorized, $deprecated = null ) {
self::$_string_cache[md5($passed)] = array(
Expand Down Expand Up @@ -225,7 +244,7 @@ static public function pad( $string, $length, $pre_colorized = false, $encoding
/**
* Get the color mapping array.
*
* @return array Array of color tokens mapped to colors and styles.
* @return array<string, array<string, string|int>> Array of color tokens mapped to colors and styles.
*/
static public function getColors() {
return array(
Expand Down Expand Up @@ -268,14 +287,16 @@ static public function getColors() {
/**
* Get the cached string values.
*
* @return array The cached string values.
* @return array<string, array<string, string>> The cached string values.
*/
static public function getStringCache() {
return self::$_string_cache;
}

/**
* Clear the string cache.
*
* @return void
*/
static public function clearStringCache() {
self::$_string_cache = array();
Expand Down Expand Up @@ -305,7 +326,7 @@ static public function getResetCode() {
* @param string $string The string to wrap (with ANSI codes).
* @param int $width The maximum display width per line.
* @param string|bool $encoding Optional. The encoding of the string. Default false.
* @return array Array of wrapped string segments.
* @return array<int, string> Array of wrapped string segments.
*/
static public function wrapPreColorized( $string, $width, $encoding = false ) {
$wrapped = array();
Expand Down
Loading