From 45f75df456a5d946a3c9887265965c845d5d2514 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Fri, 8 Oct 2021 11:43:51 +0000 Subject: [PATCH] fix(config): improve descriptions for default presets --- lib/config/presets/internal/default.ts | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/lib/config/presets/internal/default.ts b/lib/config/presets/internal/default.ts index 40fbcd749d194a..f72a630814c235 100644 --- a/lib/config/presets/internal/default.ts +++ b/lib/config/presets/internal/default.ts @@ -2,11 +2,11 @@ import type { Preset } from '../types'; export const presets: Record = { enableRenovate: { - description: 'Enable renovate', + description: 'Enable Renovate', enabled: true, }, disableRenovate: { - description: 'Disable renovate', + description: 'Disable Renovate', enabled: false, }, disableMajorUpdates: { @@ -60,12 +60,12 @@ export const presets: Record = { }, pinVersions: { description: - 'Use version pinning (maintain a single version only and not semver ranges)', + 'Use version pinning (maintain a single version only and not SemVer ranges)', rangeStrategy: 'pin', }, preserveSemverRanges: { description: - 'Preserve (but continue to upgrade) any existing semver ranges', + 'Preserve (but continue to upgrade) any existing SemVer ranges', rangeStrategy: 'replace', }, pinAllExceptPeerDependencies: { @@ -102,7 +102,7 @@ export const presets: Record = { }, pinOnlyDevDependencies: { description: - 'Pin dependency versions for devDependencies and retain semver ranges for others', + 'Pin dependency versions for devDependencies and retain SemVer ranges for others', packageRules: [ { matchPackagePatterns: ['*'], @@ -182,7 +182,7 @@ export const presets: Record = { ], }, disableDigestUpdates: { - description: 'Disable digest and git hash updates', + description: 'Disable digest and Git hash updates', digest: { enabled: false, }, @@ -242,11 +242,11 @@ export const presets: Record = { prHourlyLimit: 4, }, prConcurrentLimitNone: { - description: 'Remove limit for open PRs', + description: 'Remove limit for open PRs at any time', prConcurrentLimit: 0, }, prConcurrentLimit10: { - description: 'Limit to maximum 10 open PRs', + description: 'Limit to maximum 10 open PRs at any time', prConcurrentLimit: 10, }, prConcurrentLimit20: { @@ -330,7 +330,7 @@ export const presets: Record = { }, }, pinDigestsDisabled: { - description: 'Disable pinning of docker dependency digests', + description: 'Disable pinning of Docker dependency digests', pinDigests: false, }, maintainLockFilesWeekly: { @@ -408,11 +408,12 @@ export const presets: Record = { }, }, gitSignOff: { - description: 'Append git Signed-off-by signature to git commits.', + description: + 'Append Git Signed-off-by: signature to Git commits.', commitBody: 'Signed-off-by: {{{gitAuthor}}}', }, npm: { - description: 'Keep package.json npm dependencies updated', + description: 'Keep package.json npm dependencies updated', npm: { enabled: true, }, @@ -517,7 +518,7 @@ export const presets: Record = { }, widenPeerDependencies: { description: - 'Always widen peerDependencies semver ranges when updating, instead of replacing', + 'Always widen peerDependencies SemVer ranges when updating, instead of replacing', packageRules: [ { matchDepTypes: ['peerDependencies'],