Have ideas to improve npm?Join in the discussion! »

    jest-expo

    41.0.0 • Public • Published

    jest-expo

    A Jest preset to painlessly test your Expo / React Native apps.

    If you have problems with the code in this repository, please file issues & bug reports at https://github.com/expo/expo. Thanks!

    Installation

    • yarn add jest-expo --dev or npm i jest-expo --save-dev

    • Add the following config to package.json:

      "scripts": {
        "test": "node_modules/.bin/jest",
        "test:debug": "node --inspect-brk node_modules/jest/bin/jest.js --runInBand"
      },
      "jest": {
        "preset": "jest-expo"
      }
    • Create a __tests__ directory anywhere you like and a Example-test.js file inside of it, and add this code:

      it('works', () => {
        expect(1).toBe(1);
      });
    • Run npm test and it should pass

    Platforms

    You can use jest-expo to test any Expo supported platform. For legacy purposes jest-expo runs your tests in the standard React Native environment (iOS). The recommended way to test your project is with jest-expo/universal which runs your tests with every Expo supported platform. Currently this includes iOS, Android, web, and Node (which is used for testing SSR compliance).

    Pressing X will open a platform-selection dialog that you can use to test individual platforms. You can also create a custom Jest config and combine the individual platforms with jest-expo/ios, jest-expo/android, jest-expo/web, and jest-expo/node.

    Snapshots

    Because a test is run with multiple different platforms, jest-expo saves snapshots using the name of the platform as the extension. This is very useful for testing something like view styles, which are computed differently across web and native.

    Here is an example output:

    |- View-test.tsx |-- __snapshots__/View-test.tsx.snap.android |-- __snapshots__/View-test.tsx.snap.ios |-- __snapshots__/View-test.tsx.snap.node |-- __snapshots__/View-test.tsx.snap.web

    Extensions

    To test specific platforms you can use the following extensions:

    • iOS: -test.ios.*, -test.native.*
    • Android: -test.android.*, -test.native.*
    • web: -test.web.*
    • Node: -test.node.*, -test.web.*

    Mixing runners

    If you don't want to use every runner you can always mix runners by using the projects field of your Jest config. This will only work with single-runner projects like jest-expo/ios, jest-expo/android, jest-expo/web, and jest-expo/node.

    "jest": {
    -  "preset": "jest-expo/universal"
    // Skip web and Node tests
    + "projects": [
    +    { "preset": "jest-expo/ios" },
    +    { "preset": "jest-expo/android"}
    + ]
    },

    Testing JSX Components

    To test the output of your React components you can use the library jest-expo-enzyme, which extends jest-expo and adds universal Enzyme support.

    ⚙️ Configuring your preset

    When building a custom preset you may want to use some of features provided by this preset. You can access these features through the jest-expo/config directory.

    getWatchPlugins(jestConfig)

    When given an existing Jest config this will return the watchPlugins used in jest-expo. This reads the projects field to determine which watchPlugins to return for single-project and multi-project configs.

    Currently this returns type-ahead plugins for all projects:

    • jest-watch-typeahead/filename
    • jest-watch-typeahead/testname

    And a custom platform selection dialog for universal multi-projects:

    • jest-watch-select-projects

    withWatchPlugins(jestConfig)

    Given a Jest config, this will ensure any existing watchPlugins are safely merged with getWatchPlugins(jestConfig).

    getWebPreset()

    Alternative to jest-expo/web. This runs in a JSDOM environment for testing Expo web.

    getIOSPreset()

    Alternative to jest-expo/ios. Runs in a mock native environment.

    getAndroidPreset()

    Alternative to jest-expo/android. Also runs in a mock native environment.

    getNodePreset()

    Alternative to jest-expo/node. This runs in a Node environment for testing SSR.

    Learning Jest

    Read the excellent documentation

    Keywords

    none

    Install

    npm i jest-expo

    DownloadsWeekly Downloads

    51,712

    Version

    41.0.0

    License

    MIT

    Unpacked Size

    88.6 kB

    Total Files

    23

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar