Indentation in hash parameters

[lukepass]

Expected behavior

I wish that hash arguments were indented when on multiple lines. For example:

From:

{{ form_start(form, {
                    attr: {
                    class: 'quiz',
                    'data-controller': 'ajax-form quiz',
                    'data-ajax-form-targets-value': ['#ajax-content-1', '#ajax-content-2', '#lesson-footer']|serialize('json') ,
    'data-ajax-form-spinner-html-value': include('shared/_spinner.html.twig'),
    'data-ajax-form-scroll-to-value': '#ajax-content-1',
}
}) }}

To:

{{ form_start(form, {
    attr: {
        class: 'quiz',
        'data-controller': 'ajax-form quiz',
        'data-ajax-form-targets-value': ['#ajax-content-1', '#ajax-content-2', '#lesson-footer']|serialize('json') ,
        'data-ajax-form-spinner-html-value': include('shared/_spinner.html.twig'),
        'data-ajax-form-scroll-to-value': '#ajax-content-1',
    }
}) }}

Actual behavior

Hash indentation is not changed.

[VincentLanglet]

Hi, do you want to try working on a rule ?

[lukepass]

Yes, of course! I would like to! How can I do that?

[VincentLanglet]

You can play with https://github.com/VincentLanglet/Twig-CS-Fixer/blob/main/tests/Token/Tokenizer/TokenizerTest.php
to understand how the code is Tokenized.

For example
{{ {'foo': 42} }}
is tokenized with tokens of the type

• Token::VAR_START_TYPE
• Token::WHITESPACE_TYPE
• Token::PUNCTUATION_TYPE {
• Token::STRING_TYPE (Be aware that without the quote it's a Token::NAME_TYPE)
• Token::PUNCTUATION_TYPE :
• Token::WHITESPACE_TYPE
• Token::NUMBER_TYPE
• Token::PUNCTUATION_TYPE }
• Token::WHITESPACE_TYPE
• Token::VAR_END_TYPE

Notice that in case of the token } you'll have $token->getRelatedToken() returning the one which is opening {. (This is currently used only for ternary $a ? $b : $c here

Twig-CS-Fixer/src/Rules/Operator/OperatorSpacingRule.php

Lines 35 to 37 in 1f1bcc5

	$relatedToken = $token->getRelatedToken();
	return null !== $relatedToken && '?' === $relatedToken->getValue() ? 1 : 0;

).

You rule will need to be configurable to know what should be used for indent (tab or space ? And how many space ?) an example can be found here https://github.com/VincentLanglet/Twig-CS-Fixer/blob/main/src/Rules/Whitespace/IndentRule.php#L14

Here you have an example of rule which works on ), } and ]

Twig-CS-Fixer/src/Rules/Punctuation/TrailingCommaMultiLineRule.php

Line 31 in 1f1bcc5

if (!$this->isTokenMatching($token, Token::PUNCTUATION_TYPE, [')', '}', ']'])) {

; I assume you'll have to

• Create a rule on }
• get the related token {
• Compute the indentation of the {
• Get every line with a hash
• Compare reindent the lines.

But the issue you'll encounter will be

• Case like {} inside another {} since the indentation will be different
• And worst, hash with multilines like

{{ form_start(form, {
foo: 42
    + 42
}
}) }}

because people might expect it to be fixed to

{{ form_start(form, {
    foo: 42
         + 42
}
}) }}

My fear is the fact that putting one step in the indentation rule will end with having to indenting everything ({, (, operator, ...) which seems kinda complicated (PHP-Cs-Fixer rule is not even perfect ATM).

[ruudk]

@lukepass Just wanted to say that I'm also very much interested in having this properly formatted. So thanks in advance for your work on this 🙌 💪

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.