Add metadata args to macro function calls

This adds source type, name, and file path as arguments to macro functions,
allowing macros to customize their output based on the current source file.

Author: cesarParra

src/core/markdown/generate-docs.ts

@@ -47,24 +47,6 @@ export type MarkdownGeneratorConfig = Omit<
   referenceGuideTemplate: string;
 };
 
-function replaceMacros(
-  unparsedBundles: UnparsedSourceBundle[],
-  macros: Record<string, MacroFunction> | undefined,
-): UnparsedSourceBundle[] {
-  if (!macros) {
-    return unparsedBundles;
-  }
-
-  return unparsedBundles.map((bundle) => {
-    return {
-      ...bundle,
-      content: Object.entries(macros).reduce((acc, [macroName, macroFunction]) => {
-        return acc.replace(new RegExp(`{{${macroName}}}`, 'g'), macroFunction());
-      }, bundle.content),
-    };
-  });
-}
-
 export function generateDocs(unparsedBundles: UnparsedSourceBundle[], config: MarkdownGeneratorConfig) {
   const convertToReferences = apply(parsedFilesToReferenceGuide, config);
   const convertToRenderableBundle = apply(parsedFilesToRenderableBundle, config);
@@ -85,12 +67,6 @@ export function generateDocs(unparsedBundles: UnparsedSourceBundle[], config: Ma
   return pipe(
     TE.right(replaceMacros(unparsedBundles, config.macros)),
     TE.flatMap((unparsedBundles) => generateForApex(filterApexSourceFiles(unparsedBundles), config)),
-    TE.tap((parsedApexFiles) => {
-      parsedApexFiles.forEach((parsedApexFile) => {
-        console.log(parsedApexFile.type.docComment);
-      });
-      return TE.right(undefined);
-    }),
     TE.chain((parsedApexFiles) => {
       return pipe(
         reflectCustomFieldsAndObjectsAndMetadataRecords(
@@ -124,6 +100,31 @@ export function generateDocs(unparsedBundles: UnparsedSourceBundle[], config: Ma
   );
 }
 
+function replaceMacros(
+  unparsedBundles: UnparsedSourceBundle[],
+  macros: Record<string, MacroFunction> | undefined,
+): UnparsedSourceBundle[] {
+  if (!macros) {
+    return unparsedBundles;
+  }
+
+  return unparsedBundles.map((bundle) => {
+    return {
+      ...bundle,``
+      content: Object.entries(macros).reduce((acc, [macroName, macroFunction]) => {
+        return acc.replace(
+          new RegExp(`{{${macroName}}}`, 'g'),
+          macroFunction({
+            type: bundle.type,
+            name: bundle.name,
+            filePath: bundle.filePath,
+          }),
+        );
+      }, bundle.content),
+    };
+  });
+}
+
 function generateForApex(apexBundles: UnparsedApexBundle[], config: MarkdownGeneratorConfig) {
   const filterOutOfScope = apply(filterScope, config.scope);
   const removeExcluded = apply(removeExcludedTags, config.excludeTags);

src/core/shared/types.d.ts

@@ -17,9 +17,13 @@ type LinkingStrategy =
   // No logic will be applied, the reference path will be used as is.
   | 'none';
 
-// TODO: Allow macros to either be a string or a function
-// TODO: Figure out if we can add arguments (only metadata, like the name of the metadata being parsed, and readonly)
-export type MacroFunction = () => string;
+type MacroSourceMetadata = {
+  type: 'apex' | 'customobject' | 'customfield' | 'custommetadata' | 'trigger';
+  name: string;
+  filePath: string;
+};
+
+export type MacroFunction = (metadata: MacroSourceMetadata) => string;
 
 export type CliConfigurableMarkdownConfig = {
   sourceDir: string;

src/index.ts

@@ -1,5 +1,7 @@
 import type {
   MarkdownConfigurableHooks,
+  MacroFunction,
+  MacroSourceMetadata,
   Skip,
   UserDefinedMarkdownConfig,
   ReferenceGuidePageData,
@@ -67,6 +69,8 @@ function defineChangelogConfig(config: ConfigurableChangelogConfig): Partial<Use
 export {
   defineMarkdownConfig,
   ConfigurableMarkdownConfig,
+  MacroFunction,
+  MacroSourceMetadata,
   defineOpenApiConfig,
   ConfigurableOpenApiConfig,
   defineChangelogConfig,