ember-data-codemod
Version:
62 lines (36 loc) • 1.62 kB
Markdown
# Ember Data Codemod
A collection of codemods for ember-data. For now, it only contains a codemod to upgrade to the new "@ember-data" packages!
## Usage
To run a specific codemod from this project, you would run the following:
```
npx ember-data-codemod <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
# or
yarn global add ember-data-codemod
ember-data-codemod <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
```
To run every codemod from this project, you would run the following:
```
npx ember-data-codemod . path/of/files/ or/some**/*glob.js
# or
yarn global add ember-data-codemod
ember-data-codemod . path/of/files/ or/some**/*glob.js
```
## Transforms
<!--TRANSFORMS_START-->
* [globals-to-ember-data-imports](transforms/globals-to-ember-data-imports/README.md)
<!--TRANSFORMS_END-->
## Contributing
### Installation
* clone the repo
* change into the repo directory
* `yarn`
### Running tests
* `yarn test`
### Update Documentation
* `yarn update-docs`
## Credits
This repository is intially a fork of [ember-modules-codemod](https://github.com/ember-cli/ember-modules-codemod) adapted for the needs of ember-data. [This PR](https://github.com/dcyriller/ember-data-codemod/pull/1) illustrates the work needed to adapt ember-modules-codemod to fit ember-data needs.
This codemod uses [`jscodeshift`](https://github.com/facebook/jscodeshift)
## Links
* [RFC 395: @ember-data packages](https://github.com/emberjs/rfcs/pull/395)
* [ember/use-ember-data-rfc-395-imports](https://github.com/ember-cli/eslint-plugin-ember/blob/master/docs/rules/use-ember-data-rfc-395-imports.md) lint rule