Skip to content

Commit dff3388

Browse files
authored
Merge pull request #531 from gitKrystan/fix-readme
Fix typos in readme
2 parents dd4094c + 7d90602 commit dff3388

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ with decorators!
1111
First, install the dependencies that the codemod relies on. These are
1212
addons that the codemod will add imports from:
1313

14-
```
14+
```shell
1515
ember install ember-classic-decorator
1616
ember install ember-decorators
1717
```
1818

1919
Then, boot up your application. Then, the codemod can be run using the
2020
following command:
2121

22-
```
22+
```shell
2323
npx ember-native-class-codemod http://localhost:4200/path/to/server [OPTIONS] path/of/files/ or/some**/*glob.js
2424
```
2525

@@ -35,7 +35,7 @@ The codemod accepts the following options, passed as CLI arguments, set in a `.c
3535
| `--type` / `type` | `'services' \| 'routes' \| 'components' \| 'controllers' \| undefined`' | `undefined` | Apply transformation to only passed type. If `undefined, will match all types in path. |
3636
| `--quote` / `quote` | `'single' \| 'double'` | `'single'` | Whether to use double or single quotes by default for new statements that are added during the codemod. |
3737
| `--ignore-leaking-state` / `ignoreLeakingState` | `string \| string[] | `['queryParams']` | Allow-list for `ObjectExpression` or `ArrayExpression` properties to ignore issues detailed in [eslint-plugin-ember/avoid-leaking-state-in-ember-objects](https://github.com/ember-cli/eslint-plugin-ember/blob/master/docs/rules/avoid-leaking-state-in-ember-objects.md). In the classic class syntax, using arrays and objects as default properties causes their state to "leak" between instances. If you have custom properties where you know that the shared state won't be a problem (for example, read-only configuration values), you can use this config to ignore them. NOTE: Passing this option will override the defaults, so ensure you include `'queryParams'` in the list unless you explicitly wish to disallow it. Pass as a comma-separated string if using as a CLI-option. Otherwise pass as an array of strings. |
38-
| `DecoratorsConfig` | An object with the following properties. | See below. | A list of decorators that are allowed on object literal properties. (Method decorators will always be allowed.) When the codemod finds a field with one of these decorators, it will be translated directly into a class field with the same decorator. Including a decorator in this list means that you believe that the decorator will work correctly on a class field. Pass as a comma-separated string if using as a CLI-option. Otherwise pass as an array of strings. |
38+
| `DecoratorsConfig` | An object with the following properties. | See below. | See below. |
3939
| `DecoratorsConfig.inObjectLiterals` | `string \| string[]` | `[]` | Allow-list for decorators currently applied to object literal properties that can be safely applied to class properties. Pass as a comma-separated string if using as a CLI-option. Otherwise pass as an array of strings. NOTE: Decorators on object methods will be allowed by default. |
4040

4141
### Gathering Runtime Data
@@ -93,7 +93,6 @@ transformation of
9393

9494
<!--TRANSFORMS_START-->
9595
* [ember-object](transforms/ember-object/README.md)
96-
* [helpers](transforms/helpers/README.md)
9796
<!--TRANSFORMS_END-->
9897

9998
## Contributing

0 commit comments

Comments
 (0)