Skip to content

Commit 50511f4

Browse files
Update documentation - auto generate "extensions" section (#172)
* Update documentation - auto generate "extensions" section * address comment * update sub header * nit
1 parent 9b0f84a commit 50511f4

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

src/generateDocs.ts

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ const FEATURES_README_TEMPLATE = `
1717
\`\`\`
1818
1919
#{OptionsTable}
20-
20+
#{Customizations}
2121
#{Notes}
2222
2323
---
@@ -137,6 +137,14 @@ async function _generateDocumentation(basePath: string, readmeTemplate: string,
137137
}
138138
}
139139

140+
let extensions = '';
141+
if (parsedJson?.customizations?.vscode?.extensions) {
142+
const extensionsList = parsedJson.customizations.vscode.extensions;
143+
if (extensionsList && extensionsList.length > 0) {
144+
extensions = '\n## Customizations\n\n### VS Code Extensions\n\n' + extensionsList.map((ext: string) => `- \`${ext}\``).join('\n') +'\n';
145+
}
146+
}
147+
140148
let newReadme = readmeTemplate
141149
// Templates & Features
142150
.replace('#{Id}', parsedJson.id)
@@ -148,7 +156,8 @@ async function _generateDocumentation(basePath: string, readmeTemplate: string,
148156
// Features Only
149157
.replace('#{Registry}', ociRegistry)
150158
.replace('#{Namespace}', namespace)
151-
.replace('#{Version}', version);
159+
.replace('#{Version}', version)
160+
.replace('#{Customizations}', extensions);
152161

153162
if (header) {
154163
newReadme = header + newReadme;

0 commit comments

Comments
 (0)