feat(dgeni,docs-utils): centralize paths for different doc kinds (#2950)

graycoreio · Aug 1, 2024 · d907c13 · d907c13
1 parent c02a02e
commit d907c13
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 19 deletions.
diff --git a/libs/docs-utils/src/kind/enum.ts b/libs/docs-utils/src/kind/enum.ts
@@ -0,0 +1,6 @@
+export enum DaffDocKind {
+  GUIDE = 'GUIDE',
+  EXPLANATION = 'EXPLANATION',
+  PACKAGE = 'PACKAGE',
+  API = 'API',
+}
diff --git a/libs/docs-utils/src/kind/path-segment-map.ts b/libs/docs-utils/src/kind/path-segment-map.ts
@@ -0,0 +1,8 @@
+import { DaffDocKind } from './enum';
+
+export const DAFF_DOC_KIND_PATH_SEGMENT_MAP = <const>{
+  [DaffDocKind.GUIDE]: 'guides',
+  [DaffDocKind.EXPLANATION]: 'explanations',
+  [DaffDocKind.PACKAGE]: 'packages',
+  [DaffDocKind.API]: 'api',
+};
diff --git a/libs/docs-utils/src/kind/public_api.ts b/libs/docs-utils/src/kind/public_api.ts
@@ -0,0 +1,2 @@
+export * from './enum';
+export * from './path-segment-map';
diff --git a/libs/docs-utils/src/public_api.ts b/libs/docs-utils/src/public_api.ts
@@ -1 +1,2 @@
 export { crossOsFilename } from './cross-os-filename';
+export * from './kind/public_api';
diff --git a/tools/dgeni/src/processors/markdown.ts b/tools/dgeni/src/processors/markdown.ts
@@ -12,6 +12,11 @@ import { slugify } from 'markdown-toc';
 import { marked } from 'marked';
 import { markedHighlight } from 'marked-highlight';
 
+import {
+  DAFF_DOC_KIND_PATH_SEGMENT_MAP,
+  DaffDocKind,
+} from '@daffodil/docs-utils';
+
 hljs.registerLanguage('typescript', typescript);
 hljs.registerLanguage('ts', typescript);
 hljs.registerLanguage('xml', xml);
@@ -20,17 +25,11 @@ hljs.registerLanguage('bash', bash);
 hljs.registerLanguage('graphql', graphql);
 hljs.registerLanguage('gql', graphql);
 
-enum DocKind {
-  GUIDE = 'GUIDE',
-  EXPLANATION = 'EXPLANATION',
-  PACKAGE = 'PACKAGE',
-  API = 'API',
-}
 const DOC_KIND_REGEX = {
-  [DocKind.GUIDE]: /\/docs\/guides\/(?<path>.+)\.md/,
-  [DocKind.EXPLANATION]: /\/docs\/explanations\/(?<path>.+)\.md/,
-  [DocKind.PACKAGE]: /\/libs\/(?<path>.+)\.md/,
-  [DocKind.API]: /\/libs\/(?<path>.+)\.ts/,
+  [DaffDocKind.GUIDE]: /\/docs\/guides\/(?<path>.+)\.md/,
+  [DaffDocKind.EXPLANATION]: /\/docs\/explanations\/(?<path>.+)\.md/,
+  [DaffDocKind.PACKAGE]: /\/libs\/(?<path>.+)\.md/,
+  [DaffDocKind.API]: /\/libs\/(?<path>.+)\.ts/,
 };
 const getLinkUrl = (path: string): string => {
   const kind = (<Array<keyof typeof DOC_KIND_REGEX>>Object.keys(DOC_KIND_REGEX)).find((k) => DOC_KIND_REGEX[k].test(path));
@@ -41,18 +40,14 @@ const getLinkUrl = (path: string): string => {
   }
 
   switch (kind) {
-    case DocKind.GUIDE:
-      return `/docs/guides/${match.groups.path}`;
+    case DaffDocKind.GUIDE:
+    case DaffDocKind.EXPLANATION:
+    case DaffDocKind.API:
+      return `/docs/${DAFF_DOC_KIND_PATH_SEGMENT_MAP[kind]}/${match.groups.path}`;
 
-    case DocKind.EXPLANATION:
-      return `/docs/explanations/${match.groups.path}`;
-
-    case DocKind.PACKAGE:
+    case DaffDocKind.PACKAGE:
       return `/docs/packages/${match.groups.path}`.replaceAll(/\/(?:readme|src|guides)/gi, '');
 
-    case DocKind.API:
-      return `/docs/api/${match.groups.path}`;
-
     default:
       return path;
   }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		export * from './enum';
		export * from './path-segment-map';
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		export { crossOsFilename } from './cross-os-filename';
		export * from './kind/public_api';