/
index.ts
293 lines (287 loc) · 8.92 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
import is from '@sindresorhus/is';
import { CONFIG_VALIDATION } from '../../constants/error-messages';
import { logger } from '../../logger';
import { ExternalHostError } from '../../types/errors/external-host-error';
import { regEx } from '../../util/regex';
import { RenovateConfig } from '../common';
import * as massage from '../massage';
import * as migration from '../migration';
import { mergeChildConfig } from '../utils';
import { PresetApi } from './common';
import * as github from './github';
import * as gitlab from './gitlab';
import * as internal from './internal';
import * as local from './local';
import * as npm from './npm';
const presetSources: Record<string, PresetApi> = {
github,
npm,
gitlab,
local,
internal,
};
export function replaceArgs(
obj: string | string[] | object | object[],
argMapping: Record<string, any>
): any {
if (is.string(obj)) {
let returnStr = obj;
for (const [arg, argVal] of Object.entries(argMapping)) {
const re = regEx(`{{${arg}}}`, 'g');
returnStr = returnStr.replace(re, argVal);
}
return returnStr;
}
if (is.array(obj)) {
const returnArray = [];
for (const item of obj) {
returnArray.push(replaceArgs(item, argMapping));
}
return returnArray;
}
if (is.object(obj)) {
const returnObj = {};
for (const [key, val] of Object.entries(obj)) {
returnObj[key] = replaceArgs(val, argMapping);
}
return returnObj;
}
return obj;
}
export function parsePreset(input: string): ParsedPreset {
let str = input;
let presetSource: string;
let packageName: string;
let presetName: string;
let params: string[];
if (str.startsWith('github>')) {
presetSource = 'github';
str = str.substring('github>'.length);
} else if (str.startsWith('gitlab>')) {
presetSource = 'gitlab';
str = str.substring('gitlab>'.length);
} else if (str.startsWith('local>')) {
presetSource = 'local';
str = str.substring('local>'.length);
} else if (
!str.startsWith('@') &&
!str.startsWith(':') &&
str.includes('/')
) {
presetSource = 'local';
}
str = str.replace(/^npm>/, '');
presetSource = presetSource || 'npm';
if (str.includes('(')) {
params = str
.slice(str.indexOf('(') + 1, -1)
.split(',')
.map((elem) => elem.trim());
str = str.slice(0, str.indexOf('('));
}
const presetsPackages = [
'config',
'default',
'docker',
'group',
'helpers',
'monorepo',
'packages',
'preview',
'schedule',
];
if (
presetsPackages.some((presetPackage) => str.startsWith(`${presetPackage}:`))
) {
presetSource = 'internal';
[packageName, presetName] = str.split(':');
} else if (str.startsWith(':')) {
// default namespace
presetSource = 'internal';
packageName = 'default';
presetName = str.slice(1);
} else if (str.startsWith('@')) {
// scoped namespace
[, packageName] = /(@.*?)(:|$)/.exec(str);
str = str.slice(packageName.length);
if (!packageName.includes('/')) {
packageName += '/renovate-config';
}
if (str === '') {
presetName = 'default';
} else {
presetName = str.slice(1);
}
} else {
// non-scoped namespace
[, packageName] = /(.*?)(:|$)/.exec(str);
presetName = str.slice(packageName.length + 1);
if (presetSource === 'npm' && !packageName.startsWith('renovate-config-')) {
packageName = `renovate-config-${packageName}`;
}
if (presetName === '') {
presetName = 'default';
}
}
return { presetSource, packageName, presetName, params };
}
export async function getPreset(
preset: string,
baseConfig?: RenovateConfig
): Promise<RenovateConfig> {
logger.trace(`getPreset(${preset})`);
const { presetSource, packageName, presetName, params } = parsePreset(preset);
let presetConfig = await presetSources[presetSource].getPreset({
packageName,
presetName,
baseConfig,
});
logger.trace({ presetConfig }, `Found preset ${preset}`);
if (params) {
const argMapping = {};
for (const [index, value] of params.entries()) {
argMapping[`arg${index}`] = value;
}
presetConfig = replaceArgs(presetConfig, argMapping);
}
logger.trace({ presetConfig }, `Applied params to preset ${preset}`);
const presetKeys = Object.keys(presetConfig);
// istanbul ignore if
if (
presetKeys.length === 2 &&
presetKeys.includes('description') &&
presetKeys.includes('extends')
) {
// preset is just a collection of other presets
delete presetConfig.description;
}
const packageListKeys = [
'description',
'packageNames',
'excludePackageNames',
'packagePatterns',
'excludePackagePatterns',
];
if (presetKeys.every((key) => packageListKeys.includes(key))) {
delete presetConfig.description;
}
const { migratedConfig } = migration.migrateConfig(presetConfig);
return massage.massageConfig(migratedConfig);
}
export async function resolveConfigPresets(
inputConfig: RenovateConfig,
baseConfig?: RenovateConfig,
ignorePresets?: string[],
existingPresets: string[] = []
): Promise<RenovateConfig> {
if (!ignorePresets || ignorePresets.length === 0) {
ignorePresets = inputConfig.ignorePresets || []; // eslint-disable-line
}
logger.trace(
{ config: inputConfig, existingPresets },
'resolveConfigPresets'
);
let config: RenovateConfig = {};
// First, merge all the preset configs from left to right
if (inputConfig.extends && inputConfig.extends.length) {
for (const preset of inputConfig.extends) {
// istanbul ignore if
if (existingPresets.includes(preset)) {
logger.debug(`Already seen preset ${preset} in ${existingPresets}`);
} else if (ignorePresets.includes(preset)) {
// istanbul ignore next
logger.debug(`Ignoring preset ${preset} in ${existingPresets}`);
} else {
logger.trace(`Resolving preset "${preset}"`);
let fetchedPreset: RenovateConfig;
try {
fetchedPreset = await getPreset(preset, baseConfig);
} catch (err) {
logger.debug({ preset, err }, 'Preset fetch error');
// istanbul ignore if
if (err instanceof ExternalHostError) {
throw err;
}
const error = new Error(CONFIG_VALIDATION);
if (err.message === 'dep not found') {
error.validationError = `Cannot find preset's package (${preset})`;
} else if (err.message === 'preset renovate-config not found') {
error.validationError = `Preset package is missing a renovate-config entry (${preset})`;
} else if (err.message === 'preset not found') {
error.validationError = `Preset name not found within published preset config (${preset})`;
}
// istanbul ignore if
if (existingPresets.length) {
error.validationError +=
'. Note: this is a *nested* preset so please contact the preset author if you are unable to fix it yourself.';
}
logger.info(
{ validationError: error.validationError },
'Throwing preset error'
);
throw error;
}
const presetConfig = await resolveConfigPresets(
fetchedPreset,
baseConfig,
ignorePresets,
existingPresets.concat([preset])
);
// istanbul ignore if
if (
inputConfig &&
inputConfig.ignoreDeps &&
inputConfig.ignoreDeps.length === 0
) {
delete presetConfig.description;
}
config = mergeChildConfig(config, presetConfig);
}
}
}
logger.trace({ config }, `Post-preset resolve config`);
// Now assign "regular" config on top
config = mergeChildConfig(config, inputConfig);
delete config.extends;
delete config.ignorePresets;
logger.trace({ config }, `Post-merge resolve config`);
for (const [key, val] of Object.entries(config)) {
const ignoredKeys = ['content', 'onboardingConfig'];
if (is.array(val)) {
// Resolve nested objects inside arrays
config[key] = [];
for (const element of val) {
if (is.object(element)) {
(config[key] as RenovateConfig[]).push(
await resolveConfigPresets(
element as RenovateConfig,
baseConfig,
ignorePresets,
existingPresets
)
);
} else {
(config[key] as RenovateConfig[]).push(element);
}
}
} else if (is.object(val) && !ignoredKeys.includes(key)) {
// Resolve nested objects
logger.trace(`Resolving object "${key}"`);
config[key] = await resolveConfigPresets(
val as RenovateConfig,
baseConfig,
ignorePresets,
existingPresets
);
}
}
logger.trace({ config: inputConfig }, 'Input config');
logger.trace({ config }, 'Resolved config');
return config;
}
export interface ParsedPreset {
presetSource: string;
packageName: string;
presetName: string;
params?: string[];
}