feat(dgeni)!: move design examples under design/ subpath

BREAKING CHANGE: design examples have moved from `/docs/design-examples` to `/docs/design/examples` (#2968)
graycoreio · Aug 14, 2024 · 887a515 · 887a515
1 parent 3a3df2a
commit 887a515
Showing 1 changed file with 7 additions and 5 deletions.
diff --git a/tools/dgeni/src/transforms/daffodil-design-examples-package/index.ts b/tools/dgeni/src/transforms/daffodil-design-examples-package/index.ts
@@ -1,7 +1,12 @@
 import { Package } from 'dgeni';
 
 
-import { DAFF_DOCS_PATH } from '@daffodil/docs-utils';
+import {
+  DAFF_DOC_KIND_PATH_SEGMENT_MAP,
+  DAFF_DOCS_DESIGN_PATH,
+  DAFF_DOCS_PATH,
+  DaffDocKind,
+} from '@daffodil/docs-utils';
 
 import { DesignExampleConvertToJsonProcessor } from './processors/convertToJson';
 import { DesignExampleDocumentCreatorProcessor } from './processors/designExampleDocumentCreator';
@@ -16,8 +21,6 @@ import {
 } from '../config';
 import { daffodilBasePackage } from '../daffodil-base-package';
 
-const typescriptPackage = require('dgeni-packages/typescript');
-
 export const designExamplePackage = new Package('daffodil-design-examples', [daffodilBasePackage])
   .factory('designExampleReader', designExampleReaderFactory)
   .processor('convertToJson', (log, createDocMessage) =>  new DesignExampleConvertToJsonProcessor(log, createDocMessage))
@@ -38,11 +41,10 @@ export const designExamplePackage = new Package('daffodil-design-examples', [daf
     convertToJson.docTypes = convertToJson.docTypes.concat(['design-example']);
   })
   .config((computePathsProcessor) => {
-    const DOCS_SEGMENT = 'design-examples';
     computePathsProcessor.pathTemplates.push({
       docTypes: ['design-example'],
       getPath: (doc) => {
-        doc.moduleFolder = `${DAFF_DOCS_PATH}/${DOCS_SEGMENT}/${doc.id}`;
+        doc.moduleFolder = `${DAFF_DOCS_PATH}/${DAFF_DOCS_DESIGN_PATH}/${DAFF_DOC_KIND_PATH_SEGMENT_MAP[DaffDocKind.EXAMPLE]}/${doc.id}`;
         return doc.moduleFolder;
       },
       outputPathTemplate: '${moduleFolder}.json',