Skip to content

Commit

Permalink
fix(config): improve descriptions for default presets
Browse files Browse the repository at this point in the history
  • Loading branch information
HonkingGoose committed Oct 8, 2021
1 parent a9c9aa0 commit 45f75df
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions lib/config/presets/internal/default.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ import type { Preset } from '../types';

export const presets: Record<string, Preset> = {
enableRenovate: {
description: 'Enable renovate',
description: 'Enable Renovate',
enabled: true,
},
disableRenovate: {
description: 'Disable renovate',
description: 'Disable Renovate',
enabled: false,
},
disableMajorUpdates: {
Expand Down Expand Up @@ -60,12 +60,12 @@ export const presets: Record<string, Preset> = {
},
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: {
Expand Down Expand Up @@ -102,7 +102,7 @@ export const presets: Record<string, Preset> = {
},
pinOnlyDevDependencies: {
description:
'Pin dependency versions for <code>devDependencies</code> and retain semver ranges for others',
'Pin dependency versions for <code>devDependencies</code> and retain SemVer ranges for others',
packageRules: [
{
matchPackagePatterns: ['*'],
Expand Down Expand Up @@ -182,7 +182,7 @@ export const presets: Record<string, Preset> = {
],
},
disableDigestUpdates: {
description: 'Disable digest and git hash updates',
description: 'Disable digest and Git hash updates',
digest: {
enabled: false,
},
Expand Down Expand Up @@ -242,11 +242,11 @@ export const presets: Record<string, Preset> = {
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: {
Expand Down Expand Up @@ -330,7 +330,7 @@ export const presets: Record<string, Preset> = {
},
},
pinDigestsDisabled: {
description: 'Disable pinning of docker dependency digests',
description: 'Disable pinning of Docker dependency digests',
pinDigests: false,
},
maintainLockFilesWeekly: {
Expand Down Expand Up @@ -408,11 +408,12 @@ export const presets: Record<string, Preset> = {
},
},
gitSignOff: {
description: 'Append git Signed-off-by signature to git commits.',
description:
'Append Git <code>Signed-off-by:</code> signature to Git commits.',
commitBody: 'Signed-off-by: {{{gitAuthor}}}',
},
npm: {
description: 'Keep package.json npm dependencies updated',
description: 'Keep <code>package.json</code> npm dependencies updated',
npm: {
enabled: true,
},
Expand Down Expand Up @@ -517,7 +518,7 @@ export const presets: Record<string, Preset> = {
},
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'],
Expand Down

0 comments on commit 45f75df

Please sign in to comment.