refactor: migrate inline with the same sort

lib/config/migration.ts

@@ -4,7 +4,7 @@ import { dequal } from 'dequal';
 import { logger } from '../logger';
 import { clone } from '../util/clone';
 import { getGlobalConfig } from './global';
-import { applyMigrations } from './migrations';
+import { MigrationsRunner } from './migrations';
 import { getOptions } from './options';
 import { removedPresets } from './presets/common';
 import type {
@@ -20,7 +20,6 @@ const options = getOptions();
 let optionTypes: Record<string, RenovateOptions['type']>;
 
 const removedOptions = [
-  'maintainYarnLock',
   'yarnCacheFolder',
   'yarnMaintenanceBranchName',
   'yarnMaintenanceCommitMessage',
@@ -49,7 +48,8 @@ export function migrateConfig(
         optionTypes[option.name] = option.type;
       });
     }
-    const migratedConfig = clone(config) as MigratedRenovateConfig;
+    const newConfig = MigrationsRunner.runAllMigrations(config);
+    const migratedConfig = clone(newConfig) as MigratedRenovateConfig;
     const depTypes = [
       'dependencies',
       'devDependencies',
@@ -58,7 +58,6 @@ export function migrateConfig(
       'peerDependencies',
     ];
     const { migratePresets } = getGlobalConfig();
-    applyMigrations(config, migratedConfig);
     for (const [key, val] of Object.entries(config)) {
       if (removedOptions.includes(key)) {
         delete migratedConfig[key];
@@ -179,8 +178,6 @@ export function migrateConfig(
         migratedConfig[key] = val.replace(/{{baseDir}}/g, '{{packageFileDir}}');
       } else if (is.string(val) && val.includes('{{depNameShort}}')) {
         migratedConfig[key] = val.replace(/{{depNameShort}}/g, '{{depName}}');
-      } else if (key === 'gitFs') {
-        delete migratedConfig.gitFs;
       } else if (key === 'rebaseStalePrs') {
         delete migratedConfig.rebaseStalePrs;
         if (!migratedConfig.rebaseWhen) {
@@ -199,9 +196,6 @@ export function migrateConfig(
         if (val === false) {
           migratedConfig.rebaseWhen = 'never';
         }
-      } else if (key === 'exposeEnv') {
-        migratedConfig.exposeAllEnv = val;
-        delete migratedConfig.exposeEnv;
       } else if (key === 'trustLevel') {
         delete migratedConfig.trustLevel;
         if (val === 'high') {

lib/config/migrations/base/deprecate-property-migration.ts

@@ -0,0 +1,17 @@
+import type { RenovateConfig } from '../../types';
+import type { Migration } from '../migration';
+
+export class DeprecatePropertyMigration implements Migration {
+  private readonly deprecatedPropertyName: string;
+
+  constructor(deprecatedPropertyName: string) {
+    this.deprecatedPropertyName = deprecatedPropertyName;
+  }
+
+  run(config: RenovateConfig): RenovateConfig {
+    // eslint-disable-next-line no-param-reassign
+    delete config[this.deprecatedPropertyName];
+
+    return config;
+  }
+}

lib/config/migrations/base/replace-property-migration.ts

@@ -0,0 +1,29 @@
+import type { RenovateConfig } from '../../types';
+import type { Migration } from '../migration';
+
+export abstract class ReplacePropertyMigration implements Migration {
+  protected abstract readonly deprecatedPropertyName: string;
+
+  protected abstract readonly newPropertyName: string;
+
+  abstract run(config: RenovateConfig): RenovateConfig;
+
+  protected replaceProperty(
+    config: RenovateConfig,
+    newValue?: unknown
+  ): Record<string, unknown> {
+    const migratedConfig: Record<string, unknown> = {};
+
+    for (const [key, value] of Object.entries(config)) {
+      if (key === this.deprecatedPropertyName) {
+        if (newValue !== undefined) {
+          migratedConfig[this.newPropertyName] = newValue;
+        }
+      } else {
+        migratedConfig[key] = value;
+      }
+    }
+
+    return migratedConfig;
+  }
+}

lib/config/migrations/expose-env-migration.ts

@@ -0,0 +1,12 @@
+import type { RenovateConfig } from '../types';
+import { ReplacePropertyMigration } from './base/replace-property-migration';
+
+export class ExposeEnvMigration extends ReplacePropertyMigration {
+  protected override readonly deprecatedPropertyName = 'exposeEnv';
+
+  protected override readonly newPropertyName = 'exposeAllEnv';
+
+  override run(config: RenovateConfig): RenovateConfig {
+    return this.replaceProperty(config, config.exposeEnv);
+  }
+}

lib/config/migrations/index.ts

@@ -1,18 +1 @@
-import { RenovateConfig } from '../types';
-import type { Migration } from './migration';
-import { RequiredStatusChecksMigration } from './required-status-checks-migration';
-
-export function applyMigrations(
-  originalConfig: RenovateConfig,
-  migratedConfig: RenovateConfig
-): RenovateConfig {
-  const migrations: Migration[] = [
-    new RequiredStatusChecksMigration(originalConfig, migratedConfig),
-  ];
-
-  for (const migration of migrations) {
-    migration.migrate();
-  }
-
-  return migratedConfig;
-}
+export * from './migrations-runner';

lib/config/migrations/migration.ts

@@ -1,18 +1,5 @@
 import type { RenovateConfig } from '../types';
 
-export abstract class Migration {
-  protected readonly originalConfig: RenovateConfig;
-
-  protected readonly migratedConfig: RenovateConfig;
-
-  constructor(originalConfig: RenovateConfig, migratedConfig: RenovateConfig) {
-    this.originalConfig = originalConfig;
-    this.migratedConfig = migratedConfig;
-  }
-
-  abstract migrate(): void;
-
-  protected delete(property: string): void {
-    delete this.migratedConfig[property];
-  }
+export interface Migration {
+  run(config: RenovateConfig): RenovateConfig;
 }

lib/config/migrations/migrations-runner.ts

@@ -0,0 +1,24 @@
+import type { RenovateConfig } from '../types';
+import { DeprecatePropertyMigration } from './base/deprecate-property-migration';
+import { ExposeEnvMigration } from './expose-env-migration';
+import type { Migration } from './migration';
+import { RequiredStatusChecksMigration } from './required-status-checks-migration';
+
+export class MigrationsRunner {
+  private static readonly migrations: ReadonlyArray<Migration> = [
+    new DeprecatePropertyMigration('maintainYarnLock'),
+    new DeprecatePropertyMigration('gitFs'),
+    new ExposeEnvMigration(),
+    new RequiredStatusChecksMigration(),
+  ];
+
+  static runAllMigrations(originalConfig: RenovateConfig): RenovateConfig {
+    let config = originalConfig;
+
+    for (const migration of MigrationsRunner.migrations) {
+      config = migration.run(config);
+    }
+
+    return config;
+  }
+}

lib/config/migrations/required-status-checks-migration.spec.ts

@@ -1,20 +1,14 @@
+import type { RenovateConfig } from '../types';
 import { RequiredStatusChecksMigration } from './required-status-checks-migration';
 
 describe('config/migrations/required-status-checks-migration', () => {
   it('should migrate requiredStatusChecks=null to ignoreTests=true', () => {
-    const originalConfig: any = {
+    const originalConfig: Partial<RenovateConfig> = {
       requiredStatusChecks: null,
     };
-    const migratedConfig: any = {
-      requiredStatusChecks: null,
-    };
-    const migration = new RequiredStatusChecksMigration(
-      originalConfig,
-      migratedConfig
-    );
+    const migration = new RequiredStatusChecksMigration();
+    const migratedConfig = migration.run(originalConfig);
 
-    expect(migratedConfig.requiredStatusChecks).toBeNull();
-    migration.migrate();
     expect(migratedConfig.requiredStatusChecks).toBeUndefined();
     expect(migratedConfig.ignoreTests).toBeTrue();
   });

lib/config/migrations/required-status-checks-migration.ts

@@ -1,11 +1,15 @@
-import { Migration } from './migration';
+import type { RenovateConfig } from '../types';
+import { ReplacePropertyMigration } from './base/replace-property-migration';
 
-export class RequiredStatusChecksMigration extends Migration {
-  public migrate(): void {
-    this.delete('requiredStatusChecks');
+export class RequiredStatusChecksMigration extends ReplacePropertyMigration {
+  protected override readonly deprecatedPropertyName = 'requiredStatusChecks';
 
-    if (this.originalConfig.requiredStatusChecks === null) {
-      this.migratedConfig.ignoreTests = true;
-    }
+  protected override readonly newPropertyName = 'ignoreTests';
+
+  override run(config: RenovateConfig): RenovateConfig {
+    return this.replaceProperty(
+      config,
+      config.requiredStatusChecks === null ? true : undefined
+    );
   }
 }