@cparra/apexdocs 2.21.0 → 2.23.0-beta.0

package/src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts

@@ -3,6 +3,7 @@ import { Type } from '@cparra/apex-reflection';
 import { MarkdownHomeFile } from '../../../model/markdown-home-file';
 import { MarkdownTypeFile } from '../../../model/markdown-type-file';
 import { LinkingStrategy } from '../../processor-type-transpiler';
+import { Settings } from '../../../settings';
 
 export class JekyllDocsProcessor extends MarkdownTranspilerBase {
   homeFileName(): string {
@@ -10,17 +11,39 @@ export class JekyllDocsProcessor extends MarkdownTranspilerBase {
   }
 
   onBeforeProcess = (types: Type[]) => {
-    this._fileContainer.pushFile(new MarkdownHomeFile(this.homeFileName(), types, this.frontMatterHeader));
+    this._fileContainer.pushFile(new MarkdownHomeFile(this.homeFileName(), types, this.frontMatterForHomeFile));
   };
 
   onProcess(type: Type): void {
-    this._fileContainer.pushFile(new MarkdownTypeFile(type, 1, this.frontMatterHeader));
+    this._fileContainer.pushFile(new MarkdownTypeFile(type, 1, this.getFrontMatterHeader(type)));
   }
 
-  get frontMatterHeader(): string {
+  get frontMatterForHomeFile(): string {
     return '---\nlayout: default\n---';
   }
 
+  getFrontMatterHeader(type: Type): string {
+    const headerLines = ['---'];
+    // "layout: default" is a required front matter header for Jekyll
+    headerLines.push('layout: default');
+    // Add any additional front matter headers that might have been configured in the settings
+    const targetType = {
+      name: type.name,
+      typeName: type.type_name,
+      accessModifier: type.access_modifier,
+      group: type.group,
+      description: type.docComment?.description,
+    };
+    const configuredHeaders = Settings.getInstance().frontMatterHeader(targetType);
+    if (configuredHeaders) {
+      configuredHeaders.forEach((header) => {
+        headerLines.push(header);
+      });
+    }
+    headerLines.push('---');
+    return headerLines.join('\n');
+  }
+
   getLinkingStrategy(): LinkingStrategy {
     return 'path-relative';
   }

package/ROADMAP.md

@@ -1,16 +0,0 @@
-[ ] Respect access modifiers where the properties/methods are different from the class declaration. For example,
-AuraEnabled properties do not live in an AuraEnabled class, so there's no way to just generate docs to showcase the
-AuraEnabled properties of a class without some sort of combination of also exposing other public/globals
-
-[ ] Versioning capabilities. When creating the doc you specify a version number, and a new directory is created for the
-files, instead of just overriding
-
-[ ] New generatortype: To JsDocs from AuraEnabled
-
-[ ] More unit tests
-
-[ ] config.js support to allow for injections, home header, etc.
-
-[ ] Add configuration setting that allows someone to set the "namespace"
-
-[ ] Homepage support similar to what docsify does