Rename config:base -> config:recommended

[HonkingGoose]

What would you like Renovate to be able to do?

Quote from @rarkins ¹

BTW I was already thinking that config:base is somewhat misnamed. Even though we try not to keep it too opinionated, it still is. I had been thinking to rename it to config:recommended soon, so people understand from the name it's subjective/opinionated.

If you have any ideas on how this should be implemented, please tell us here.

• Change config:base to config:recommended in code.
• Change config:base to config:recommended in our presets.
• Write migration code.
• Change references to config:base -> config:recommended in documentation.

Is this a feature you are interested in implementing yourself?

No

Footnotes

1. Source of quote ↩

[rarkins]

I'd like to hear others' opinions. FYI this doesn't need to be breaking because we can migrate existing, but still probably best to do it in a major release.

[viceice]

I link it, and yes let's do it on major bump to have more visibility.

[olegkrivtsov]

I'd like to help with this one.

[olegkrivtsov]

My plan for fixing this issue is the following (copying the idea suggested in the issue description):

1. Change config:base to config:recommended in code.
2. Change config:base to config:recommended in our presets.
3. Write migration code.
4. Change references to config:base -> config:recommended in documentation.

Currently the following occurrencies seem to exist in the code:

$ grep -rnw './lib' -e 'config:base'
./lib/config/presets/internal/config.ts:20:    extends: ['config:base', ':pinAllExceptPeerDependencies'],
./lib/config/presets/internal/config.ts:24:    extends: ['config:base', ':pinOnlyDevDependencies'],
./lib/config/presets/index.spec.ts:237:      config.extends = ['config:base'];
./lib/config/presets/index.spec.ts:239:        'config:base',
./lib/config/presets/common.ts:4:  ':base': 'config:base',
./lib/config/presets/common.ts:14:  'config:base-js': 'config:base',
./lib/config/presets/common.ts:18:  'default:base': 'config:base',
./lib/workers/global/config/parse/file.spec.ts:64:          "extends": ["config:base"],
./lib/workers/global/config/parse/cli.ts:99:      `    $ renovate singapore/lint-condo --onboarding-config='{"extends":["config:base"]}'`
./lib/workers/global/config/parse/cli.spec.ts:132:      argv.push(`--onboarding-config={"extends": ["config:base"]}`);
./lib/workers/global/config/parse/cli.spec.ts:135:          extends: ['config:base'],

The following occurrencies exist in docs:

$ grep -rnw './docs' -e 'config:base'
./docs/development/creating-editing-renovate-presets.md:30:1. They don't need to be added to `group:recommended`, meaning that users will "opt in" to them one by one and not get them automatically from `config:base`, which includes `group:monorepo` and `group:recommended`
./docs/usage/config-presets.md:105:An example of a full config is `config:base`, which is Renovate's default configuration.
./docs/usage/config-presets.md:115:By default, the Renovate App's onboarding process will suggest `["config:base]"`.
./docs/usage/config-presets.md:116:If you are self hosting you must add `"onboardingConfig": { "extends": ["config:base"] }` to your bot's config.
./docs/usage/config-presets.md:122:  "extends": ["config:base"]
./docs/usage/config-presets.md:131:  "extends": ["config:base", "schedule:nonOfficeHours"]
./docs/usage/config-presets.md:276:      "extends": ["config:base", "schedule:nonOfficeHours"]
./docs/usage/examples/self-hosting.md:241:    extends: ['config:base'],
./docs/usage/docker.md:150:  "extends": ["config:base"],
./docs/usage/key-concepts/dashboard.md:26:  "extends": ["config:base", ":dependencyDashboard"]
./docs/usage/key-concepts/dashboard.md:44:  "extends": ["config:base", ":disableDependencyDashboard"]
./docs/usage/key-concepts/dashboard.md:89:  "extends": ["config:base", ":dependencyDashboardApproval"]
./docs/usage/getting-started/installing-onboarding.md:98:- **rangeStrategy**: By default (with zero config) it's `"replace"` however the `"config:base"` preset overrides it to `"auto"`. If you don't want to pin dependency versions and retain ranges, add the `":preserveSemverRanges"` preset to the `extends` array
./docs/usage/getting-started/use-cases.md:131:Renovate also includes over 100 built-in presets, including the default recommended `config:base` preset.
./docs/usage/configuration-options.md:260:The `config:base` preset that many extend from limits the amount of concurrent branches to 10, but in many cases a limit as low as 3 or 5 can be most efficient for a repository.
./docs/usage/configuration-options.md:484:Starting from version `v26.0.0` the "Dependency Dashboard" is enabled by default as part of the commonly-used `config:base` preset.
./docs/usage/configuration-options.md:490:  "extends": ["config:base", ":disableDependencyDashboard"]
./docs/usage/configuration-options.md:1170:Useful to know: Renovate's default ignore is `node_modules` and `bower_components` only, however if you are extending the popular `config:base` preset then it adds ignore patterns for `vendor`, `examples`, `test(s)` and `fixtures` directories too.
./docs/usage/configuration-options.md:1191:  "extends": ["config:base"],
./docs/usage/configuration-options.md:1196:It would take the entire `"config:base"` preset - which contains a lot of sub-presets - but ignore the `":prHourlyLimit2"` rule.
./docs/usage/modules/manager.md:55:The `config:base` preset ignores common test and example directory names, for example.
./docs/usage/semantic-commits.md:19:When you extend `config:base`, Renovate still defaults to `chore`, but will use the `fix` prefix for npm production dependencies (`devDependencies` still use `chore`).

