Tokenizer::$eolChar: change default value

[jrfnl]

Description

Tokenizer::$eolChar: change default value to be a more logical one. The property is supposed to be a string, so having an array as a default value is confusing.

Suggested changelog entry

N/A

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
  • This change is only breaking for integrators, not for external standards or end-users.
• Documentation improvement

[fredden]

Should the default value be non-empty? What are your thoughts on using PHP_EOL here instead of an empty string. Or perhaps null or unset.

[jrfnl]

I did consider those options, but those were all rejected out of hand.

• The property is documented as a string, so the default should also be a string.
• Setting the default to null may lead to PHP 8.1 "passing null to non-nullable" deprecations in unexpected places.
• Setting the default to PHP_EOL is plain wrong as that depends on the OS on which PHPCS is run, while the property is about the EOL character of the file under scan.

Setting it to an empty string prevents any problems with a wrong value being used and still complies with the documented property type.

[jrfnl]

In any case, the property is the first thing which will be set once the class is instantiated via the contructor, so the default value isn't even that interesting, though it should definitely not be one of an incorrect type.

[fredden]

Thanks for the explanation. This all makes sense. 👍

[DannyvdSluijs]

Given my "approval" based on the description of the PR and the discussion about a default EOL character which all made sense.

[jrfnl]

Closing as replaced by PHPCSStandards/PHP_CodeSniffer#81