Skip to content

Commit 5458f42

Browse files
author
Santosh Sutar
committed
Add dyfactor and runtime config details
1 parent baf2ee7 commit 5458f42

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

howto.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Ember ES6 - How to run ES6 class codemods
22

33
## Overview
4-
The [ES6 native classes](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes) support is available in Ember starting with 3.4.x via [polyfill](https://github.com/pzuraq/ember-native-class-polyfill) (3.6.x without polyfill). Transitioning to the new ES6 classes syntax would provide better overall developer experience. The [ember ES6 class codemods](https://github.com/scalvert/ember-es6-class-codemod) are developed to make this transition easier.
4+
The [ES6 native classes](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes) support is available in Ember starting with 3.4.x via [polyfill](https://github.com/pzuraq/ember-native-class-polyfill) (3.6.x without polyfill). Transitioning to the new ES6 classes syntax would provide better overall developer experience. The [ember ES6 class codemods](https://github.com/ember-codemods/ember-es6-class-codemod) are developed to make this transition easier.
55

66
The purpose of this document is to provide step by step guide to install and run codemods on your code base.
77

@@ -14,7 +14,7 @@ The application must be running on
1414

1515
Before moving on to installation steps, let's take a quick overview of dependencies which will be added to the application.
1616

17-
### [ember-es6-class-codemod](https://github.com/scalvert/ember-es6-class-codemod)
17+
### [ember-es6-class-codemod](https://github.com/ember-codemods/ember-es6-class-codemod)
1818
Codemods for transforming ember app code to native ES6 class syntax with decorators. The codemods can be installed globally (recommended) or locally.
1919

2020
### [ember-es6-class-codemod-dyfactor](https://github.com/ssutar/ember-es6-class-codemod-dyfactor)
@@ -51,7 +51,10 @@ yarn ember install ember-native-class-polyfill
5151
```
5252

5353
## Setup dyfactor plugin
54-
Once all the dependencies are installed successfully, the application need to be setup to run the [dyfactor plugin](https://github.com/ssutar/ember-es6-class-codemod-dyfactor), which is used to gather valuable runtime information from the application for use within the codemod
54+
Once all the dependencies are installed successfully, the application need to be setup to run the [dyfactor plugin](https://github.com/ssutar/ember-es6-class-codemod-dyfactor), which is used to gather valuable runtime information from the application for use within the codemod. The codemods are designed with runtime data as input to correctly transform the code. See the documentation of [Runtime Config Path](https://github.com/ember-codemods/ember-es6-class-codemod#runtime-config-path) option for more details.
55+
56+
[Dyfactor](https://github.com/dyfactor/dyfactor) is a plugin runner system, which allows you to collect the runtime information about the code. See the [documentation](https://github.com/dyfactor/dyfactor#usage) for more details about dyfactor
57+
5558

5659
To initialize the dyfactor plugin, run
5760
```

0 commit comments

Comments
 (0)