[rarkins]

Also add a hardcoded fallback redirect within the presets lookup in case there's any config:base strings which are missed in migrating somehow

[viceice]

I think :base is also a valid preset and needs to be migrated. 🤔

[rarkins]

Is there a default:base?

[HonkingGoose]

Is there a default:base?

It looks like we once had a default:base preset, but we renamed it to config:base. See line 18:

renovate/lib/config/presets/common.ts

Lines 1 to 25 in 2b58214

	export const removedPresets: Record<string, string | null> = {
	':automergeBranchMergeCommit': ':automergeBranch',
	':automergeBranchPush': ':automergeBranch',
	':base': 'config:base',
	':app': 'config:js-app',
	':enableGradleLite': null,
	':js-app': 'config:js-app',
	':library': 'config:js-lib',
	':masterIssue': ':dependencyDashboard',
	':masterIssueApproval': ':dependencyDashboardApproval',
	':switchToGradleLite': null,
	':unpublishSafe': 'npm:unpublishSafe',
	'config:application': 'config:js-app',
	'config:base-js': 'config:base',
	'config:library': 'config:js-lib',
	'default:automergeBranchMergeCommit': ':automergeBranch',
	'default:automergeBranchPush': ':automergeBranch',
	'default:base': 'config:base',
	'default:app': 'config:js-app',
	'default:js-app': 'config:js-app',
	'default:library': 'config:js-lib',
	'default:unpublishSafe': 'npm:unpublishSafe',
	'helpers:oddIsUnstable': null,
	'helpers:oddIsUnstablePackages': null,
	};

---

Our docs say: ¹

The :xyz naming convention (with : prefix) is a special shorthand for the default: presets.
e.g. :xyz is equivalent to default:xyz.

Is this still correct? It sounds like maybe we have renamed all default: to config:. What do you think?

Footnotes

1. Renovate docs, config presets, example configs ↩

[rarkins]

I had forgotten but yes your analysis looks correct

[viceice]

Should be pretty easy to do.

1. rename preset
2. add to renamed preset list
3. update old migrations below

renovate/lib/config/presets/common.ts

Line 6 in 2a17275

':base': 'config:base',

renovate/lib/config/presets/common.ts

Line 20 in 2a17275

'default:base': 'config:base',

[renovate-release]

🎉 This issue has been resolved in version 36.0.0 🎉

The release is available on:

• GitHub release
• 36.0.0

Your semantic-release bot 📦🚀