https://github.com/colorfy-software/detoxify
🧪 Useful helpers for E2E testing in React Native with Detox.
https://github.com/colorfy-software/detoxify
android detox e2e ios react-native testing
Last synced: 7 months ago
JSON representation
🧪 Useful helpers for E2E testing in React Native with Detox.
- Host: GitHub
- URL: https://github.com/colorfy-software/detoxify
- Owner: colorfy-software
- License: mit
- Created: 2022-09-28T13:21:43.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-05T09:27:19.000Z (about 3 years ago)
- Last Synced: 2025-02-24T15:10:04.164Z (8 months ago)
- Topics: android, detox, e2e, ios, react-native, testing
- Language: Java
- Homepage: https://www.npmjs.org/package/@colorfy-software/detoxify
- Size: 430 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
🧪 Detoxify
Useful helpers for E2E testing in React Native with Detox.
## 🎯 Purpose
[Detox](https://wix.github.io/Detox/) is a library that provides gray box end-to-end testing and automation for React Native apps. Detoxify has been built on top of it to provide a useful set of tools to make that experience even more delightful.
## 🏗️ Installation
```sh
yarn add @colorfy-software/detoxify
```
Also install and set up:
1. [detox](https://wix.github.io/Detox/docs/introduction/getting-started)
2. [jest](https://wix.github.io/Detox/docs/guide/jest)
## 💻 Usage
### Setup
```ts
// ./e2e/environment.js
const DetoxHelpers = require('@colorfy-software/detoxify')
const { DetoxCircusEnvironment, SpecReporter, WorkerAssignReporter } = require('detox/runners/jest-circus')
class CustomDetoxEnvironment extends DetoxCircusEnvironment {
constructor(config, context) {
super(config, context)
// 👇👇👇
DetoxHelpers.init({
translations: require('../src/locales/en.ts'),
// optional
// runOnly: []
})
// 👆👆👆
// Can be safely removed, if you are content with the default value (=300000ms)
this.initTimeout = 300000
// This takes care of generating status logs on a per-spec basis. By default, Jest only reports at file-level.
// This is strictly optional.
this.registerListeners({
SpecReporter,
WorkerAssignReporter,
})
}
}
module.exports = CustomDetoxEnvironment
```
### Use cases
_Content coming soon._
## 🤝 Contributing
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
## 💖 Code of Conduct
This library has adopted a Code of Conduct that we expect project participants to adhere to. Please read the [full text](https://github.com/colorfy-software/detoxify/blob/main/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
## 📰 License
detoxify is licensed under the [MIT License](https://github.com/colorfy-software/detoxify/blob/master/LICENSE).