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

package/src/__spec__/core/generating-class-docs.spec.ts

@@ -1,5 +1,6 @@
 import { assertEither, extendExpect } from './expect-extensions';
 import { generateDocs } from '../../core/generate-docs';
+import { apexBundleFromRawString } from './test-helpers';
 
 describe('Generates interface documentation', () => {
   beforeAll(() => {
@@ -10,14 +11,14 @@ describe('Generates interface documentation', () => {
     it('always returns markdown as the format', () => {
       const input = 'public class MyClass {}';
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       assertEither(result, (data) => expect(data.format).toBe('markdown'));
     });
 
     it('returns the name of the class', () => {
       const input = 'public class MyClass {}';
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data.docs[0].typeName).toBe('MyClass'));
     });
@@ -25,7 +26,7 @@ describe('Generates interface documentation', () => {
     it('returns the type as class', () => {
       const input = 'public class MyClass {}';
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data.docs[0].type).toBe('class'));
     });
@@ -39,7 +40,9 @@ describe('Generates interface documentation', () => {
         public class AnotherClass {}
       `;
 
-      const result = generateDocs([input1, input2], { scope: ['global'] });
+      const result = generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)], {
+        scope: ['global'],
+      });
       expect(result).documentationBundleHasLength(1);
     });
 
@@ -50,7 +53,7 @@ describe('Generates interface documentation', () => {
         */
       public class MyClass {}`;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(0);
     });
 
@@ -63,7 +66,7 @@ describe('Generates interface documentation', () => {
         public void myMethod() {}
       }`;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data.docs[0].docContents).not.toContain('myMethod'));
     });
@@ -77,7 +80,7 @@ describe('Generates interface documentation', () => {
         public String myProperty { get; set; }
       }`;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data.docs[0].docContents).not.toContain('myProperty'));
     });
@@ -91,7 +94,7 @@ describe('Generates interface documentation', () => {
         public String myField;
       }`;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data.docs[0].docContents).not.toContain('myField'));
     });
@@ -105,7 +108,7 @@ describe('Generates interface documentation', () => {
         public class InnerClass {}
       }`;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data.docs[0].docContents).not.toContain('InnerClass'));
     });
@@ -119,7 +122,7 @@ describe('Generates interface documentation', () => {
         public interface InnerInterface {}
       }`;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data.docs[0].docContents).not.toContain('InnerInterface'));
     });
@@ -133,7 +136,7 @@ describe('Generates interface documentation', () => {
         public enum InnerEnum {}
       }`;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data.docs[0].docContents).not.toContain('InnerEnum'));
     });
@@ -145,7 +148,7 @@ describe('Generates interface documentation', () => {
         const input = 'public class MyClass {}';
 
         const output = `# MyClass Class`;
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains(output));
       });
@@ -159,12 +162,29 @@ describe('Generates interface documentation', () => {
         }
        `;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('NAMESPACEACCESSIBLE'));
         assertEither(result, (data) => expect(data).firstDocContains('DEPRECATED'));
       });
 
+      it('displays metadata as annotations', () => {
+        const input = 'public class MyClass {}';
+        const metadata = `
+        <?xml version="1.0" encoding="UTF-8"?>
+        <ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+            <apiVersion>59.0</apiVersion>
+            <status>Active</status>
+        </ApexClass>
+        `;
+
+        const result = generateDocs([apexBundleFromRawString(input, metadata)]);
+
+        expect(result).documentationBundleHasLength(1);
+        assertEither(result, (data) => expect(data).firstDocContains('APIVERSION'));
+        assertEither(result, (data) => expect(data).firstDocContains('STATUS'));
+      });
+
       it('displays the description', () => {
         const input = `
           /**
@@ -173,7 +193,7 @@ describe('Generates interface documentation', () => {
           public class MyClass {}
          `;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('This is a description'));
       });
@@ -186,7 +206,7 @@ describe('Generates interface documentation', () => {
           public class MyClass {}
         `;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('Custom Tag'));
         assertEither(result, (data) => expect(data).firstDocContains('My Value'));
@@ -199,7 +219,7 @@ describe('Generates interface documentation', () => {
            */
           public class MyClass {}`;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('Group'));
         assertEither(result, (data) => expect(data).firstDocContains('MyGroup'));
@@ -212,7 +232,7 @@ describe('Generates interface documentation', () => {
            */
           public class MyClass {}`;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('Author'));
         assertEither(result, (data) => expect(data).firstDocContains('John Doe'));
