bin/console config:dump-reference dumps invalid yaml

[tacman]

Symfony version(s) affected

7.0.4

Description

The following yaml, created from config:dump-reference, is invalid, because it has ~ and a list

        # Specifies the default link handling for the web app.
        handle_links:         ~

            # Examples:
            - auto
            - preferred
            - not-preferred

How to reproduce

symfony new container-bug --webapp && cd container-bug
composer install
composer require spomky-labs/pwa-bundle
bin/console config:dump-reference  pwa > pwa.yaml
bin/console lint:yaml pwa.yaml

No security vulnerability advisories found
Using version ^1.0 for spomky-labs/phpwa
  ERROR  in pwa.yaml
  >> Unable to parse at line 8 (near "    - 1").

[WARNING] 0 YAML files have valid syntax and 1 contain errors.

Possible Solution

No response

Additional Context

No response

[MatTheCat]

Similar to what #39336 fixed, but I don’t understand why array examples never are displayed as comments. Do you remember @Nyholm?

[tacman]

in YamlReferenceDumper.php, $message is Examples, and is prefixed by # to comment it out.

But the array is dumped normally, but its lines, too, should be commented out.

            $this->writeLine('# '.$message.':', $depth * 4 + 4);
            $this->writeArray(array_map(Inline::dump(...), $example), $depth + 1);

The test behavior shows this, but it doesn't make much sense, it should be

    variable:

        # Examples:
        # - foo
        # - bar

I'm not sure how to write writeArray to prefix everything with a #, any suggestions?

[MatTheCat]

You could add an optional boolean $asComment argument to WriteArray? If true, then prefix each line with #.

That being said I would have done the same instead of #39336 so maybe we’re missing something 🤔

[tacman]

Thanks, I've submitted a PR: #54326