app:config:dump adds extra space every time in multiline array value

[gulshan-streammarket]

Preconditions

1. php 7.0.19
2. Magento 2.2

Steps to reproduce

1. RUN > php bin/magento app:config:dump
2. Search for 'address_templates' key in config.php and count number of spacees in every line of formatted multiline text value.
3. Now run again>php bin/magento app:config:dump
4. Again check for number of spaces. You will find two more space.
5. Every time when we dump of execute setup:upgrade it adds extra space to multiline config value.

Expected result

1. There should be no extra space if there is no change in the configuration.

Actual result

1. It adds extra space and it shows as modified in git local working copy. So every time it needs commit when sending feature to repository.
   

[magento-engcom-team]

@gulshan-streammarket, thank you for your report.
We've created internal ticket(s) MAGETWO-81401 to track progress on the issue.

[gulshan-streammarket]

Thank You. I will be waiting for fix.

[dmanners]

For more detail on the problem the issue is with config elements that contain \n in them. For example the address templates or the search_engine_robots->default_custom_instructions section.

The problem happens in the class lib/internal/Magento/Framework/App/DeploymentConfig/Writer/PhpFormatter.php https://github.com/magento/magento2/blob/2.2-develop/lib/internal/Magento/Framework/App/DeploymentConfig/Writer/PhpFormatter.php#L37 when formatting the output it replaces \n characters with \n

return "<?php\nreturn array (\n" . implode(",\n", str_replace("\n", "\n ", $elements)) . "\n);\n"; I think that a good solution here would be to change the way that this file is created

[adrian-martinez-interactiv4]

@gulshan-streammarket @dmanners Hope this PR fixes this issue