@cparra/apexdocs 2.25.0-alpha.8 → 2.25.0-alpha.9

package/examples/vitepress/docs/.vitepress/sidebar.json

@@ -10,23 +10,23 @@
             "items": [
               {
                 "text": "BaseClass",
-                "link": "Miscellaneous/apexdocs.BaseClass"
+                "link": "miscellaneous/BaseClass.md"
               },
               {
                 "text": "MultiInheritanceClass",
-                "link": "Miscellaneous/apexdocs.MultiInheritanceClass"
+                "link": "miscellaneous/MultiInheritanceClass.md"
               },
               {
                 "text": "SampleClass",
-                "link": "SampleGroup/apexdocs.SampleClass"
+                "link": "samplegroup/SampleClass.md"
               },
               {
                 "text": "SampleException",
-                "link": "Miscellaneous/apexdocs.SampleException"
+                "link": "miscellaneous/SampleException.md"
               },
               {
                 "text": "Url",
-                "link": "Miscellaneous/apexdocs.Url"
+                "link": "miscellaneous/Url.md"
               }
             ]
           },
@@ -35,11 +35,11 @@
             "items": [
               {
                 "text": "ParentInterface",
-                "link": "Miscellaneous/apexdocs.ParentInterface"
+                "link": "miscellaneous/ParentInterface.md"
               },
               {
                 "text": "SampleInterface",
-                "link": "Miscellaneous/apexdocs.SampleInterface"
+                "link": "miscellaneous/SampleInterface.md"
               }
             ]
           },
@@ -48,11 +48,11 @@
             "items": [
               {
                 "text": "ReferencedEnum",
-                "link": "Miscellaneous/apexdocs.ReferencedEnum"
+                "link": "miscellaneous/ReferencedEnum.md"
               },
               {
                 "text": "SampleEnum",
-                "link": "Sample-Enums/apexdocs.SampleEnum"
+                "link": "sample-enums/SampleEnum.md"
               }
             ]
           }
@@ -66,31 +66,31 @@
             "items": [
               {
                 "text": "BaseClass",
-                "link": "Miscellaneous/apexdocs.BaseClass"
+                "link": "miscellaneous/BaseClass.md"
               },
               {
                 "text": "MultiInheritanceClass",
-                "link": "Miscellaneous/apexdocs.MultiInheritanceClass"
+                "link": "miscellaneous/MultiInheritanceClass.md"
               },
               {
                 "text": "ParentInterface",
-                "link": "Miscellaneous/apexdocs.ParentInterface"
+                "link": "miscellaneous/ParentInterface.md"
               },
               {
                 "text": "ReferencedEnum",
-                "link": "Miscellaneous/apexdocs.ReferencedEnum"
+                "link": "miscellaneous/ReferencedEnum.md"
               },
               {
                 "text": "SampleException",
-                "link": "Miscellaneous/apexdocs.SampleException"
+                "link": "miscellaneous/SampleException.md"
               },
               {
                 "text": "SampleInterface",
-                "link": "Miscellaneous/apexdocs.SampleInterface"
+                "link": "miscellaneous/SampleInterface.md"
               },
               {
                 "text": "Url",
-                "link": "Miscellaneous/apexdocs.Url"
+                "link": "miscellaneous/Url.md"
               }
             ]
           },
@@ -99,7 +99,7 @@
             "items": [
               {
                 "text": "SampleClass",
-                "link": "SampleGroup/apexdocs.SampleClass"
+                "link": "samplegroup/SampleClass.md"
               }
             ]
           },
@@ -108,7 +108,7 @@
             "items": [
               {
                 "text": "SampleEnum",
-                "link": "Sample-Enums/apexdocs.SampleEnum"
+                "link": "sample-enums/SampleEnum.md"
               }
             ]
           }

package/examples/vitepress/docs/index.md

@@ -19,38 +19,38 @@ hero:
 
 ## Miscellaneous
 
-### [apexdocs.BaseClass](./Miscellaneous/apexdocs.BaseClass.md)
+### [BaseClass](/miscellaneous/BaseClass.md)
 
-### [apexdocs.MultiInheritanceClass](./Miscellaneous/apexdocs.MultiInheritanceClass.md)
+### [MultiInheritanceClass](/miscellaneous/MultiInheritanceClass.md)
 
-### [apexdocs.ParentInterface](./Miscellaneous/apexdocs.ParentInterface.md)
+### [ParentInterface](/miscellaneous/ParentInterface.md)
 
