Add nowdoc format for auto-generated migrations

[ghost]

Feature Request

Add heredoc format for auto-generated migrations

Q	A
New Feature	yes
RFC	no
BC Break	no

Summary

e.g. https://github.com/doctrine/migrations/blob/3.7.x/lib/Doctrine/Migrations/Tools/Console/Command/DiffCommand.php

            ->addOption(
                'nowdoc',
                null,
                InputOption::VALUE_NONE,
                'Use nowdoc format for SQL statements.',
            )

Without the new option

    public function up(Schema $schema): void
    {
        // this up() migration is auto-generated, please modify it to your needs
        $this->addSql('CREATE TABLE...');
    }

With the new option

    public function up(Schema $schema): void
    {
        // this up() migration is auto-generated, please modify it to your needs
        $this->addSql(<<<'SQL'
                CREATE TABLE...
        SQL);
    }

[greg0ire]

Two things:

• Why not nowdoc instead? It's more consistent with '
• Can you elaborate on the benefits you expect to see? I know that for instance, if we use 'SQL' as the marker, there will be better syntactic coloration with some editors, is there something else I'm missing?

[ghost]

@greg0ire Yes, nowdoc too, why not 😉

Benefits

• More readable SQL statements
• More readable SQL git diffs
• Syntactic coloration
• Easier copy-paste for local testing

[greg0ire]

More readable SQL statements

How exactly would they become more readable?

More readable SQL git diffs

This is not obvious to me either

Easier copy-paste for local testing

Because you can copy entire lines, or for another reason?

[ghost]

The --formatted option already does part of the job, but quote escaping makes it more difficult to read/compare.

Yes, using nowdoc or heredoc, you can copy-paste and test SQL queries without any modification (such as unescaping).

[greg0ire]

TIL about --formatted… I guess it could indeed be nicer with NOWDOC. Now I'm not sure we should support too many scenarios. Maybe we should just switch to NOWDOC and not expose any other option. I'm curious what other maintainers think.

[ghost]

@greg0ire you’re right. Nowdoc is a better choice in this case 👍

[greg0ire]

@derrabus @SenseException what do you think about this change? @michael-barchy-bf would you be willing to implement it?

[greg0ire]

Would you mind opening a pull request? Since it's a new feature, please target 3.8.x

[ghost]

Sorry, i'm not familiar with github, someone else should do it

[michael-barchy-bf]

This issue might be a duplicate of this one : https://github.com/doctrine/migrations/issues/939

[greg0ire]

Duplicate of #939