Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webdriverio/codemod
A codemod to transform Protractor into WebdriverIO tests
https://github.com/webdriverio/codemod
Last synced: 11 days ago
JSON representation
A codemod to transform Protractor into WebdriverIO tests
- Host: GitHub
- URL: https://github.com/webdriverio/codemod
- Owner: webdriverio
- License: mit
- Created: 2021-04-06T11:23:26.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T11:10:27.000Z (2 months ago)
- Last Synced: 2024-04-14T07:11:15.480Z (2 months ago)
- Language: JavaScript
- Size: 1.17 MB
- Stars: 24
- Watchers: 5
- Forks: 12
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-codemods - webdriverio/codemod - A codemod to transform Protractor into WebdriverIO tests. (Misc / ant-design)
README
WebdriverIO Codemod [](https://github.com/webdriverio/protractor-codemod/actions/workflows/test.yaml)
===================
This project contains various codemods to help migrating from either one major WebdriverIO version to another or from a specific framework to WebdriverIO. It can be used with [jscodeshift](https://www.npmjs.com/package/jscodeshift) and currently supports the following migrations:
- [x] v5 ▶️ v6 (see [migration guide](https://webdriver.io/docs/v6-migration))
- [x] v6 ▶️ v7 (see [migration guide](https://webdriver.io/docs/v7-migration))
- [x] Protractor ▶️ WebdriverIO (see [migration guide](https://webdriver.io/docs/protractor-migration))
- [x] Sync ▶️ Async (see [migration guide](https://webdriver.io/docs/async-migration))
- Note: This codemod depends on the [proxying of chained async calls](https://webdriver.io/blog/2021/07/28/sync-api-deprecation/) added in v7.9
- [ ] _more will eventually follow, let us know which ones you would like to see_
If you run into any issues during your migration please [let us know](https://github.com/webdriverio/codemod/discussions/new).
## Install
To transform your spec files, you need to install the following packages:
```sh
$ npm install jscodeshift @wdio/codemod
```
## Usage
To transform you code, run:
```sh
$ npx jscodeshift -t ./node_modules/@wdio/codemod/
# e.g. to migrate from v5 to v6
$ npx jscodeshift -t ./node_modules/@wdio/codemod/v6 ./e2e/
# e.g. to migrate from v6 to v7:
$ npx jscodeshift -t ./node_modules/@wdio/codemod/v7 ./e2e/
# e.g. to transform Protractor code:
$ npx jscodeshift -t ./node_modules/@wdio/codemod/protractor ./e2e/
# e.g. to tranform from sync to async
$ npx jscodeshift -t ./node_modules/@wdio/codemod/async ./e2e/
```
If you use TypeScript make sure you apply a different parser as parameter, e.g.:
```sh
$ npx jscodeshift -t ./node_modules/@wdio/codemod/protractor --parser=tsx ./e2e/*.ts
```
If you use a different line terminator from your os, you can override it as parameter, e.g.:
```sh
$ npx jscodeshift -t ./node_modules/@wdio/codemod/async --printOptions='{\"lineTerminator\":\"\n\"}' ./e2e/
```
You can transform tests as well as config files, e.g.:
![Codemod Usage Example][example]
[example]: /.github/assets/example.gif "Codemod Usage Example"