@ember-decorators/argument-codemod

A collection of codemods for migrating from @ember-decorators/argument to ember-argument-types

This set of codemods are to be used together in sequential order to:

1. argument-decorators-to-json: Create a json map of component properties which use argument and type decorators provided by @ember-decorators/argument.
2. argument-decorators-json-to-template: Use the map generated in step one to populate arg-type helpers provided by ember-argument-types in the associated template.
3. argument-decorators-cleanup: Remove argument and type decorators and their imports from the component js class and optionally add the @classic decorator to the class.

Why would you do this? If you're using @ember-decorators/argument decorators they will prevent you from upgrading your ember version beyond 2.12. The goal of this codemod is to unblock the upgrade path while still maintaining the ability to dynamically type check the arguments being passed to your component.

Note, if you don't want/need component argument type checking, you can run just the third transform to remove the decorators without adding the arg-type helpers to templates.

Known limitations/caveats

• Component names must be unique (doesn't account for nested component paths)
• Custom class types are not supported, but are processed into __UNKNOWN_TYPE__ strings since it's not always clear how the user intends to deal with these cases. What this means is that after running the transforms, you will want to do a string search for __UNKNOWN_TYPE__ and either comment out the helper or export the class from the component js and replace the __UNKNOWN_TYPE__ string with a reference to the actual class as an argument to the instance-of helper, eg. (instance-of this.MyClass).
• Decorator values can't be references. For example let obj = {}; @argument(shapeOf(obj)) will throw an error.
• The path to the argument-decorators-to-json.json file is not configurable and the file will be generated in the dir where the command is run.

Usage

To run a specific codemod from this project, you would run the following:

npx @ember-decorators/argument-codemod <TRANSFORM NAME> path/of/files/ or/some**/*glob.js

Note that when running the argument-decorators-to-json transform, you must include the --run-in-band flag:

npx @ember-decorators/argument-codemod argument-decorators-to-json path/of/files/ --run-in-band

Local Usage

node ./bin/cli.js <TRANSFORM NAME> path/of/files/ or/some**/*glob.js

Transforms

• argument-decorators-cleanup
• argument-decorators-json-to-template
• argument-decorators-to-json

Contributing

Installation

• clone the repo
• change into the repo directory
• yarn

Running tests

• yarn test

Update Documentation

• yarn update-docs