-### [apexdocs.ReferencedEnum](./Miscellaneous/apexdocs.ReferencedEnum.md)
+### [ReferencedEnum](/miscellaneous/ReferencedEnum.md)
 
-### [apexdocs.SampleException](./Miscellaneous/apexdocs.SampleException.md)
+### [SampleException](/miscellaneous/SampleException.md)
 
 This is a sample exception.
 
-### [apexdocs.SampleInterface](./Miscellaneous/apexdocs.SampleInterface.md)
+### [SampleInterface](/miscellaneous/SampleInterface.md)
 
 This is a sample interface
 
-### [apexdocs.Url](./Miscellaneous/apexdocs.Url.md)
+### [Url](/miscellaneous/Url.md)
 
 Represents a uniform resource locator (URL) and provides access to parts of the URL. 
 Enables access to the base URL used to access your Salesforce org.
 
 ## Sample Enums
 
-### [apexdocs.SampleEnum](./Sample-Enums/apexdocs.SampleEnum.md)
+### [SampleEnum](/sample-enums/SampleEnum.md)
 
-This is a sample enum. This references [apexdocs.ReferencedEnum](./Miscellaneous/apexdocs.ReferencedEnum.md) . 
+This is a sample enum. This references [ReferencedEnum](/miscellaneous/ReferencedEnum.md) . 
  
 This description has several lines
 
 ## SampleGroup
 
-### [apexdocs.SampleClass](./SampleGroup/apexdocs.SampleClass.md)
+### [SampleClass](/samplegroup/SampleClass.md)
 
 aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit officia veniam ex 
 deserunt ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.

package/examples/vitepress/docs/{Miscellaneous/apexdocs.BaseClass.md → miscellaneous/BaseClass.md}

@@ -17,4 +17,4 @@ public sampleEnumFromBase
 ```
 
 #### Type
-[apexdocs.SampleEnum](../Sample-Enums/apexdocs.SampleEnum.md)
+[SampleEnum](/sample-enums/SampleEnum.md)

package/examples/vitepress/docs/{Miscellaneous/apexdocs.MultiInheritanceClass.md → miscellaneous/MultiInheritanceClass.md}

@@ -9,7 +9,7 @@ apexdocs
 
 **Inheritance**
 
-[apexdocs.SampleClass](../SampleGroup/apexdocs.SampleClass.md) < [apexdocs.BaseClass](./apexdocs.BaseClass.md)
+[SampleClass](/samplegroup/SampleClass.md) < [BaseClass](/miscellaneous/BaseClass.md)
 
 ## Fields
 ### `sampleEnumFromBase`
@@ -22,7 +22,7 @@ public sampleEnumFromBase
 ```
 
 #### Type
-[apexdocs.SampleEnum](../Sample-Enums/apexdocs.SampleEnum.md)
+[SampleEnum](/sample-enums/SampleEnum.md)
 
 ## Properties
 ### Group Name

package/examples/vitepress/docs/{Miscellaneous/apexdocs.SampleException.md → miscellaneous/SampleException.md}

@@ -9,7 +9,7 @@ This is a sample exception.
 **Usage** 
 
 You can use the exception the following way. 
