ready

Author: Iurii Golovinskii

src/strategies/export-rest-document.strategy.ts

@@ -46,7 +46,7 @@ export class ExportRestDocumentStrategy implements BuilderStrategy {
     const { name: packageName } = await packageResolver(packageId)
     buildResult.exportDocuments.push(await createRestExportDocument(file.name, await file.text(), format, packageName, version, templateResolver, allowedOasExtensions, generatedHtmlExportDocuments))
     if (format === FILE_FORMAT_HTML) {
-      buildResult.exportDocuments.push(...await createCommonStaticExportDocuments(packageName, version, templateResolver, buildResult.exportDocuments[0].filename))
+      buildResult.exportDocuments.push(...await createCommonStaticExportDocuments(packageName, version, templateResolver))
       buildResult.exportDocuments.push(createUnknownExportDocument('index.html', await generateIndexHtmlPage(packageName, version, generatedHtmlExportDocuments, templateResolver)))
       buildResult.exportFileName = createSingleFileExportName(packageId, version, getDocumentTitle(file.name), 'zip')
       return buildResult

src/strategies/export-rest-operations-group.strategy.ts

@@ -78,7 +78,7 @@ async function exportMergedDocument(config: ExportRestOperationsGroupBuildConfig
   buildResult.exportDocuments.push(await createRestExportDocument(buildResult.merged.filename, JSON.stringify(buildResult.merged?.data), format, packageName, version, templateResolver, allowedOasExtensions))
 
   if (format === FILE_FORMAT_HTML) {
-    buildResult.exportDocuments.push(...await createCommonStaticExportDocuments(packageName, version, templateResolver, buildResult.exportDocuments[0].filename))
+    buildResult.exportDocuments.push(...await createCommonStaticExportDocuments(packageName, version, templateResolver))
   }
 }
 
@@ -107,8 +107,7 @@ async function exportReducedDocuments(config: ExportRestOperationsGroupBuildConf
   buildResult.exportDocuments.push(...transformedDocuments)
 
   if (format === FILE_FORMAT_HTML) {
-    const shouldAddIndexPage = generatedHtmlExportDocuments.length > 1
-    buildResult.exportDocuments.push(...await createCommonStaticExportDocuments(packageName, version, templateResolver, shouldAddIndexPage ? 'index.html' : buildResult.exportDocuments[0].filename))
+    buildResult.exportDocuments.push(...await createCommonStaticExportDocuments(packageName, version, templateResolver))
 
     buildResult.exportDocuments.push(createUnknownExportDocument('index.html', await generateIndexHtmlPage(packageName, version, generatedHtmlExportDocuments, templateResolver)))
   }

src/strategies/export-version.strategy.ts

@@ -63,8 +63,7 @@ async function exportToHTML(config: ExportVersionBuildConfig, buildResult: Build
 
   const generatedHtmlExportDocuments: ExportDocument[] = []
   const restDocuments = documents.filter(isRestDocument)
-  const hasReadme = !!documents.find(({ filename }) => filename.toLowerCase() === 'readme.md')
-  const shouldAddIndexPage = hasReadme && restDocuments.length > 0 || restDocuments.length > 1
+  const shouldAddIndexPage = restDocuments.length > 0
   const transformedDocuments = await Promise.all(documents.map(async document => {
     const { createExportDocument } = apiBuilders.find(({ types }) => types.includes(document.type)) || unknownApiBuilder
     const file = await rawDocumentResolver(versionWithRevision, packageId, document.slug)
@@ -74,11 +73,12 @@ async function exportToHTML(config: ExportVersionBuildConfig, buildResult: Build
   buildResult.exportDocuments.push(...transformedDocuments)
 
   if (generatedHtmlExportDocuments.length > 0) {
-    buildResult.exportDocuments.push(...await createCommonStaticExportDocuments(packageName, version, templateResolver, shouldAddIndexPage ? 'index.html' : buildResult.exportDocuments[0].filename))
+    buildResult.exportDocuments.push(...await createCommonStaticExportDocuments(packageName, version, templateResolver))
+  }
+  if (shouldAddIndexPage) {
+    const readme = await buildResult.exportDocuments.find(({ filename }) => filename.toLowerCase() === 'readme.md')?.data.text()
+    buildResult.exportDocuments.push(createUnknownExportDocument('index.html', await generateIndexHtmlPage(packageName, version, generatedHtmlExportDocuments, templateResolver, readme)))
   }
-
-  const readme = await buildResult.exportDocuments.find(({ filename }) => filename.toLowerCase() === 'readme.md')?.data.text()
-  buildResult.exportDocuments.push(createUnknownExportDocument('index.html', await generateIndexHtmlPage(packageName, version, generatedHtmlExportDocuments, templateResolver, readme)))
 }
 
 async function defaultExport(config: ExportVersionBuildConfig, buildResult: BuildResult, contexts: BuildTypeContexts): Promise<void> {

src/utils/export.ts

@@ -16,9 +16,9 @@
 import { _TemplateResolver, ExportDocument } from '../types'
 import { getDocumentTitle } from './document'
 
-export async function createCommonStaticExportDocuments(packageName: string, version: string, templateResolver: _TemplateResolver, backLinkFilename: string): Promise<ExportDocument[]> {
+export async function createCommonStaticExportDocuments(packageName: string, version: string, templateResolver: _TemplateResolver): Promise<ExportDocument[]> {
   return [
-    createUnknownExportDocument('ls.html', await generateLegalStatementPage(packageName, version, await templateResolver('ls.html'), backLinkFilename)),
+    createUnknownExportDocument('ls.html', await generateLegalStatementPage(packageName, version, await templateResolver('ls.html'), 'index.html')),
     createUnknownExportDocument('resources/corporatelogo.png', await templateResolver('resources/corporatelogo.png')),
     createUnknownExportDocument('resources/styles.css', await templateResolver('resources/styles.css')),
   ]

test/export.test.ts

@@ -269,7 +269,6 @@ describe('Export test', () => {
     })
     expect(result.exportFileName).toEqual('export_no-documents-version.zip')
     expect(result).toEqual(exportDocumentsMatcher([
-      exportDocumentMatcher('index.html'),
       exportDocumentMatcher('Document.docx'),
       exportDocumentMatcher('README.md'),
       exportDocumentMatcher('Test.png'),