Back to Nx

Migrate Jest Configuration Skip Setup File

packages/jest/src/migrations/update-23-0-0/migrate-jest-configuration-skip-setup-file.md

23.0.01.7 KB
Original Source

Migrate skipSetupFile Generator Default to setupFile

Migrates the previously deprecated skipSetupFile option of the @nx/jest:configuration generator. When set as a default in nx.json generators or per-project project.json generators, it is rewritten as follows:

  • skipSetupFile: true becomes setupFile: 'none' (preserving the original behavior of skipping the setup file). Existing setupFile values are left untouched.
  • skipSetupFile: false is dropped (it was a no-op).

Both flat (@nx/jest:configuration) and nested (@nx/jestconfiguration) forms are handled.

Examples

Rewrite a nx.json generator default:

Before
json
{
  "generators": {
    "@nx/jest:configuration": {
      "skipSetupFile": true
    }
  }
}
After
json
{
  "generators": {
    "@nx/jest:configuration": {
      "setupFile": "none"
    }
  }
}

Drop the option when set to false:

Before
json
{
  "generators": {
    "@nx/jest:configuration": {
      "skipSetupFile": false,
      "testEnvironment": "jsdom"
    }
  }
}
After
json
{
  "generators": {
    "@nx/jest:configuration": {
      "testEnvironment": "jsdom"
    }
  }
}

Rewrite a per-project generator default:

Before
json
{
  "generators": {
    "@nx/jest:configuration": {
      "skipSetupFile": true
    }
  }
}
After
json
{
  "generators": {
    "@nx/jest:configuration": {
      "setupFile": "none"
    }
  }
}

The nested form (@nx/jestconfiguration) is handled the same way.