Skip to content

Commit

Permalink
docs(presets): add edit_url in meta of preset pages (#25582)
Browse files Browse the repository at this point in the history
  • Loading branch information
RahulGautamSingh committed Nov 7, 2023
1 parent b2b99b4 commit ec8efcb
Showing 1 changed file with 24 additions and 4 deletions.
28 changes: 24 additions & 4 deletions tools/docs/presets.ts
Expand Up @@ -6,18 +6,38 @@ function jsUcfirst(string: string): string {
return string.charAt(0).toUpperCase() + string.slice(1);
}

function getEditUrl(name: string): string {
const url =
'https://github.com/renovatebot/renovate/edit/main/lib/config/presets/internal/';

switch (name) {
case 'regexManagers':
return `${url}regex-managers.ts`;
case 'mergeConfidence':
return `${url}merge-confidence.ts`;
default:
return `${url}${name}.ts`;
}
}

/**
* @param {string} name
* @param {string} presetTitle
* @param {number} order
* @param {string} presetName
*/
function generateFrontMatter(name: string, order: number): string {
function generateFrontMatter(
presetTitle: string,
order: number,
presetName: string
): string {
return `---
date: 2017-12-07
title: ${name} Presets
title: ${presetTitle} Presets
categories:
- config-presets
type: Document
order: ${order}
edit_url: ${getEditUrl(presetName)}
---
`;
}
Expand All @@ -30,7 +50,7 @@ export async function generatePresets(dist: string): Promise<void> {
.replace('Js', 'JS')
.replace(/s$/, '')
.replace(/^Config$/, 'Full Config');
const frontMatter = generateFrontMatter(formattedName, index);
const frontMatter = generateFrontMatter(formattedName, index, name);
let content = `\n`;
for (const [preset, value] of Object.entries(presetConfig)) {
let header = `\n### ${name === 'default' ? '' : name}:${preset}`;
Expand Down

0 comments on commit ec8efcb

Please sign in to comment.