Comment Indentation #1349

earthiverse · 2025-12-23T00:23:30Z

earthiverse
Dec 23, 2025

I wish to align comments to the indentation level.

With my current ruleset, these comments stay in place:

    public function getInputSpecification(): array
    {
// 1
    // 2
        // 3
            // 4
        return [
// 1
    // 2
        // 3
            // 4
                // 5
                    // 6
            'name' => 'name',
            'required' => true, // If not provided, we add one in setData()
            'filters' => [
                ['name' => StringTrim::class],
                ['name' => ToNull::class],
                ['name' => PathToFilenameFilter::class],
                ['name' => SlugifyFilter::class],
                [
                    'name' => FilterCallback::class,
                    'options' => [
                        'callback' => static fn($value) => empty($value)
                            ? FilesystemUtility::generateFilename() : $value,
                    ],
                ],
            ],
        ];
// 1
    // 2
        // 3
            // 4
    }

By adding

   <!-- PSR12 ignores comment indent, but we prefer not to -->
   <rule ref="Generic.WhiteSpace.ScopeIndent">
       <properties>
           <!-- NOTE: This array is intentionally left empty -->
           <property name="ignoreIndentationTokens" type="array"/>
       </properties>
   </rule>

It formats as

   public function getInputSpecification(): array
   {
       // 1
       // 2
       // 3
           // 4
       return [
       // 1
       // 2
       // 3
           // 4
               // 5
                   // 6
           'name' => 'name',
           'required' => true, // If not provided, we add one in setData()
           'filters' => [
               ['name' => StringTrim::class],
               ['name' => ToNull::class],
               ['name' => PathToFilenameFilter::class],
               ['name' => SlugifyFilter::class],
               [
                   'name' => FilterCallback::class,
                   'options' => [
                       'callback' => static fn($value) => empty($value)
                           ? FilesystemUtility::generateFilename() : $value,
                   ],
               ],
           ],
       ];
       // 1
       // 2
       // 3
           // 4
   }

This is an improvement, but the comments in the array, as well as indented comments later stay indented.
Does anyone know how I can fix these?

earthiverse · 2025-12-23T00:29:35Z

earthiverse
Dec 23, 2025
Author

Adding exact is a bit closer, but it caused other problem and is apparently not recommended

<!-- PSR12 ignores comment indent, but we prefer not to -->
<rule ref="Generic.WhiteSpace.ScopeIndent">
    <properties>
        <property name="exact" value="true"/>
        <!-- NOTE: This array is intentionally left empty -->
        <property name="ignoreIndentationTokens" type="array"/>
    </properties>
</rule>

    public function getInputSpecification(): array
    {
        // 1
        // 2
        // 3
        // 4
        return [
        // 1
        // 2
        // 3
            // 4
                // 5
                    // 6
            'name' => 'name',
            'required' => true, // If not provided, we add one in setData()
            'filters' => [
                ['name' => StringTrim::class],
                ['name' => ToNull::class],
                ['name' => PathToFilenameFilter::class],
                ['name' => SlugifyFilter::class],
                [
                    'name' => FilterCallback::class,
                    'options' => [
                        'callback' => static fn($value) => empty($value)
                            ? FilesystemUtility::generateFilename() : $value,
                    ],
                ],
            ],
        ];
        // 1
        // 2
        // 3
        // 4
    }

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Comment Indentation #1349

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 1 comment

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Select a reply

Uh oh!

Uh oh!

Comment Indentation #1349

Uh oh!

Uh oh!

earthiverse Dec 23, 2025

Replies: 1 comment

Uh oh!

Uh oh!

earthiverse Dec 23, 2025 Author

earthiverse
Dec 23, 2025

earthiverse
Dec 23, 2025
Author