(PDK-1308) Ensure PDK-written non-templated files have trailing newline #640
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
scotje
commented
Mar 19, 2019
|
Will resolve #636 |
rodjek
suggested changes
Mar 20, 2019
There are some files that PDK writes that are not derived from templates in the pdk-templates repo. The most notable example of this is the metadata.json file which is constructed as a Ruby hash and then serialized to JSON and written to a file. When PDK writes these files it was not including a trailing newline and files having trailing newlines is a best practice. This change updates the PDK::Util::Filesystem.write_file method to ensure that it always writes files with a trailing newline. Some of the unit tests around writing templated files also needed to be updated because of the way the tests were implemented did not simulate template files that already contained trailing newlines.
scotje
force-pushed
the
1308_trailing_newlines
branch
from
f4479f0 to
b514ae9
Compare
|
@rodjek updated |
rodjek
approved these changes
Mar 21, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There are some files that PDK writes that are not derived from templates
in the pdk-templates repo. The most notable example of this is the
metadata.json file which is constructed as a Ruby hash and then
serialized to JSON and written to a file. When PDK writes these files it
was not including a trailing newline and files having trailing newlines
is a best practice.
This change updates the PDK::Util::Filesystem.write_file method to
ensure that it always writes files with a trailing newline.
Some of the unit tests around writing templated files also needed to be
updated because of the way the tests were implemented did not simulate
template files that already contained trailing newlines.