[BUG] Impossible to disable cast_spaces rule

[vkarchevskyi]

Pint Version

1.24.0

PHP Version

8.4

Description

Configuration property cast_spaces doesn't affect on lint results.

Steps To Reproduce

1. Create new Laravel project
2. Insert the following configuration in pint.json file

{
    "preset": "per",
    "rules": {
        "array_push": true,
        "backtick_to_shell_exec": true,
        "cast_spaces": true,
        "date_time_immutable": true,
        "declare_strict_types": true,
        "lowercase_keywords": true,
        "lowercase_static_reference": true,
        "fully_qualified_strict_types": true,
        "global_namespace_import": {
            "import_classes": true,
            "import_constants": true,
            "import_functions": true
        },
        "mb_str_functions": true,
        "modernize_types_casting": true,
        "new_with_parentheses": true,
        "no_superfluous_elseif": true,
        "no_useless_else": true,
        "no_multiple_statements_per_line": true,
        "ordered_interfaces": true,
        "ordered_traits": true,
        "strict_comparison": true,
        "visibility_required": true
    }
}

3. Write a statement with cast and run pint.

$body = (string)$response->getBody();

4. Check that it was fixed.
5. Change cast_spaces to false.
6. Run pint again and see, that nothing was changed, but it should according to none configuration property of PHP-CS-Fixer.

https://cs.symfony.com/doc/rules/cast_notation/cast_spaces.html

[github-actions]

Thank you for reporting this issue!

As Laravel is an open source project, we rely on the community to help us diagnose and fix issues as it is not possible to research and fix every issue reported to us via GitHub.

If possible, please make a pull request fixing the issue you have described, along with corresponding tests. All pull requests are promptly reviewed by the Laravel team.

Thank you!

[artengin]

Hi! 👋

I’ve investigated this issue and submitted a fix.
The problem was that cast_spaces: false wasn’t being normalized into the explicit configuration expected by PHP-CS-Fixer (['space' => 'none']). Because of that, disabling the rule had no effect.

Now the shorthand form is properly resolved, and setting "cast_spaces": false in pint.json will correctly translate into the none option of PHP-CS-Fixer.

I hope my contribution will be useful, thank you! 🙏

[patrickcarlohickman]

@vkarchevskyi , @artengin ,

This is a misunderstanding of how to define the rules in the rules array.

Setting a rule value to true enables a rule. For a rule with configuration options, this enables the rule with the default configuration options (e.g ['space' => 'single'] for the cast_spaces rule).

Setting a rule value to false is the way to disable a rule. This is not the same as enabling a rule with an "opposite" configuration. Disabling a rule will ensure the rule is not applied at all.

When you've set "cast_spaces: false" in your rules, you have then disabled the rule so it isn't applied at all. It sounds like you're not trying to disable the rule, but you are trying to enable it with a different configuration. In that case, you need to define the configuration in your rules, as you would with any other rule you want to use with a change to the default configuration.

Your cast_spaces rule should look like:

    "cast_spaces": {
        "space": "none"
    },