Skip to content

Commit 6ca2520

Browse files
refactor: deduplicate common function (renovatebot#36641)
1 parent 27d61b3 commit 6ca2520

File tree

7 files changed

+15
-34
lines changed

7 files changed

+15
-34
lines changed

lib/workers/repository/init/apis.ts

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import { configFileNames } from '../../../config/app-strings';
21
import type { RenovateConfig } from '../../../config/types';
32
import {
43
REPOSITORY_DISABLED_BY_CONFIG,
@@ -7,18 +6,13 @@ import {
76
import { logger } from '../../../logger';
87
import type { RepoParams, RepoResult } from '../../../modules/platform';
98
import { platform } from '../../../modules/platform';
9+
import { getDefaultConfigFileName } from '../onboarding/common';
1010

1111
// TODO: fix types (#22198)
1212
export type WorkerPlatformConfig = RepoResult &
1313
RenovateConfig &
1414
Record<string, any>;
1515

16-
// TODO #22198
17-
const getDefaultConfigFile = (config: RenovateConfig): string =>
18-
configFileNames.includes(config.onboardingConfigFileName!)
19-
? config.onboardingConfigFileName!
20-
: configFileNames[0];
21-
2216
async function getJsonFile(file: string): Promise<RenovateConfig | null> {
2317
try {
2418
return await platform.getJsonFile(file);
@@ -31,7 +25,7 @@ async function validateOptimizeForDisabled(
3125
config: RenovateConfig,
3226
): Promise<void> {
3327
if (config.optimizeForDisabled) {
34-
const renovateConfig = await getJsonFile(getDefaultConfigFile(config));
28+
const renovateConfig = await getJsonFile(getDefaultConfigFileName(config));
3529
if (renovateConfig?.enabled === false) {
3630
throw new Error(REPOSITORY_DISABLED_BY_CONFIG);
3731
}
@@ -63,7 +57,7 @@ async function validateOptimizeForDisabled(
6357

6458
async function validateIncludeForks(config: RenovateConfig): Promise<void> {
6559
if (config.forkProcessing !== 'enabled' && config.isFork) {
66-
const defaultConfigFile = getDefaultConfigFile(config);
60+
const defaultConfigFile = getDefaultConfigFileName(config);
6761
const repoConfig = await getJsonFile(defaultConfigFile);
6862
if (!repoConfig) {
6963
logger.debug(

lib/workers/repository/init/merge.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,15 @@ import { maskToken } from '../../../util/mask';
2828
import { regEx } from '../../../util/regex';
2929
import { parseAndValidateOrExit } from '../../global/config/parse/env';
3030
import { getOnboardingConfig } from '../onboarding/branch/config';
31-
import { getDefaultConfigFileName } from '../onboarding/branch/create';
3231
import {
3332
getOnboardingConfigFromCache,
3433
getOnboardingFileNameFromCache,
3534
setOnboardingConfigDetails,
3635
} from '../onboarding/branch/onboarding-branch-cache';
37-
import { OnboardingState } from '../onboarding/common';
36+
import {
37+
OnboardingState,
38+
getDefaultConfigFileName,
39+
} from '../onboarding/common';
3840
import type { RepoFileConfig } from './types';
3941

4042
export async function detectConfigFile(): Promise<string | null> {

lib/workers/repository/onboarding/branch/create.ts

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,12 @@
1-
import { configFileNames } from '../../../../config/app-strings';
21
import { GlobalConfig } from '../../../../config/global';
32
import type { RenovateConfig } from '../../../../config/types';
43
import { logger } from '../../../../logger';
54
import { scm } from '../../../../modules/platform/scm';
65
import { compile } from '../../../../util/template';
6+
import { getDefaultConfigFileName } from '../common';
77
import { OnboardingCommitMessageFactory } from './commit-message';
88
import { getOnboardingConfigContents } from './config';
99

10-
const defaultConfigFile = configFileNames[0];
11-
12-
export function getDefaultConfigFileName(
13-
config: Partial<RenovateConfig>,
14-
): string {
15-
// TODO #22198
16-
return configFileNames.includes(config.onboardingConfigFileName!)
17-
? config.onboardingConfigFileName!
18-
: defaultConfigFile;
19-
}
20-
2110
export async function createOnboardingBranch(
2211
config: Partial<RenovateConfig>,
2312
): Promise<string | null> {

lib/workers/repository/onboarding/branch/rebase.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import type { RenovateConfig } from '../../../../config/types';
33
import { logger } from '../../../../logger';
44
import { scm } from '../../../../modules/platform/scm';
55
import { toSha256 } from '../../../../util/hash';
6-
import { defaultConfigFile } from '../common';
6+
import { getDefaultConfigFileName } from '../common';
77
import { OnboardingCommitMessageFactory } from './commit-message';
88
import { getOnboardingConfigContents } from './config';
99

@@ -22,7 +22,7 @@ export async function rebaseOnboardingBranch(
2222
return null;
2323
}
2424

25-
const configFile = defaultConfigFile(config);
25+
const configFile = getDefaultConfigFileName(config);
2626
const contents = await getOnboardingConfigContents(config, configFile);
2727
const currentConfigHash = toSha256(contents);
2828

lib/workers/repository/onboarding/common.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export function getSemanticCommitPrTitle(config: RenovateConfig): string {
77
return `${config.semanticCommitType ?? 'chore'}: ${config.onboardingPrTitle}`;
88
}
99

10-
export function defaultConfigFile(config: RenovateConfig): string {
10+
export function getDefaultConfigFileName(config: RenovateConfig): string {
1111
return configFileNames.includes(config.onboardingConfigFileName!)
1212
? config.onboardingConfigFileName!
1313
: configFileNames[0];

lib/workers/repository/onboarding/pr/config-description.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
import is from '@sindresorhus/is';
2-
import { configFileNames } from '../../../../config/app-strings';
32
import type { RenovateConfig } from '../../../../config/types';
43
import { logger } from '../../../../logger';
54
import type { PackageFile } from '../../../../modules/manager/types';
65
import { emojify } from '../../../../util/emoji';
7-
8-
const defaultConfigFile = configFileNames[0];
6+
import { getDefaultConfigFileName } from '../common';
97

108
export function getScheduleDesc(config: RenovateConfig): string[] {
119
logger.debug('getScheduleDesc()');
@@ -36,9 +34,7 @@ export function getConfigDesc(
3634
packageFiles?: Record<string, PackageFile[]>,
3735
): string {
3836
// TODO: type (#22198)
39-
const configFile = configFileNames.includes(config.onboardingConfigFileName!)
40-
? config.onboardingConfigFileName!
41-
: defaultConfigFile;
37+
const configFile = getDefaultConfigFileName(config);
4238
logger.debug('getConfigDesc()');
4339
logger.trace({ config });
4440
const descriptionArr = getDescriptionArray(config);

lib/workers/repository/onboarding/pr/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import { addParticipants } from '../../update/pr/participants';
2323
import { isOnboardingBranchConflicted } from '../branch/onboarding-branch-cache';
2424
import {
2525
OnboardingState,
26-
defaultConfigFile,
26+
getDefaultConfigFileName,
2727
getSemanticCommitPrTitle,
2828
} from '../common';
2929
import { getBaseBranchDesc } from './base-branch';
@@ -234,7 +234,7 @@ function getRebaseCheckbox(onboardingRebaseCheckbox?: boolean): string {
234234
async function getOnboardingConfigHashComment(
235235
config: RenovateConfig,
236236
): Promise<string> {
237-
const configFile = defaultConfigFile(config);
237+
const configFile = getDefaultConfigFileName(config);
238238
const existingContents =
239239
(await getFile(configFile, config.onboardingBranch)) ?? '';
240240
const hash = toSha256(existingContents);

0 commit comments

Comments
 (0)