fix: prettier format files #1369
Merged
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 1101cd0:
|
emersonlaurentino
force-pushed
the
fix/format
branch
from
6491194 to
28c43f1
Compare
filipewl
approved these changes
Jun 17, 2022
There was a problem hiding this comment.
Nice! I think it's a nice opportunity for us to use Git's feature of ignoring commits in the blame view so all this automatic formatting changes don't clutter the blame view of a file, obfuscating important commit information. What do you think? You can find information in this GH Doc.
https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view
tlgimenes
approved these changes
Jun 17, 2022
emersonlaurentino
force-pushed
the
fix/format
branch
from
28c43f1 to
2714c9b
Compare
emersonlaurentino
force-pushed
the
fix/format
branch
from
2714c9b to
1101cd0
Compare
filipewl
pushed a commit
that referenced
this pull request
Jul 20, 2022
## What's the purpose of this pull request? ``` 🧹 This is more for Git housekeeping than the FastStore itself. ``` Create a `.git-blame-ignore-revs` file to list commits that should be ignored from the blame view. This is useful to remove the noise introduced by aesthetic changes such as code formatting: when viewing the blame for a file, we can omit commits that only changed formatting/indentation so we can quickly see what matters. I had [mentioned](#1369 (review)) that #1369 was a good candidate to test this feature (that is relatively new in GH, not Git itself). ## How does it work? By adding a commit SHA/ID to be ignored in the `.git-blame-ignore-revs` file. ## How to test it? See how on _Before_ the changes from the commit "fix: prettier format files", which were only formatting, hid the original blame lines. On _After_ they're restored because that commit is ignored. [Before](https://github.com/vtex/faststore/blame/5aa3958cbbfd2177c691406d147bd4bc6d08c8f1/packages/api/src/platforms/vtex/index.ts)|[After](https://github.com/vtex/faststore/blame/ea45a50eb14eee131526359b18cc9e3da945175f/packages/api/src/platforms/vtex/index.ts) -|- | ## References - [GH Docs - Ignore commits in the blame view](https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view) - [GH Community - Support --ignore-revs-file for blame view to support automated code formatters](community/community#5033) - [Blog - A better git blame with --ignore-rev](https://www.michaelheap.com/git-ignore-rev/)
|
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.
What's the purpose of this pull request?
Prettier was configured and some files need to be formatted
How it works?
All files will formatted following prettier config
How to test it?
Starters Deploy Preview
References