Skip to content

Commit 49a829a

Browse files
committed
chore: add note on git history
1 parent 9b6e744 commit 49a829a

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,13 @@ NOTE: With bigger files you might have to run the linting more than once, we aut
5252
#### Eslint and Prettier rules
5353
This toolkit makes the assumption that your project already aligns the prettier and eslint rules. If not, the automated fixing might result in a half-baked solution which potentially does not match your existing linting checks.
5454

55+
### Git history
56+
Worth noting is that `bulk-decaffeinate` specifically aims to retain git history on files converted through it, nevertheless, if you squash the commits upon merging, instead of creating a merge commit you will lose some ability to navigate the history as per normal on providers like Github. That being said, the history is always traceable via the original commit which references the old `.coffee` file. Additionally you can use the following command to log the full file history:
57+
58+
```
59+
git log --oneline --follow --all -- path/to/my/converted/file.js
60+
```
61+
5562
### Manual workflow
5663
Once you have run the automated conversion, there are some manual steps required:
5764
1. Merge any imports depending on the same declarations if required

0 commit comments

Comments
 (0)