Skip to content

relizy / checkMigration

Function: checkMigration() ​

checkMigration(__namedParameters?): Promise<MigrationReport>

Defined in: packages/relizy/src/core/migration.ts:975

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 = {}

Returns ​

Promise<MigrationReport>

Example ​

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