-You can also take a look at [apexdocs.SampleClass](../SampleGroup/apexdocs.SampleClass.md) to see how it is used. 
+You can also take a look at [SampleClass](/samplegroup/SampleClass.md) to see how it is used. 
 This is a dangerous HTML tag: <script>alert('Hello');</script> 
  
 ```apex

package/examples/vitepress/docs/{Miscellaneous/apexdocs.SampleInterface.md → miscellaneous/SampleInterface.md}

@@ -19,9 +19,9 @@ C -->|extends| D[GreatGrandParentInterface]
 
 **Date** 2020-01-01
 
-**See** [apexdocs.SampleEnum](../Sample-Enums/apexdocs.SampleEnum.md)
+**See** [SampleEnum](/sample-enums/SampleEnum.md)
 
-**See** [apexdocs.ReferencedEnum](./apexdocs.ReferencedEnum.md)
+**See** [ReferencedEnum](/miscellaneous/ReferencedEnum.md)
 
 ## Namespace
 apexdocs
@@ -31,7 +31,7 @@ SampleInterface sampleInterface = new SampleInterface();
 sampleInterface.sampleMethod();
 
 **Extends**
-[apexdocs.ParentInterface](./apexdocs.ParentInterface.md)
+[ParentInterface](/miscellaneous/ParentInterface.md)
 
 ## Methods
 ### `sampleMethod()`
@@ -66,7 +66,7 @@ public String sampleMethod()
 Some return value
 
 #### Throws
-[apexdocs.SampleException](./apexdocs.SampleException.md): This is a sample exception
+[SampleException](/miscellaneous/SampleException.md): This is a sample exception
 
 AnotherSampleException: This is another sample exception
 
@@ -94,10 +94,10 @@ public SampleEnum sampleMethodWithParams(String param1, Integer param2, SampleEn
 |------|------|-------------|
 | param1 | String | This is the first parameter |
 | param2 | Integer | This is the second parameter |
-| theEnum | [apexdocs.SampleEnum](../Sample-Enums/apexdocs.SampleEnum.md) | This is an enum parameter |
+| theEnum | [SampleEnum](/sample-enums/SampleEnum.md) | This is an enum parameter |
 
 #### Return Type
-**[apexdocs.SampleEnum](../Sample-Enums/apexdocs.SampleEnum.md)**
+**[SampleEnum](/sample-enums/SampleEnum.md)**
 
 Some return value
 

package/examples/vitepress/docs/{Miscellaneous/apexdocs.Url.md → miscellaneous/Url.md}

@@ -120,7 +120,7 @@ global Url(Url context, String spec)
 #### Parameters
 | Name | Type | Description |
 |------|------|-------------|
-| context | [apexdocs.Url](./apexdocs.Url.md) | The context in which to parse the specification. |
+| context | [Url](/miscellaneous/Url.md) | The context in which to parse the specification. |
 | spec | String | The string to parse as a URL. |
 
 ---
@@ -191,7 +191,7 @@ global static Url getCurrentRequestUrl()
 ```
 
 #### Return Type
-**[apexdocs.Url](./apexdocs.Url.md)**
+**[Url](/miscellaneous/Url.md)**
 
 The URL of the entire request.
 
@@ -299,7 +299,7 @@ global static Url getOrgDomainUrl()
 ```
 
 #### Return Type
-**[apexdocs.Url](./apexdocs.Url.md)**
+**[Url](/miscellaneous/Url.md)**
 
 getOrgDomainUrl() always returns the login URL for your org, regardless of context. Use that URL when making API calls to your org.
 

package/examples/vitepress/docs/{Sample-Enums/apexdocs.SampleEnum.md → sample-enums/SampleEnum.md}

@@ -6,13 +6,13 @@ title: SampleEnum
 
 `NAMESPACEACCESSIBLE`
 
-This is a sample enum. This references [apexdocs.ReferencedEnum](../Miscellaneous/apexdocs.ReferencedEnum.md) . 
+This is a sample enum. This references [ReferencedEnum](/miscellaneous/ReferencedEnum.md) . 
  
 This description has several lines
 
 **Some Custom** 
 
-Test. I can also have a [apexdocs.ReferencedEnum](../Miscellaneous/apexdocs.ReferencedEnum.md) here. 
+Test. I can also have a [ReferencedEnum](/miscellaneous/ReferencedEnum.md) here. 
 And it can be multiline.
 
 **Mermaid** 
@@ -27,7 +27,7 @@ B -->|referenced by| A
 
 **Date** 2022-01-01
 
-**See** [apexdocs.ReferencedEnum](../Miscellaneous/apexdocs.ReferencedEnum.md)
+**See** [ReferencedEnum](/miscellaneous/ReferencedEnum.md)
 
 ## Namespace
 apexdocs

package/examples/vitepress/docs/{SampleGroup/apexdocs.SampleClass.md → samplegroup/SampleClass.md}

@@ -19,12 +19,12 @@ sample.doSomething();
 
 **Inheritance**
 
-[apexdocs.BaseClass](../Miscellaneous/apexdocs.BaseClass.md)
+[BaseClass](/miscellaneous/BaseClass.md)
 
 **Implements**
 
-[apexdocs.SampleInterface](../Miscellaneous/apexdocs.SampleInterface.md), 
-[apexdocs.ParentInterface](../Miscellaneous/apexdocs.ParentInterface.md)
+[SampleInterface](/miscellaneous/SampleInterface.md), 
+[ParentInterface](/miscellaneous/ParentInterface.md)
 
 ## Fields
 ### Group Name
@@ -51,7 +51,7 @@ public sampleEnumFromBase
 ```
 
 ##### Type
