Skip to content

Commit

Permalink
docs(readme): update readme with completed rules
Browse files Browse the repository at this point in the history
  • Loading branch information
Christopher Woolum committed Jul 7, 2018
1 parent 5ca6b26 commit b6a8c90
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ We are looking for contributors to help build these rules out! See [`CONTRIBUTIN

## How to Use

1. Install the lint rules:
1. Install the lint rules:

```
npm i -D @ionic/v4-migration-tslint
```

1. Add a file called `ionic-migration.json` at the root of your project and paste in the following JSON.
1. Add a file called `ionic-migration.json` at the root of your project and paste in the following JSON.

```
{
Expand All @@ -28,6 +28,8 @@ We are looking for contributors to help build these rules out! See [`CONTRIBUTIN
"rules": {
"ion-action-sheet-method-create-parameters-renamed": true,
"ion-alert-method-create-parameters-renamed": true,
"ion-datetime-capitalization-changed": true,
"ion-item-option-method-get-sliding-percent-renamed": true,
"ion-back-button-not-added-by-default": { "options": [true], "severity": "warning" },
"ion-button-attributes-renamed": true,
"ion-button-is-now-an-element": true,
Expand All @@ -42,7 +44,7 @@ We are looking for contributors to help build these rules out! See [`CONTRIBUTIN
}
```

1. Lint your project:
1. Lint your project:

```
npx tslint -c ionic-migration.json -p tsconfig.json
Expand Down Expand Up @@ -109,12 +111,14 @@ We are looking for contributors to help build these rules out! See [`CONTRIBUTIN
<th>
<a href="https://github.com/ionic-team/ionic/blob/master/angular/BREAKING.md#item-sliding">Item Sliding</a>
</th>
<td></td>
<td>:white_large_square:</td>
<td>:wrench:</td>
<td>:white_check_mark:</td>
<td>
<code>ion-item-option-method-get-sliding-percent-renamed</code>
</td>
<td></td>
<td>
<a href="https://github.com/mhartington">@mhartington</a>
</td>
</tr>
<tr>
<th>
Expand Down Expand Up @@ -514,7 +518,6 @@ We are looking for contributors to help build these rules out! See [`CONTRIBUTIN
</tr>
</table>


### Not Covered

Some changes are not covered by this fixer due to their complexity or because it would make no sense to do in automated fashion. They are:
Expand Down

0 comments on commit b6a8c90

Please sign in to comment.