@cparra/apexdocs 2.25.0-alpha.1 → 2.25.0-alpha.10

package/src/{__spec__/core → core/markdown/__test__}/generating-enum-docs.spec.ts

@@ -1,5 +1,5 @@
-import { generateDocs } from '../../core/generate-docs';
 import { assertEither, extendExpect } from './expect-extensions';
+import { apexBundleFromRawString, generateDocs } from './test-helpers';
 
 describe('Generates enum documentation', () => {
   beforeAll(() => {
@@ -7,7 +7,7 @@ describe('Generates enum documentation', () => {
   });
 
   describe('documentation output', () => {
-    it('always returns markdown as the format', () => {
+    it('returns the name of the enum', async () => {
       const input = `
      public enum MyEnum {
         VALUE1,
@@ -15,24 +15,12 @@ describe('Generates enum documentation', () => {
       }
     `;
 
-      const result = generateDocs([input]);
-      assertEither(result, (data) => expect(data.format).toBe('markdown'));
-    });
-
-    it('returns the name of the enum', () => {
-      const input = `
-     public enum MyEnum {
-        VALUE1,
-        VALUE2
-      }
-    `;
-
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
-      assertEither(result, (data) => expect(data.docs[0].typeName).toBe('MyEnum'));
+      assertEither(result, (data) => expect(data.docs[0].filePath).toContain('MyEnum'));
     });
 
-    it('returns the type as enum', () => {
+    it('returns the type as enum', async () => {
       const input = `
      public enum MyEnum {
         VALUE1,
@@ -40,12 +28,12 @@ describe('Generates enum documentation', () => {
       }
     `;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
-      assertEither(result, (data) => expect(data.docs[0].type).toBe('enum'));
+      assertEither(result, (data) => expect(data.docs[0].source.type).toBe('enum'));
     });
 
-    it('does not return enums out of scope', () => {
+    it('does not return enums out of scope', async () => {
       const input1 = `
      global enum MyEnum {
         VALUE1,
@@ -60,11 +48,13 @@ describe('Generates enum documentation', () => {
         }
       `;
 
-      const result = generateDocs([input1, input2], { scope: ['global'] });
+      const result = await generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)], {
+        scope: ['global'],
+      })();
       expect(result).documentationBundleHasLength(1);
     });
 
-    it('does not return enums that have an @ignore in the docs', () => {
+    it('does not return enums that have an @ignore in the docs', async () => {
       const input = `
       /**
         * @ignore
@@ -75,13 +65,13 @@ describe('Generates enum documentation', () => {
       }
       `;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(0);
     });
   });
 
   describe('documentation content', () => {
-    it('generates a heading with the enum name', () => {
+    it('generates a heading with the enum name', async () => {
       const input = `
      public enum MyEnum {
         VALUE1,
@@ -91,12 +81,12 @@ describe('Generates enum documentation', () => {
 
       const output = `# MyEnum Enum`;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains(output));
     });
 
-    it('displays type level annotations', () => {
+    it('displays type level annotations', async () => {
       const input = `
         @NamespaceAccessible
         public enum MyEnum {
@@ -105,12 +95,12 @@ describe('Generates enum documentation', () => {
          }
        `;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('NAMESPACEACCESSIBLE'));
     });
 
-    it('displays the description', () => {
+    it('displays the description', async () => {
       const input = `
      /**
       * This is a description
@@ -121,12 +111,12 @@ describe('Generates enum documentation', () => {
       }
     `;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('This is a description'));
     });
 
-    it('display custom documentation tags', () => {
+    it('display custom documentation tags', async () => {
       const input = `
      /**
       * @custom-tag My Value
@@ -137,13 +127,13 @@ describe('Generates enum documentation', () => {
       }
     `;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('Custom Tag'));
       assertEither(result, (data) => expect(data).firstDocContains('My Value'));
     });
 
-    it('displays the group', () => {
+    it('displays the group', async () => {
       const input = `
      /**
       * @group MyGroup
@@ -154,13 +144,13 @@ describe('Generates enum documentation', () => {
       }
     `;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('Group'));
       assertEither(result, (data) => expect(data).firstDocContains('MyGroup'));
     });
 
-    it('displays the author', () => {
+    it('displays the author', async () => {
       const input = `
      /**
       * @author John Doe
@@ -171,13 +161,13 @@ describe('Generates enum documentation', () => {
       }
     `;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('Author'));
       assertEither(result, (data) => expect(data).firstDocContains('John Doe'));
     });
 
-    it('displays the date', () => {
+    it('displays the date', async () => {
       const input = `
      /**
       * @date 2021-01-01
@@ -188,13 +178,13 @@ describe('Generates enum documentation', () => {
       }
     `;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('Date'));
       assertEither(result, (data) => expect(data).firstDocContains('2021-01-01'));
     });
 
-    it('displays descriptions', () => {
+    it('displays descriptions', async () => {
       const input = `
       /**
         * @description This is a description
@@ -202,12 +192,12 @@ describe('Generates enum documentation', () => {
       public enum MyEnum {}
       `;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('This is a description'));
     });
 
-    it('displays descriptions with links', () => {
+    it('displays descriptions with links', async () => {
       const input1 = `
       /**
         * @description This is a description with a {@link EnumRef} reference
@@ -217,15 +207,15 @@ describe('Generates enum documentation', () => {
 
       const input2 = 'public enum EnumRef {}';
 
-      const result = generateDocs([input1, input2]);
+      const result = await generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)])();
       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'),
       );
     });
 
-    it('displays descriptions with emails', () => {
+    it('displays descriptions with emails', async () => {
       const input = `
       /**
         * @description This is a description with an {@email test@testerson.com} email
@@ -233,7 +223,7 @@ describe('Generates enum documentation', () => {
       public enum MyEnum {}
       `;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) =>
         expect(data).firstDocContains(
@@ -242,7 +232,7 @@ describe('Generates enum documentation', () => {
       );
     });
 
-    it('displays sees with accurately resolved links', () => {
+    it('displays sees with accurately resolved links', async () => {
       const input1 = `
       /**
         * @see EnumRef
@@ -252,13 +242,13 @@ describe('Generates enum documentation', () => {
 
       const input2 = 'public enum EnumRef {}';
 
-      const result = generateDocs([input1, input2]);
+      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', () => {
+    it('displays sees without links when the reference is not found', async () => {
       const input = `
       /**
         * @see EnumRef
@@ -266,42 +256,44 @@ describe('Generates enum documentation', () => {
       public enum MyEnum {}
       `;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('See'));
       assertEither(result, (data) => expect(data).firstDocContains('EnumRef'));
     });
 
-    it('displays the namespace if present in the config', () => {
+    it('displays the namespace if present in the config', async () => {
       const input = `
       public enum MyEnum {}
       `;
 
-      const result = generateDocs([input], { namespace: 'MyNamespace' });
+      const result = await generateDocs([apexBundleFromRawString(input)], { namespace: 'MyNamespace' })();
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('## Namespace'));
       assertEither(result, (data) => expect(data).firstDocContains('MyNamespace'));
     });
 
-    it('does not display the namespace if not present in the config', () => {
+    it('does not display the namespace if not present in the config', async () => {
       const input = `
       public enum MyEnum {}
       `;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContainsNot('## Namespace'));
     });
 
-    it('displays a mermaid diagram', () => {
+    it('displays a mermaid diagram', async () => {
       const input = `
       /**
         * @mermaid
+        * \`\`\`mermaid
         * graph TD
         *   A[Square Rect] -- Link text --> B((Circle))
         *   A --> C(Round Rect)
         *   B --> D{Rhombus}
         *   C --> D
+        * \`\`\`
         */
       public enum MyEnum {
         VALUE1,
@@ -309,21 +301,23 @@ describe('Generates enum documentation', () => {
       }
       `;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('```mermaid'));
       assertEither(result, (data) => expect(data).firstDocContains('graph TD'));
     });
 
-    it('displays an example code block', () => {
+    it('displays an example code block', async () => {
       const input = `
       /**
         * @example
+        * \`\`\`apex
         * public class MyClass {
         *   public void myMethod() {
         *     System.debug('Hello, World!');
         *   }
         * }
+        * \`\`\`
         */
       public enum MyEnum {
         VALUE1,
@@ -331,13 +325,13 @@ describe('Generates enum documentation', () => {
       }
       `;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('```apex'));
       assertEither(result, (data) => expect(data).firstDocContains('public class MyClass'));
     });
 
-    it('displays values', () => {
+    it('displays values', async () => {
       const input = `
       public enum MyEnum {
         VALUE1,
@@ -345,11 +339,47 @@ describe('Generates enum documentation', () => {
       }
       `;
 
-      const result = generateDocs([input]);
+      const result = await generateDocs([apexBundleFromRawString(input)])();
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('## Values'));
       assertEither(result, (data) => expect(data).firstDocContains('VALUE1'));
       assertEither(result, (data) => expect(data).firstDocContains('VALUE2'));
     });
+
+    it('displays values sorted when sortMembersAlphabetically is true', async () => {
+      const input = `
+      public enum MyEnum {
+        VALUE2,
+        VALUE1
+      }
+      `;
+
+      const result = await generateDocs([apexBundleFromRawString(input)], { sortMembersAlphabetically: true })();
+      expect(result).documentationBundleHasLength(1);
+      assertEither(result, (data) => expect(data).firstDocContains('## Values'));
+      assertEither(result, (data) => {
+        const value1Index = data.docs[0].content.indexOf('VALUE1');
+        const value2Index = data.docs[0].content.indexOf('VALUE2');
+        expect(value1Index).toBeLessThan(value2Index);
+      });
+    });
+
+    it('does not sort values when sortMembersAlphabetically is false', async () => {
+      const input = `
+      public enum MyEnum {
+        VALUE2,
+        VALUE1
+      }
+      `;
+
+      const result = await generateDocs([apexBundleFromRawString(input)], { sortMembersAlphabetically: false })();
+      expect(result).documentationBundleHasLength(1);
+      assertEither(result, (data) => expect(data).firstDocContains('## Values'));
+      assertEither(result, (data) => {
+        const value1Index = data.docs[0].content.indexOf('VALUE1');
+        const value2Index = data.docs[0].content.indexOf('VALUE2');
+        expect(value1Index).toBeGreaterThan(value2Index);
+      });
+    });
   });
 });