@@ -225,7 +245,7 @@ describe('Generates interface documentation', () => {
            */
           public class MyClass {}`;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('Date'));
         assertEither(result, (data) => expect(data).firstDocContains('2021-01-01'));
@@ -238,7 +258,7 @@ describe('Generates interface documentation', () => {
             */
           public class MyClass {}`;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('This is a description'));
       });
@@ -253,7 +273,7 @@ describe('Generates interface documentation', () => {
 
         const input2 = 'public class ClassRef {}';
 
-        const result = generateDocs([input1, input2]);
+        const result = 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'),
@@ -268,7 +288,7 @@ describe('Generates interface documentation', () => {
           public class MyClass {}
           `;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) =>
           expect(data).firstDocContains(
@@ -287,7 +307,7 @@ describe('Generates interface documentation', () => {
 
         const input2 = 'public class ClassRef {}';
 
-        const result = generateDocs([input1, input2]);
+        const result = 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)'));
@@ -301,7 +321,7 @@ describe('Generates interface documentation', () => {
           public class MyClass {}
           `;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('See'));
         assertEither(result, (data) => expect(data).firstDocContains('ClassRef'));
@@ -310,7 +330,7 @@ describe('Generates interface documentation', () => {
       it('displays the namespace if present in the config', () => {
         const input = 'public class MyClass {}';
 
-        const result = generateDocs([input], { namespace: 'MyNamespace' });
+        const result = generateDocs([apexBundleFromRawString(input)], { namespace: 'MyNamespace' });
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('## Namespace'));
         assertEither(result, (data) => expect(data).firstDocContains('MyNamespace'));
@@ -319,7 +339,7 @@ describe('Generates interface documentation', () => {
       it('does not display the namespace if not present in the config', () => {
         const input = 'public class MyClass {}';
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContainsNot('## Namespace'));
       });
@@ -337,7 +357,7 @@ describe('Generates interface documentation', () => {
           public class MyClass {}
           `;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('```mermaid'));
         assertEither(result, (data) => expect(data).firstDocContains('graph TD'));
@@ -355,7 +375,7 @@ describe('Generates interface documentation', () => {
             */
           public class MyClass {}`;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('```apex'));
         assertEither(result, (data) => expect(data).firstDocContains('public class MyClass'));
@@ -371,7 +391,7 @@ describe('Generates interface documentation', () => {
         }
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('## Methods'));
     });
@@ -383,7 +403,7 @@ describe('Generates interface documentation', () => {
         }
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('## Properties'));
     });
@@ -395,7 +415,7 @@ describe('Generates interface documentation', () => {
         }
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('## Fields'));
     });
@@ -407,7 +427,7 @@ describe('Generates interface documentation', () => {
         }
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('## Constructors'));
     });
@@ -419,7 +439,7 @@ describe('Generates interface documentation', () => {
         }
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('## Classes'));
     });
@@ -431,7 +451,7 @@ describe('Generates interface documentation', () => {
         }
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('## Interfaces'));
     });
@@ -443,7 +463,7 @@ describe('Generates interface documentation', () => {
         }
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('## Enums'));
     });
@@ -463,7 +483,7 @@ describe('Generates interface documentation', () => {
         }
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('```mermaid'));
       assertEither(result, (data) => expect(data).firstDocContains('graph TD'));
@@ -484,7 +504,7 @@ describe('Generates interface documentation', () => {
         }
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('```apex'));
       assertEither(result, (data) => expect(data).firstDocContains('public class MyClass'));
@@ -501,7 +521,7 @@ describe('Generates interface documentation', () => {
         public class AnotherClass extends MyClass {}
       `;
 
-      const result = generateDocs([input1, input2]);
+      const result = generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)]);
       expect(result).documentationBundleHasLength(2);
       assertEither(result, (data) =>
         expect(data.docs.find((doc) => doc.typeName === 'AnotherClass')?.docContents).toContain('Inherited'),

package/src/__spec__/core/generating-enum-docs.spec.ts

@@ -1,5 +1,6 @@
 import { generateDocs } from '../../core/generate-docs';
 import { assertEither, extendExpect } from './expect-extensions';
+import { apexBundleFromRawString } from './test-helpers';
 
 describe('Generates enum documentation', () => {
   beforeAll(() => {
@@ -15,7 +16,7 @@ describe('Generates enum documentation', () => {
       }
     `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       assertEither(result, (data) => expect(data.format).toBe('markdown'));
     });
 