-[apexdocs.SampleEnum](../Sample-Enums/apexdocs.SampleEnum.md)
+[SampleEnum](/sample-enums/SampleEnum.md)
 
 ## Properties
 ### Group Name

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.25.0-alpha.8",
+  "version": "2.25.0-alpha.9",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",

package/src/application/apex-file-reader.ts

@@ -1,5 +1,5 @@
 import { FileSystem } from './file-system';
-import { SourceFile } from '../core/shared/types';
+import { UnparsedSourceFile } from '../core/shared/types';
 
 const APEX_FILE_EXTENSION = '.cls';
 
@@ -10,8 +10,8 @@ export class ApexFileReader {
   /**
    * Reads from .cls files and returns their raw body.
    */
-  static processFiles(fileSystem: FileSystem, rootPath: string, includeMetadata: boolean): SourceFile[] {
-    let bundles: SourceFile[] = [];
+  static processFiles(fileSystem: FileSystem, rootPath: string, includeMetadata: boolean): UnparsedSourceFile[] {
+    let bundles: UnparsedSourceFile[] = [];
 
     const directoryContents = fileSystem.readDirectory(rootPath);
     directoryContents.forEach((filePath) => {

package/src/application/file-writer.ts

@@ -5,21 +5,17 @@ import { PageData } from '../core/shared/types';
 export class FileWriter {
   static write(files: PageData[], outputDir: string, onWriteCallback: (file: PageData) => void) {
     files.forEach((file) => {
-      const resolvedFile = this.getTargetLocation(file, outputDir);
-      if (!fs.existsSync(resolvedFile.directory)) {
-        fs.mkdirSync(resolvedFile.directory, { recursive: true });
-      }
-
-      const filePath = path.join(resolvedFile.directory, `${resolvedFile.fileName}.${resolvedFile.fileExtension}`);
-      fs.writeFileSync(filePath, resolvedFile.content, 'utf8');
-      onWriteCallback(resolvedFile);
+      const { filePath, content } = this.getTargetLocation(file, outputDir);
+      fs.mkdirSync(path.dirname(filePath), { recursive: true });
+      fs.writeFileSync(filePath, content, 'utf8');
+      onWriteCallback(file);
     });
   }
 
   private static getTargetLocation(file: PageData, outputDir: string): PageData {
     return {
       ...file,
-      directory: path.join(outputDir, file.directory),
+      filePath: path.join(outputDir, file.filePath),
     };
   }
 }

package/src/application/generators/markdown.ts

@@ -2,13 +2,18 @@ import { generateDocs } from '../../core/markdown/generate-docs';
 import { FileWriter } from '../file-writer';
 import { Logger } from '#utils/logger';
 import { pipe } from 'fp-ts/function';
-import { PageData, PostHookDocumentationBundle, SourceFile, UserDefinedMarkdownConfig } from '../../core/shared/types';
+import {
+  PageData,
+  PostHookDocumentationBundle,
+  UnparsedSourceFile,
+  UserDefinedMarkdownConfig,
+} from '../../core/shared/types';
 import { ReflectionError } from '../../core/markdown/reflection/error-handling';
 import { referenceGuideTemplate } from '../../core/markdown/templates/reference-guide';
 import * as TE from 'fp-ts/TaskEither';
 import { isSkip } from '../../core/shared/utils';
 
-export default function generate(bundles: SourceFile[], config: UserDefinedMarkdownConfig) {
+export default function generate(bundles: UnparsedSourceFile[], config: UserDefinedMarkdownConfig) {
   return pipe(
     generateDocumentationBundle(bundles, config),
     TE.map((files) => writeFilesToSystem(files, config.targetDir)),
@@ -29,7 +34,7 @@ export default function generate(bundles: SourceFile[], config: UserDefinedMarkd
   )();
 }
 
-function generateDocumentationBundle(bundles: SourceFile[], config: UserDefinedMarkdownConfig) {
+function generateDocumentationBundle(bundles: UnparsedSourceFile[], config: UserDefinedMarkdownConfig) {
   return generateDocs(bundles, {
     ...config,
     referenceGuideTemplate: referenceGuideTemplate,
@@ -43,7 +48,7 @@ function writeFilesToSystem(files: PostHookDocumentationBundle, outputDir: strin
       .filter((file) => !isSkip(file)) as PageData[],
     outputDir,
     (file: PageData) => {
-      Logger.logSingle(`${file.fileName} processed.`, false, 'green', false);
+      Logger.logSingle(`${file.filePath} processed.`, false, 'green', false);
     },
   );
 }

package/src/application/generators/openapi.ts

@@ -7,10 +7,10 @@ import { Logger } from '#utils/logger';
 import ErrorLogger from '#utils/error-logger';
 import { reflect, ReflectionResult } from '@cparra/apex-reflection';
 import Manifest from '../../core/manifest';
-import { PageData, SourceFile, UserDefinedOpenApiConfig } from '../../core/shared/types';
+import { PageData, UnparsedSourceFile, UserDefinedOpenApiConfig } from '../../core/shared/types';
 import { OpenApiDocsProcessor } from '../../core/openapi/open-api-docs-processor';
 
-export default function openApi(fileBodies: SourceFile[], config: UserDefinedOpenApiConfig) {
+export default function openApi(fileBodies: UnparsedSourceFile[], config: UserDefinedOpenApiConfig) {
   const manifest = createManifest(new RawBodyParser(fileBodies), reflectionWithLogger);
   TypesRepository.getInstance().populateAll(manifest.types);
   const filteredTypes = filterByScopes(manifest);
@@ -19,14 +19,14 @@ export default function openApi(fileBodies: SourceFile[], config: UserDefinedOpe
   const generatedFiles = processor.fileBuilder().files();
 
   FileWriter.write(generatedFiles, config.targetDir, (file: PageData) => {
-    Logger.logSingle(`${file.fileName} processed.`, false, 'green', false);
+    Logger.logSingle(`${file.filePath} processed.`, false, 'green', false);
   });
 
   // Error logging
   ErrorLogger.logErrors(filteredTypes);
 }
 
-function reflectionWithLogger(apexBundle: SourceFile): ReflectionResult {
+function reflectionWithLogger(apexBundle: UnparsedSourceFile): ReflectionResult {
   const result = reflect(apexBundle.content);
   if (result.error) {
     Logger.error(`${apexBundle.filePath} - Parsing error ${result.error?.message}`);

package/src/core/markdown/__test__/generating-class-docs.spec.ts

@@ -12,7 +12,7 @@ describe('Generates interface documentation', () => {
 
       const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
-      assertEither(result, (data) => expect(data.docs[0].fileName).toBe('MyClass'));
+      assertEither(result, (data) => expect(data.docs[0].filePath).toContain('MyClass'));
     });
 
     it('returns the type as class', async () => {
@@ -268,7 +268,9 @@ describe('Generates interface documentation', () => {
         const result = await generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)])();
         expect(result).documentationBundleHasLength(2);
         assertEither(result, (data) =>
-          expect(data).firstDocContains('This is a description with a [ClassRef](./ClassRef.md) reference'),
+          expect(data).firstDocContains(
+            'This is a description with a [ClassRef](/miscellaneous/ClassRef.md) reference',
+          ),
         );
       });
 
@@ -302,7 +304,7 @@ describe('Generates interface documentation', () => {
         const result = await generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)])();
         expect(result).documentationBundleHasLength(2);
         assertEither(result, (data) => expect(data).firstDocContains('See'));
-        assertEither(result, (data) => expect(data).firstDocContains('[ClassRef](./ClassRef.md)'));
+        assertEither(result, (data) => expect(data).firstDocContains('[ClassRef](/miscellaneous/ClassRef.md)'));
       });
 
       it('displays sees without links when the reference is not found', async () => {

package/src/core/markdown/__test__/generating-enum-docs.spec.ts

@@ -17,7 +17,7 @@ describe('Generates enum documentation', () => {
 
       const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
-      assertEither(result, (data) => expect(data.docs[0].fileName).toBe('MyEnum'));
+      assertEither(result, (data) => expect(data.docs[0].filePath).toContain('MyEnum'));
     });
 
     it('returns the type as enum', async () => {
@@ -211,7 +211,7 @@ describe('Generates enum documentation', () => {
       expect(result).documentationBundleHasLength(2);
       assertEither(result, (data) => expect(data).firstDocContains('Description'));
       assertEither(result, (data) =>
-        expect(data).firstDocContains('This is a description with a [EnumRef](./EnumRef.md) reference'),
+        expect(data).firstDocContains('This is a description with a [EnumRef](/miscellaneous/EnumRef.md) reference'),
       );
     });
 
@@ -245,7 +245,7 @@ describe('Generates enum documentation', () => {
       const result = await generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)])();
       expect(result).documentationBundleHasLength(2);
       assertEither(result, (data) => expect(data).firstDocContains('See'));
-      assertEither(result, (data) => expect(data).firstDocContains('[EnumRef](./EnumRef.md)'));
+      assertEither(result, (data) => expect(data).firstDocContains('[EnumRef](/miscellaneous/EnumRef.md)'));
     });
 
     it('displays sees without links when the reference is not found', async () => {

package/src/core/markdown/__test__/generating-interface-docs.spec.ts

@@ -189,7 +189,9 @@ describe('Generates interface documentation', () => {
         const result = await generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)])();
         expect(result).documentationBundleHasLength(2);
         assertEither(result, (data) =>
-          expect(data).firstDocContains('This is a description with a [InterfaceRef](./InterfaceRef.md) reference'),
+          expect(data).firstDocContains(
+            'This is a description with a [InterfaceRef](/miscellaneous/InterfaceRef.md) reference',
+          ),
         );
       });
 
@@ -223,7 +225,7 @@ describe('Generates interface documentation', () => {
         const result = await generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)])();
         expect(result).documentationBundleHasLength(2);
         assertEither(result, (data) => expect(data).firstDocContains('See'));
-        assertEither(result, (data) => expect(data).firstDocContains('[InterfaceRef](./InterfaceRef.md)'));
+        assertEither(result, (data) => expect(data).firstDocContains('[InterfaceRef](/miscellaneous/InterfaceRef.md)'));
       });
 
       it('displays sees without links when the reference is not found', async () => {
@@ -451,7 +453,7 @@ describe('Generates interface documentation', () => {
         const result = await generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)])();
         expect(result).documentationBundleHasLength(2);
         assertEither(result, (data) =>
-          expect(data.docs.find((doc) => doc.fileName === 'AnotherInterface')?.content).toContain('Inherited'),
+          expect(data.docs.find((doc) => doc.filePath.includes('AnotherInterface'))?.content).toContain('Inherited'),
         );
       });
     });

package/src/core/markdown/__test__/generating-reference-guide.spec.ts

@@ -25,12 +25,10 @@ describe('Generates a Reference Guide', () => {
     expect(result).documentationBundleHasLength(2);
 
     assertEither(result, (data) =>
-      expect((data.referenceGuide as ReferenceGuidePageData).content).toContain('[MyEnum](./Miscellaneous/MyEnum.md)'),
+      expect((data.referenceGuide as ReferenceGuidePageData).content).toContain('[MyEnum](/miscellaneous/MyEnum.md)'),
     );
     assertEither(result, (data) =>
-      expect((data.referenceGuide as ReferenceGuidePageData).content).toContain(
-        '[MyClass](./Miscellaneous/MyClass.md)',
-      ),
+      expect((data.referenceGuide as ReferenceGuidePageData).content).toContain('[MyClass](/miscellaneous/MyClass.md)'),
     );
   });
 
@@ -176,9 +174,7 @@ describe('Generates a Reference Guide', () => {
     const result = await generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)])();
     expect(result).documentationBundleHasLength(2);
     assertEither(result, (data) =>
-      expect((data.referenceGuide as ReferenceGuidePageData).content).toContain(
-        'with a [MyClass](./Group2/MyClass.md)',
-      ),
+      expect((data.referenceGuide as ReferenceGuidePageData).content).toContain('with a [MyClass](/group2/MyClass.md)'),
     );
   });
 });

package/src/core/markdown/__test__/test-helpers.ts

@@ -1,8 +1,8 @@
-import { SourceFile } from '../../shared/types';
+import { UnparsedSourceFile } from '../../shared/types';
 import { generateDocs as gen, MarkdownGeneratorConfig } from '../generate-docs';
 import { referenceGuideTemplate } from '../templates/reference-guide';
 
-export function apexBundleFromRawString(raw: string, rawMetadata?: string): SourceFile {
+export function apexBundleFromRawString(raw: string, rawMetadata?: string): UnparsedSourceFile {
   return {
     filePath: 'test.cls',
     content: raw,
@@ -10,7 +10,7 @@ export function apexBundleFromRawString(raw: string, rawMetadata?: string): Sour
   };
 }
 
-export function generateDocs(apexBundles: SourceFile[], config?: Partial<MarkdownGeneratorConfig>) {
+export function generateDocs(apexBundles: UnparsedSourceFile[], config?: Partial<MarkdownGeneratorConfig>) {
   return gen(apexBundles, {
     targetDir: 'target',
     scope: ['global', 'public'],