---
url: https://relizy.dev/typedoc/functions/checkMigration.md
---
[relizy](../index.md) / checkMigration

# Function: checkMigration()

> **checkMigration**(`__namedParameters?`): `Promise`<[`MigrationReport`](../interfaces/MigrationReport.md)>

Defined in: [packages/relizy/src/core/migration.ts:975](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/migration.ts#L975)

What to change in the project to upgrade it from relizy 1 to relizy 2, as
data: each finding with its severity (`change`, or `review` to check), the
files and lines concerned, the fix and its section of the migration guide.
Read-only. A config that does not load with relizy 2 gives a `blocking`
finding, with the checks that do not need the config.

## Parameters

### \_\_namedParameters?

[`CheckMigrationOptions`](../interfaces/CheckMigrationOptions.md) = `{}`

## Returns

`Promise`<[`MigrationReport`](../interfaces/MigrationReport.md)>

## Example

```ts
const { findings } = await checkMigration({ cwd: '/path/to/project' })
for (const finding of findings) {
  console.log(finding.severity, finding.title, finding.locations)
}
```