@@ -27,7 +28,7 @@ describe('Generates enum documentation', () => {
       }
     `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data.docs[0].typeName).toBe('MyEnum'));
     });
@@ -40,7 +41,7 @@ describe('Generates enum documentation', () => {
       }
     `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data.docs[0].type).toBe('enum'));
     });
@@ -60,7 +61,9 @@ describe('Generates enum documentation', () => {
         }
       `;
 
-      const result = generateDocs([input1, input2], { scope: ['global'] });
+      const result = generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)], {
+        scope: ['global'],
+      });
       expect(result).documentationBundleHasLength(1);
     });
 
@@ -75,7 +78,7 @@ describe('Generates enum documentation', () => {
       }
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(0);
     });
   });
@@ -91,7 +94,7 @@ describe('Generates enum documentation', () => {
 
       const output = `# MyEnum Enum`;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains(output));
     });
@@ -105,7 +108,7 @@ describe('Generates enum documentation', () => {
          }
        `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('NAMESPACEACCESSIBLE'));
     });
@@ -121,7 +124,7 @@ describe('Generates enum documentation', () => {
       }
     `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('This is a description'));
     });
@@ -137,7 +140,7 @@ describe('Generates enum documentation', () => {
       }
     `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('Custom Tag'));
       assertEither(result, (data) => expect(data).firstDocContains('My Value'));
@@ -154,7 +157,7 @@ describe('Generates enum documentation', () => {
       }
     `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('Group'));
       assertEither(result, (data) => expect(data).firstDocContains('MyGroup'));
@@ -171,7 +174,7 @@ describe('Generates enum documentation', () => {
       }
     `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('Author'));
       assertEither(result, (data) => expect(data).firstDocContains('John Doe'));
@@ -188,7 +191,7 @@ describe('Generates enum documentation', () => {
       }
     `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('Date'));
       assertEither(result, (data) => expect(data).firstDocContains('2021-01-01'));
@@ -202,7 +205,7 @@ describe('Generates enum documentation', () => {
       public enum MyEnum {}
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('This is a description'));
     });
@@ -217,7 +220,7 @@ describe('Generates enum documentation', () => {
 
       const input2 = 'public enum EnumRef {}';
 
-      const result = generateDocs([input1, input2]);
+      const result = generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)]);
       expect(result).documentationBundleHasLength(2);
       assertEither(result, (data) => expect(data).firstDocContains('Description'));
       assertEither(result, (data) =>
@@ -233,7 +236,7 @@ describe('Generates enum documentation', () => {
       public enum MyEnum {}
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) =>
         expect(data).firstDocContains(
@@ -252,7 +255,7 @@ describe('Generates enum documentation', () => {
 
       const input2 = 'public enum EnumRef {}';
 
-      const result = generateDocs([input1, input2]);
+      const result = 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)'));
@@ -266,7 +269,7 @@ describe('Generates enum documentation', () => {
       public enum MyEnum {}
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('See'));
       assertEither(result, (data) => expect(data).firstDocContains('EnumRef'));
@@ -277,7 +280,7 @@ describe('Generates enum documentation', () => {
       public enum MyEnum {}
       `;
 
-      const result = generateDocs([input], { namespace: 'MyNamespace' });
+      const result = generateDocs([apexBundleFromRawString(input)], { namespace: 'MyNamespace' });
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('## Namespace'));
       assertEither(result, (data) => expect(data).firstDocContains('MyNamespace'));
@@ -288,7 +291,7 @@ describe('Generates enum documentation', () => {
       public enum MyEnum {}
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContainsNot('## Namespace'));
     });
@@ -309,7 +312,7 @@ describe('Generates enum documentation', () => {
       }
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('```mermaid'));
       assertEither(result, (data) => expect(data).firstDocContains('graph TD'));
@@ -331,7 +334,7 @@ describe('Generates enum documentation', () => {
       }
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('```apex'));
       assertEither(result, (data) => expect(data).firstDocContains('public class MyClass'));
@@ -345,7 +348,7 @@ describe('Generates enum documentation', () => {
       }
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('## Values'));
       assertEither(result, (data) => expect(data).firstDocContains('VALUE1'));