refactor: Renormalize to ensure consistent file line termination. #226
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
shahzadlone
added
code quality
orpheuslummis
approved these changes
Feb 23, 2022
|
see my comments in core-dev. Really prefer we dont do this now |
shahzadlone
force-pushed
the
lone/refactor/i-225/normalize-consistent-line-endings
branch
from
d9c7c8f
to
b3194d7
Compare
Codecov Report
@@ Coverage Diff @@
## develop #226 +/- ##
========================================
Coverage 58.12% 58.12%
========================================
Files 103 103
Lines 10224 10224
========================================
Hits 5943 5943
Misses 3647 3647
Partials 634 634
|
jsimnz
approved these changes
Mar 7, 2022
shahzadlone
deleted the
lone/refactor/i-225/normalize-consistent-line-endings
branch
shahzadlone
added a commit
to shahzadlone/defradb
that referenced
this pull request
Feb 23, 2024
…urcenetwork#226) * Add git attributes * Renormalize the files
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.
ISSUE:
Resolves #225
DESCRIPTION:
Git diff shows added lines and removed lines that are exactly the same except (LF or CRLF line endings, which aren't even visible). This makes reviewing diffs very painful, specially linter refactoring that modifies lots of lines, the files show up as if the line from each file was removed and then added (can't really compare properly).
Hence this solution, with this config-based approach, we can ensure that our line endings remain consistent throughout our code-base regardless of what operating systems or local Git settings the developers use.
Beauty with this approach is that Windows and Linux users locally will keep what they want to use, when checked in they will consistently have LF line endings.
Note: We also ensures that binary files are not modified.
REFERENCE:
https://www.aleksandrhovhannisyan.com/blog/crlf-vs-lf-normalizing-line-endings-in-git/
Before PR:
After PR: