feat: replace deprecated dependencies with their replacements

docs/usage/configuration-options.md

@@ -939,6 +939,14 @@ Use this field to match rules against types of updates. For example to apply a s
 }
 ```
 
+### replacementName
+
+Valid in `packageRules`
+
+### replacementVersion
+
+Valid in `packageRules`
+
 ## patch
 
 Add to this object if you wish to define rules that apply only to patch updates. See also `major` and `minor` configuration options.

lib/config/__snapshots__/index.spec.ts.snap

@@ -23,8 +23,8 @@ Object {
   "commitBody": null,
   "commitBodyTable": false,
   "commitMessage": "{{{commitMessagePrefix}}} {{{commitMessageAction}}} {{{commitMessageTopic}}} {{{commitMessageExtra}}} {{{commitMessageSuffix}}}",
-  "commitMessageAction": "Update",
-  "commitMessageExtra": "to {{#if isMajor}}v{{{newMajor}}}{{else}}{{#if isSingleVersion}}v{{{toVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}",
+  "commitMessageAction": "{{# if isReplacement}}Replace{{else}}Update{{/if}}",
+  "commitMessageExtra": "{{#if isReplacement}} with {{newName}}{{else}}to {{#if isMajor}}v{{{newMajor}}}{{else}}{{#if isSingleVersion}}v{{{toVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}{{/if}}",
   "commitMessagePrefix": null,
   "commitMessageSuffix": null,
   "commitMessageTopic": "dependency {{depName}}",
@@ -68,7 +68,7 @@ Object {
     "Change",
   ],
   "prBodyDefinitions": Object {
-    "Change": "\`{{{displayFrom}}}\` -> \`{{{displayTo}}}\`",
+    "Change": "{{#if isReplacement}}{{newName}}{{else}}\`{{{displayFrom}}}\` -> \`{{{displayTo}}}\`{{/if}}",
     "Current value": "{{{currentValue}}}",
     "New value": "{{{newValue}}}",
     "Package": "{{{depNameLinked}}}",
@@ -155,8 +155,8 @@ Object {
   "commitBody": null,
   "commitBodyTable": false,
   "commitMessage": "{{{commitMessagePrefix}}} {{{commitMessageAction}}} {{{commitMessageTopic}}} {{{commitMessageExtra}}} {{{commitMessageSuffix}}}",
-  "commitMessageAction": "Update",
-  "commitMessageExtra": "to {{#if isMajor}}v{{{newMajor}}}{{else}}{{#if isSingleVersion}}v{{{toVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}",
+  "commitMessageAction": "{{# if isReplacement}}Replace{{else}}Update{{/if}}",
+  "commitMessageExtra": "{{#if isReplacement}} with {{newName}}{{else}}to {{#if isMajor}}v{{{newMajor}}}{{else}}{{#if isSingleVersion}}v{{{toVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}{{/if}}",
   "commitMessagePrefix": null,
   "commitMessageSuffix": null,
   "commitMessageTopic": "dependency {{depName}}",
@@ -281,7 +281,7 @@ Object {
     "Change",
   ],
   "prBodyDefinitions": Object {
-    "Change": "[{{#if displayFrom}}\`{{{displayFrom}}}\` -> {{else}}{{#if currentValue}}\`{{{currentValue}}}\` -> {{/if}}{{/if}}{{#if displayTo}}\`{{{displayTo}}}\`{{else}}\`{{{newValue}}}\`{{/if}}](https://renovatebot.com/diffs/npm/{{replace '/' '%2f' depName}}/{{{fromVersion}}}/{{{toVersion}}})",
+    "Change": "{{#if isReplacement}}{{newName}}{{else}}[{{#if displayFrom}}\`{{{displayFrom}}}\` -> {{else}}{{#if currentValue}}\`{{{currentValue}}}\` -> {{/if}}{{/if}}{{#if displayTo}}\`{{{displayTo}}}\`{{else}}\`{{{newValue}}}\`{{/if}}](https://renovatebot.com/diffs/npm/{{replace '/' '%2f' depName}}/{{{fromVersion}}}/{{{toVersion}}}){{/if}}",
     "Current value": "{{{currentValue}}}",
     "New value": "{{{newValue}}}",
     "Package": "{{{depNameLinked}}}",
@@ -383,8 +383,8 @@ Object {
   "commitBody": null,
   "commitBodyTable": false,
   "commitMessage": "{{{commitMessagePrefix}}} {{{commitMessageAction}}} {{{commitMessageTopic}}} {{{commitMessageExtra}}} {{{commitMessageSuffix}}}",
-  "commitMessageAction": "Update",
-  "commitMessageExtra": "to {{#if isMajor}}v{{{newMajor}}}{{else}}{{#if isSingleVersion}}v{{{toVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}",
+  "commitMessageAction": "{{# if isReplacement}}Replace{{else}}Update{{/if}}",
+  "commitMessageExtra": "{{#if isReplacement}} with {{newName}}{{else}}to {{#if isMajor}}v{{{newMajor}}}{{else}}{{#if isSingleVersion}}v{{{toVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}{{/if}}",
   "commitMessagePrefix": null,
   "commitMessageSuffix": null,
   "commitMessageTopic": "dependency {{depName}}",
@@ -510,7 +510,7 @@ Object {
     "Change",
   ],
   "prBodyDefinitions": Object {
-    "Change": "\`{{{displayFrom}}}\` -> \`{{{displayTo}}}\`",
+    "Change": "{{#if isReplacement}}{{newName}}{{else}}\`{{{displayFrom}}}\` -> \`{{{displayTo}}}\`{{/if}}",
     "Current value": "{{{currentValue}}}",
     "New value": "{{{newValue}}}",
     "Package": "{{{depNameLinked}}}",

lib/config/common.ts

@@ -160,25 +160,27 @@ export type UpdateType =
   | 'lockFileMaintenance'
   | 'lockfileUpdate'
   | 'rollback'
-  | 'bump';
+  | 'bump'
+  | 'replacement';
 
 // TODO: Proper typings
 export interface PackageRule
   extends RenovateSharedConfig,
     UpdateConfig,
     Record<string, any> {
-  paths?: string[];
-  languages?: string[];
   baseBranchList?: string[];
   datasources?: string[];
   depTypeList?: string[];
-  packageNames?: string[];
-  packagePatterns?: string[];
   excludePackageNames?: string[];
   excludePackagePatterns?: string[];
+  languages?: string[];
   matchCurrentVersion?: string | Range;
+  packageNames?: string[];
+  packagePatterns?: string[];
+  paths?: string[];
+  replacementName?: string;
+  replacementVersion?: string;
   sourceUrlPrefixes?: string[];
-
   updateTypes?: UpdateType[];
 }
 

lib/config/definitions.ts

@@ -814,6 +814,26 @@ const options: RenovateOptions[] = [
     cli: false,
     env: false,
   },
+  {
+    name: 'replacementName',
+    description: '',
+    type: 'string',
+    stage: 'package',
+    parent: 'packageRules',
+    mergeable: true,
+    cli: false,
+    env: false,
+  },
+  {
+    name: 'replacementVersion',
+    description: '',
+    type: 'string',
+    stage: 'package',
+    parent: 'packageRules',
+    mergeable: true,
+    cli: false,
+    env: false,
+  },
   {
     name: 'updateTypes',
     description:
@@ -1217,7 +1237,7 @@ const options: RenovateOptions[] = [
     name: 'commitMessageAction',
     description: 'Action verb to use in commit messages and PR titles',
     type: 'string',
-    default: 'Update',
+    default: '{{# if isReplacement}}Replace{{else}}Update{{/if}}',
     cli: false,
   },
   {
@@ -1233,7 +1253,7 @@ const options: RenovateOptions[] = [
       'Extra description used after the commit message topic - typically the version',
     type: 'string',
     default:
-      'to {{#if isMajor}}v{{{newMajor}}}{{else}}{{#if isSingleVersion}}v{{{toVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}',
+      '{{#if isReplacement}} with {{newName}}{{else}}to {{#if isMajor}}v{{{newMajor}}}{{else}}{{#if isSingleVersion}}v{{{toVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}{{/if}}',
     cli: false,
   },
   {
@@ -1587,7 +1607,8 @@ const options: RenovateOptions[] = [
       Update: '{{{updateType}}}',
       'Current value': '{{{currentValue}}}',
       'New value': '{{{newValue}}}',
-      Change: '`{{{displayFrom}}}` -> `{{{displayTo}}}`',
+      Change:
+        '{{#if isReplacement}}{{newName}}{{else}}`{{{displayFrom}}}` -> `{{{displayTo}}}`{{/if}}',
       References: '{{{references}}}',
       'Package file': '{{{packageFile}}}',
     },

lib/config/utils.ts

@@ -1,7 +1,7 @@
 import { RenovateConfig } from './common';
 import { logger } from '../logger';
 import { clone } from '../util/clone';
-import * as definitions from './definitions';
+import { getOptions } from './definitions';
 
 export function mergeChildConfig<T, TChild>(
   parent: T,
@@ -14,7 +14,7 @@ export function mergeChildConfig<T, TChild>(
   const parentConfig = clone(parent);
   const childConfig = clone(child);
   const config: Record<string, any> = { ...parentConfig, ...childConfig };
-  for (const option of definitions.getOptions()) {
+  for (const option of getOptions()) {
     if (
       option.mergeable &&
       childConfig[option.name] &&

lib/datasource/common.ts

@@ -24,6 +24,8 @@ export interface GetPkgReleasesConfig extends ReleasesConfigBase {
   depName: string;
   lookupName?: string;
   versioning?: string;
+  replacementName?: string;
+  replacementVersion?: string;
 }
 
 export function isGetPkgReleasesConfig(
@@ -59,6 +61,8 @@ export interface ReleaseResult {
   name?: string;
   pkgName?: string;
   releases: Release[];
+  replacementName?: string;
+  replacementVersion?: string;
   sourceUrl?: string;
   tags?: string[];
   versions?: any;

lib/datasource/index.spec.ts

@@ -3,15 +3,20 @@ import * as datasource from '.';
 import * as datasourceDocker from './docker';
 import * as datasourceGithubTags from './github-tags';
 import * as datasourceNpm from './npm';
-import { mocked } from '../../test/util';
 import { loadModules } from '../util/modules';
+import { mocked, getName } from '../../test/util';
 
 jest.mock('./docker');
 jest.mock('./npm');
 
 const npmDatasource = mocked(datasourceNpm);
 
-describe('datasource/index', () => {
+describe(getName(__filename), () => {
+  beforeEach(() => {
+    jest.resetAllMocks();
+    global.repoCache = {};
+  });
+
   it('returns datasources', () => {
     expect(datasource.getDatasources()).toBeDefined();
     expect(datasource.getDatasourceList()).toBeDefined();
@@ -117,4 +122,17 @@ describe('datasource/index', () => {
     });
     expect(res.sourceUrl).toEqual('https://github.com/Jasig/cas');
   });
+  it('applies replacements', async () => {
+    npmDatasource.getReleases.mockResolvedValue({
+      releases: [{ version: '1.0.0' }],
+    });
+    const res = await datasource.getPkgReleases({
+      datasource: datasourceNpm.id,
+      depName: 'abc',
+      replacementName: 'def',
+      replacementVersion: '2.0.0',
+    });
+    expect(res.replacementName).toEqual('def');
+    expect(res.replacementVersion).toEqual('2.0.0');
+  });
 });

lib/datasource/index.ts

@@ -28,6 +28,20 @@ function load(datasource: string): Promise<Datasource> {
 
 type GetReleasesInternalConfig = GetReleasesConfig & GetPkgReleasesConfig;
 
+function applyReplacements(
+  dep: ReleaseResult,
+  config: GetReleasesInternalConfig
+): ReleaseResult {
+  if (config.replacementName && config.replacementVersion) {
+    return {
+      ...dep,
+      replacementName: config.replacementName,
+      replacementVersion: config.replacementVersion,
+    };
+  }
+  return dep;
+}
+
 function resolveRegistryUrls(
   datasource: Datasource,
   extractedUrls: string[]
@@ -53,7 +67,7 @@ async function fetchReleases(
     registryUrls,
   });
   addMetaData(dep, datasourceName, config.lookupName);
-  return dep;
+  return applyReplacements(dep, config);
 }
 
 function getRawReleases(

lib/manager/common.ts

@@ -174,6 +174,7 @@ export interface Upgrade<T = Record<string, any>>
   newDigest?: string;
   newFrom?: string;
   newMajor?: number;
+  newName?: string;
   newValue?: string;
   newVersion?: string;
   packageFile?: string;

lib/manager/npm/index.ts

@@ -14,6 +14,6 @@ export const defaultConfig = {
   versioning: npmVersioning.id,
   prBodyDefinitions: {
     Change:
-      "[{{#if displayFrom}}`{{{displayFrom}}}` -> {{else}}{{#if currentValue}}`{{{currentValue}}}` -> {{/if}}{{/if}}{{#if displayTo}}`{{{displayTo}}}`{{else}}`{{{newValue}}}`{{/if}}](https://renovatebot.com/diffs/npm/{{replace '/' '%2f' depName}}/{{{fromVersion}}}/{{{toVersion}}})",
+      "{{#if isReplacement}}{{newName}}{{else}}[{{#if displayFrom}}`{{{displayFrom}}}` -> {{else}}{{#if currentValue}}`{{{currentValue}}}` -> {{/if}}{{/if}}{{#if displayTo}}`{{{displayTo}}}`{{else}}`{{{newValue}}}`{{/if}}](https://renovatebot.com/diffs/npm/{{replace '/' '%2f' depName}}/{{{fromVersion}}}/{{{toVersion}}}){{/if}}",
   },
 };

lib/manager/npm/update.spec.ts

@@ -198,6 +198,32 @@ describe('workers/branch/package-json', () => {
       });
       expect(testContent).toBeNull();
     });
+    it('returns null file empty', () => {
+      const upgrade = {
+        depType: 'blah',
+        depName: 'angular-touch-not',
+        newValue: '1.5.8',
+      };
+      const testContent = npmUpdater.updateDependency({
+        fileContent: input01Content,
+        upgrade,
+      });
+      expect(testContent).toBeNull();
+    });
+    it('replaces package', () => {
+      const upgrade = {
+        depType: 'dependencies',
+        depName: 'config',
+        newName: 'abc',
+        newValue: '2.0.0',
+      };
+      const testContent = npmUpdater.updateDependency({
+        fileContent: input01Content,
+        upgrade,
+      });
+      expect(JSON.parse(testContent).dependencies.config).toBeUndefined();
+      expect(JSON.parse(testContent).dependencies.abc).toEqual('2.0.0');
+    });
   });
   describe('.bumpPackageVersion()', () => {
     const content = JSON.stringify({