feat(dgeni,daffio): guides-list.json -> index.json (#2881)

graycoreio · Jun 16, 2024 · bea169f · bea169f
1 parent 7659261
commit bea169f
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 15 deletions.
diff --git a/apps/daffio/src/app/docs/services/docs.service.spec.ts b/apps/daffio/src/app/docs/services/docs.service.spec.ts
@@ -53,7 +53,7 @@ describe('DaffioDocsService', () => {
 
     service.getPackageList().subscribe((guides) => {
       expect(guides).toEqual(mockGuideList);
-      expect(fetchAssetServiceSpy.fetch).toHaveBeenCalledWith('/assets/daffio/docs/packages/guide-list.json');
+      expect(fetchAssetServiceSpy.fetch).toHaveBeenCalledWith('/assets/daffio/docs/packages/index.json');
       done();
     });
   });

diff --git a/apps/daffio/src/app/docs/services/docs.service.ts b/apps/daffio/src/app/docs/services/docs.service.ts
@@ -30,10 +30,10 @@ export class DaffioDocsService<T extends DaffioDoc = DaffioDoc, V extends Daffio
   }
 
   getPackageList(): Observable<V> {
-    return this.fetchAsset.fetch<V>(`${this.docsPath}docs/packages/guide-list.json`);
+    return this.fetchAsset.fetch<V>(`${this.docsPath}docs/packages/index.json`);
   }
 
   getGuidesList(): Observable<V> {
-    return this.fetchAsset.fetch<V>(`${this.docsPath}docs/guides/guide-list.json`);
+    return this.fetchAsset.fetch<V>(`${this.docsPath}docs/guides/index.json`);
   }
 }
diff --git a/tools/dgeni/src/transforms/daffodil-guides-package/index.ts b/tools/dgeni/src/transforms/daffodil-guides-package/index.ts
@@ -51,7 +51,7 @@ const base = new Package('daffodil-guides-base', [daffodilBasePackage])
   });
 
 export const packageDocsPackage = new Package('daffodil-package-docs', [base])
-  .processor(new GenerateGuideListProcessor())
+  .processor(new GenerateGuideListProcessor({ outputFolder: 'packages' }))
   .config((readFilesProcessor) => {
     readFilesProcessor.basePath = API_SOURCE_PATH;
     readFilesProcessor.sourceFiles = [

diff --git a/tools/dgeni/src/transforms/daffodil-guides-package/processors/generateGuideList.ts b/tools/dgeni/src/transforms/daffodil-guides-package/processors/generateGuideList.ts
@@ -5,15 +5,10 @@ import {
 
 import { generateNavigationTrieFromDocuments } from '../helpers/navigation-trie';
 
-
 export interface GenerateGuideListConfiguration {
   outputFolder: string;
 };
 
-export const DefaultGenerateGuideListConfiguration: GenerateGuideListConfiguration = {
-  outputFolder: 'packages',
-};
-
 export const transformGuideDoc = (doc: Document): TransformedDocument => ({
   id: doc.id,
   title: doc.title,
@@ -25,11 +20,8 @@ export class GenerateGuideListProcessor implements Processor {
   name = 'generateGuideList';
   $runAfter = ['docs-processed'];
   $runBefore = ['rendering-docs'];
-  config: GenerateGuideListConfiguration;
 
-  constructor(config?: GenerateGuideListConfiguration) {
-    this.config = { ...DefaultGenerateGuideListConfiguration, ...config };
-  }
+  constructor(private config: GenerateGuideListConfiguration) {}
 
   $process(docs: Document[]): Document[] {
     // hardcode design path
@@ -42,8 +34,8 @@ export class GenerateGuideListProcessor implements Processor {
     docs.push({
       docType: 'navigation-list',
       template: 'guide-list.template.json',
-      path: this.config.outputFolder + '/guide-list.json',
-      outputPath: this.config.outputFolder + '/guide-list.json',
+      path: this.config.outputFolder + '/index.json',
+      outputPath: this.config.outputFolder + '/index.json',
       data: generateNavigationTrieFromDocuments(docsWithoutDesignChildren.map(transformGuideDoc)),
     });