Skip to content

Commit

Permalink
docs(readme): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tusharmath committed Jul 16, 2018
1 parent c5a7352 commit b5553ba
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Code-Modifier for Typescript based projects
- [CLI Arguments](#cli-arguments)
- [Builtin Transformations](#builtin-transformations)
- [Custom Transformation](#custom-transformation)
- [Post Transformation](#post-transformation)

## Installation

Expand Down Expand Up @@ -85,3 +86,14 @@ It can then be executed as —
```bash
ts-codemod -t ./my-custom-transformation.ts src/**.ts
```

## Post Transformation

1. Life can't be that simple right? Running transformations will generally ruin the formatting of your files. A recommended way to solve that problem is by using [Prettier].
2. Even after running prettier its possible to have unnecessary new lines added/removed. This can be solved by ignoring white spaces while staging the changes in `git`.

```bash
git diff --ignore-black-lines | git add --cached
```

[prettier]: https://prettier.io

0 comments on commit b5553ba

Please sign in to comment.