Repository files navigation

An effort to warn about and automatically fix syntax changes listed inBREAKING.md using tslint, codelyzer, and the Angular compiler.

We are looking for contributors to help build these rules out! SeeCONTRIBUTING.md to help out. 💖

1. Install the lint rules:

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

2. Add a file calledionic-migration.json at the root of your project and paste in the following JSON.

   {"rulesDirectory": ["@ionic/v4-migration-tslint/rules"],"rules": {"ion-action-sheet-method-create-parameters-renamed":true,"ion-alert-method-create-parameters-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,"ion-buttons-attributes-renamed":true,"ion-col-attributes-renamed":true,"ion-datetime-capitalization-changed":true,"ion-fab-attributes-renamed":true,"ion-fab-button-is-now-an-element":true,"ion-fab-fixed-content":true,"ion-icon-attribute-is-active-removed":true,"ion-item-attributes-renamed":true,"ion-item-divider-ion-label-required":true,"ion-item-ion-label-required":true,"ion-item-is-now-an-element":true,"ion-item-option-is-now-an-element":true,"ion-item-option-method-get-sliding-percent-renamed":true,"ion-item-options-attribute-values-renamed":true,"ion-label-attributes-renamed":true,"ion-list-header-ion-label-required":true,"ion-loading-method-create-parameters-renamed":true,"ion-menu-events-renamed":true,"ion-menu-toggle-is-now-an-element":true,"ion-navbar-is-now-ion-toolbar":true,"ion-option-is-now-ion-select-option":true,"ion-overlay-method-create-should-use-await":true,"ion-overlay-method-present-should-use-await":true,"ion-radio-attributes-renamed":true,"ion-radio-group-is-now-an-element":true,"ion-radio-slot-required":true,"ion-range-attributes-renamed":true,"ion-segment-button-ion-label-required":true,"ion-spinner-attribute-values-renamed":true,"ion-tabs-refactored": {"options": [true],"severity":"warning" },"ion-text-is-now-an-element":true  }}

3. Lint your project:

   npx tslint -c ionic-migration.json -p tsconfig.json

   📝Hints:

   • Run tslint with-t verbose to output the rule names of lint errors which correspond to thetable of rules below.
   • Run tslint with--fix to attempt automatic fixes (note: not all rules have fixes, and be sure to save a backup in version control before running with--fix)

⬜ – These rules need to be completed! SeeCONTRIBUTING.md to get started.

🔧 – These rules can be automatically fixed with--fix.

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:

• Colors
• Dynamic Mode
• Icon » Fonts Removed
• Theming