@cparra/apexdocs 2.25.0-alpha.2 → 2.25.0-alpha.4

package/src/__spec__/core/generating-interface-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(() => {
@@ -13,7 +14,7 @@ describe('Generates interface documentation', () => {
       }
      `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       assertEither(result, (data) => expect(data.format).toBe('markdown'));
     });
 
@@ -23,7 +24,7 @@ describe('Generates interface documentation', () => {
       }
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data.docs[0].typeName).toBe('MyInterface'));
     });
@@ -34,7 +35,7 @@ describe('Generates interface documentation', () => {
       }
       `;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data.docs[0].type).toBe('interface'));
     });
@@ -48,7 +49,9 @@ describe('Generates interface documentation', () => {
         public interface AnotherInterface {}
       `;
 
-      const result = generateDocs([input1, input2], { scope: ['global'] });
+      const result = generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)], {
+        scope: ['global'],
+      });
       expect(result).documentationBundleHasLength(1);
     });
 
@@ -59,7 +62,7 @@ describe('Generates interface documentation', () => {
         */
       public interface MyInterface {}`;
 
-      const result = generateDocs([input]);
+      const result = generateDocs([apexBundleFromRawString(input)]);
       expect(result).documentationBundleHasLength(0);
     });
 
@@ -72,7 +75,7 @@ describe('Generates interface documentation', () => {
         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'));
     });
@@ -86,7 +89,7 @@ describe('Generates interface documentation', () => {
       `;
 
         const output = `# MyInterface Interface`;
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains(output));
       });
@@ -100,7 +103,7 @@ 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'));
@@ -114,7 +117,7 @@ describe('Generates interface documentation', () => {
           public interface MyInterface {}
          `;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('This is a description'));
       });
@@ -127,7 +130,7 @@ describe('Generates interface documentation', () => {
           public interface MyInterface {}
         `;
 
-        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'));
@@ -140,7 +143,7 @@ describe('Generates interface documentation', () => {
            */
           public interface MyInterface {}`;
 
-        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'));
@@ -153,7 +156,7 @@ describe('Generates interface documentation', () => {
            */
           public interface MyInterface {}`;
 
-        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'));
@@ -166,7 +169,7 @@ describe('Generates interface documentation', () => {
            */
           public interface MyInterface {}`;
 
-        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'));
@@ -179,7 +182,7 @@ describe('Generates interface documentation', () => {
             */
           public interface MyInterface {}`;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('This is a description'));
       });
@@ -194,7 +197,7 @@ describe('Generates interface documentation', () => {
 
         const input2 = 'public interface InterfaceRef {}';
 
-        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 [InterfaceRef](./InterfaceRef.md) reference'),
@@ -209,7 +212,7 @@ describe('Generates interface documentation', () => {
           public interface MyInterface {}
           `;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) =>
           expect(data).firstDocContains(
@@ -228,7 +231,7 @@ describe('Generates interface documentation', () => {
 
         const input2 = 'public interface InterfaceRef {}';
 
-        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('[InterfaceRef](./InterfaceRef.md)'));
@@ -242,7 +245,7 @@ describe('Generates interface documentation', () => {
           public interface MyInterface {}
           `;
 
-        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('InterfaceRef'));
@@ -251,7 +254,7 @@ describe('Generates interface documentation', () => {
       it('displays the namespace if present in the config', () => {
         const input = 'public interface MyInterface {}';
 
-        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'));
@@ -260,7 +263,7 @@ describe('Generates interface documentation', () => {
       it('does not display the namespace if not present in the config', () => {
         const input = 'public interface MyInterface {}';
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContainsNot('## Namespace'));
       });
@@ -278,7 +281,7 @@ describe('Generates interface documentation', () => {
           public interface MyInterface {}
           `;
 
-        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'));
@@ -296,7 +299,7 @@ describe('Generates interface documentation', () => {
             */
           public interface MyInterface {}`;
 
-        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'));
@@ -311,7 +314,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'));
       });
@@ -331,7 +334,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'));
@@ -352,7 +355,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'));
@@ -365,7 +368,7 @@ describe('Generates interface documentation', () => {
         }
       `;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('### Signature'));
       });
@@ -377,7 +380,7 @@ describe('Generates interface documentation', () => {
         }
       `;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('### Parameters'));
       });
@@ -389,7 +392,7 @@ describe('Generates interface documentation', () => {
         }
       `;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('### Return Type'));
       });
@@ -404,7 +407,7 @@ describe('Generates interface documentation', () => {
         }
       `;
 
-        const result = generateDocs([input]);
+        const result = generateDocs([apexBundleFromRawString(input)]);
         expect(result).documentationBundleHasLength(1);
         assertEither(result, (data) => expect(data).firstDocContains('### Throws'));
       });
@@ -420,7 +423,7 @@ describe('Generates interface documentation', () => {
         public interface AnotherInterface extends MyInterface {}
       `;
 
-        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 === 'AnotherInterface')?.docContents).toContain('Inherited'),

package/src/__spec__/core/generating-reference-guide.spec.ts

@@ -2,6 +2,7 @@ import { assertEither, extendExpect } from './expect-extensions';
 import { generateDocs } from '../../core/generate-docs';
 import { pipe } from 'fp-ts/function';
 import * as E from 'fp-ts/Either';
+import { apexBundleFromRawString } from './test-helpers';
 
 describe('Generates a Reference Guide', () => {
   beforeAll(() => {
@@ -20,7 +21,7 @@ describe('Generates a Reference Guide', () => {
       public class MyClass {}
       `;
 
-    const result = generateDocs([input1, input2]);
+    const result = generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)]);
     expect(result).documentationBundleHasLength(2);
 
     assertEither(result, (data) => expect(data.referenceGuide).toContain('[MyEnum](./Miscellaneous/MyEnum.md)'));
@@ -35,7 +36,7 @@ describe('Generates a Reference Guide', () => {
       }
       `;
 
-    const result = generateDocs([input]);
+    const result = generateDocs([apexBundleFromRawString(input)]);
     expect(result).documentationBundleHasLength(1);
     assertEither(result, (data) => expect(data.referenceGuide).toContain('## Miscellaneous'));
   });
@@ -51,7 +52,7 @@ describe('Generates a Reference Guide', () => {
       }
       `;
 
-    const result = generateDocs([input]);
+    const result = generateDocs([apexBundleFromRawString(input)]);
     expect(result).documentationBundleHasLength(1);
     assertEither(result, (data) => expect(data.referenceGuide).toContain('## MyGroup'));
   });
@@ -74,7 +75,7 @@ describe('Generates a Reference Guide', () => {
       public class MyClass {}
       `;
 
-    const result = generateDocs([input1, input2]);
+    const result = generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)]);
     expect(result).documentationBundleHasLength(2);
     pipe(
       result,
@@ -107,7 +108,7 @@ describe('Generates a Reference Guide', () => {
       public class MyClass {}
       `;
 
-    const result = generateDocs([input1, input2]);
+    const result = generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)]);
     expect(result).documentationBundleHasLength(2);
     assertEither(result, (data) => expect(data.referenceGuide).toContain('## Group1'));
     assertEither(result, (data) => expect(data.referenceGuide).toContain('MyClass'));
@@ -132,7 +133,7 @@ describe('Generates a Reference Guide', () => {
       public class MyClass {}
       `;
 
-    const result = generateDocs([input1, input2]);
+    const result = generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)]);
     expect(result).documentationBundleHasLength(2);
     assertEither(result, (data) => expect(data.referenceGuide).toContain('This is a description'));
   });
@@ -156,7 +157,7 @@ describe('Generates a Reference Guide', () => {
       public class MyClass {}
       `;
 
-    const result = generateDocs([input1, input2]);
+    const result = generateDocs([apexBundleFromRawString(input1), apexBundleFromRawString(input2)]);
     expect(result).documentationBundleHasLength(2);
     assertEither(result, (data) => expect(data.referenceGuide).toContain('with a [MyClass](./Group2/MyClass.md)'));
   });

package/src/__spec__/core/test-helpers.ts

@@ -0,0 +1,9 @@
+import ApexBundle from '../../core/apex-bundle';
+
+export function apexBundleFromRawString(raw: string, rawMetadata?: string): ApexBundle {
+  return {
+    filePath: 'test.cls',
+    rawTypeContent: raw,
+    rawMetadataContent: rawMetadata ?? null,
+  };
+}

package/src/application/Apexdocs.ts

@@ -8,11 +8,13 @@ import { Settings, TargetFile } from '../settings';
 import Transpiler from '../transpiler/transpiler';
 import { FileWriter } from '../service/file-writer';
 import ErrorLogger from '../util/error-logger';
-import ApexBundle from '../model/apex-bundle';
-import Manifest from '../model/manifest';
+import ApexBundle from '../core/apex-bundle';
+import Manifest from '../core/manifest';
 import { TypesRepository } from '../model/types-repository';
 import { TypeTranspilerFactory } from '../transpiler/factory';
-import { generateMarkdownFiles } from './flows/generate-markdown-files';
+import { generateMarkdownFiles } from './generators/generate-markdown-files';
+import { AllConfigurableOptions } from '../cli/args';
+import { GeneratorChoices } from '../transpiler/generator-choices';
 
 /**
  * Application entry-point to generate documentation out of Apex source files.
@@ -21,8 +23,9 @@ export class Apexdocs {
   /**
    * Generates documentation out of Apex source files.
    */
-  static generate(): void {
-    Logger.log('Initializing...');
+  static generate(config: AllConfigurableOptions): void {
+    Logger.logSingle('Initializing...', false);
+    this.initializeSettings(config);
     const fileBodies = ApexFileReader.processFiles(new DefaultFileSystem());
 
     if (Settings.getInstance().targetGenerator === 'plain-markdown') {
@@ -49,6 +52,32 @@ export class Apexdocs {
     }
   }
 
+  private static initializeSettings(argv: AllConfigurableOptions) {
+    const targetGenerator = argv.targetGenerator as GeneratorChoices;
+    Settings.build({
+      sourceDirectory: argv.sourceDir,
+      scope: argv.scope,
+      outputDir: argv.targetDir,
+      targetGenerator: targetGenerator,
+      indexOnly: argv.indexOnly,
+      defaultGroupName: argv.defaultGroupName,
+      openApiTitle: argv.openApiTitle,
+      title: argv.title,
+      namespace: argv.namespace,
+      openApiFileName: argv.openApiFileName,
+      sortMembersAlphabetically: argv.sortMembersAlphabetically,
+      includeMetadata: argv.includeMetadata,
+      rootDir: argv.documentationRootDir,
+      onAfterProcess: argv.onAfterProcess,
+      onBeforeFileWrite: argv.onBeforeFileWrite,
+      frontMatterHeader: argv.frontMatterHeader,
+      linkingStrategy:
+        targetGenerator === 'plain-markdown'
+          ? 'path-relative'
+          : TypeTranspilerFactory.get(targetGenerator).getLinkingStrategy(),
+    });
+  }
+
   private static filterByScopes(manifest: Manifest) {
     let filteredTypes: Type[];
     let filteredLogMessage;

package/src/application/{flows → generators}/generate-markdown-files.ts

@@ -1,6 +1,6 @@
-import ApexBundle from '../../model/apex-bundle';
+import ApexBundle from '../../core/apex-bundle';
 import { Settings, TargetFile } from '../../settings';
-import { DocumentationBundle, generateDocs } from '../../core/generate-docs';
+import { DocumentationBundle, generateDocs, ReflectionError } from '../../core/generate-docs';
 import { MarkdownFile } from '../../model/markdown-file';
 import { FileWriter } from '../../service/file-writer';
 import { Logger } from '../../util/logger';
@@ -12,21 +12,23 @@ export const generateMarkdownFiles = flow(
   E.map(convertToMarkdownFiles),
   E.map(writeFilesToSystem),
   E.mapLeft((errors) => {
-    Logger.error(errors.join('\n'));
+    const errorMessages = [
+      'Error(s) occurred while parsing files. Please review the following issues:',
+      ...errors.map(formatReflectionError),
+    ].join('\n');
+
+    Logger.error(errorMessages);
   }),
 );
 
 function generateDocumentationBundle(bundles: ApexBundle[]) {
-  return generateDocs(
-    bundles.map((file) => file.rawTypeContent),
-    {
-      scope: Settings.getInstance().scope,
-      outputDir: Settings.getInstance().outputDir,
-      namespace: Settings.getInstance().getNamespace(),
-      sortMembersAlphabetically: Settings.getInstance().sortMembersAlphabetically(),
-      defaultGroupName: Settings.getInstance().getDefaultGroupName(),
-    },
-  );
+  return generateDocs(bundles, {
+    scope: Settings.getInstance().scope,
+    outputDir: Settings.getInstance().outputDir,
+    namespace: Settings.getInstance().getNamespace(),
+    sortMembersAlphabetically: Settings.getInstance().sortMembersAlphabetically(),
+    defaultGroupName: Settings.getInstance().getDefaultGroupName(),
+  });
 }
 
 function convertToMarkdownFiles(docBundle: DocumentationBundle): MarkdownFile[] {
@@ -45,3 +47,7 @@ function writeFilesToSystem(files: MarkdownFile[]) {
     Logger.logSingle(`${file.name} processed.`, false, 'green', false);
   });
 }
+
+function formatReflectionError(error: ReflectionError) {
+  return `Source file: ${error.file}\n${error.message}\n`;
+}

package/src/cli/args.ts

@@ -0,0 +1,138 @@
+import { Settings } from '../settings';
+import { cosmiconfig, CosmiconfigResult } from 'cosmiconfig';
+import * as yargs from 'yargs';
+
+type OnlyConfigurableThroughFile = {
+  onAfterProcess: Settings['onAfterProcess'];
+  onBeforeFileWrite: Settings['onBeforeFileWrite'];
+  frontMatterHeader: Settings['frontMatterHeader'];
+};
+
+type YargsArgs = ReturnType<typeof _extractYargs>;
+
+type ConfigurableThroughFile = YargsArgs & OnlyConfigurableThroughFile;
+
+export type AllConfigurableOptions = Partial<ConfigurableThroughFile> & YargsArgs;
+
+/**
+ * Extracts configuration from a configuration file or the package.json
+ * through cosmiconfig.
+ */
+function _extractConfig(): Promise<CosmiconfigResult> {
+  return cosmiconfig('apexdocs').search();
+}
+
+/**
+ * Extracts arguments from the command line.
+ * @param config The configuration object from the configuration file, if any.
+ */
+function _extractYargs(config?: CosmiconfigResult) {
+  return yargs
+    .config(config?.config)
+    .options({
+      sourceDir: {
+        type: 'string',
+        alias: 's',
+        demandOption: true,
+        describe: 'The directory location which contains your apex .cls classes.',
+      },
+      targetDir: {
+        type: 'string',
+        alias: 't',
+        default: './docs/',
+        describe: 'The directory location where documentation will be generated to.',
+      },
+      recursive: {
+        type: 'boolean',
+        alias: 'r',
+        default: true,
+        deprecated: 'This option is no longer needed as the recursive search is always on.',
+        describe: 'Whether .cls classes will be searched for recursively in the directory provided.',
+      },
+      scope: {
+        type: 'string',
+        array: true,
+        alias: 'p',
+        default: ['global'],
+        describe:
+          'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
+          'Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled. ' +
+          'Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource.',
+      },
+      targetGenerator: {
+        type: 'string',
+        alias: 'g',
+        default: 'jekyll',
+        choices: ['jekyll', 'docsify', 'plain-markdown', 'openapi'],
+        describe:
+          'Define the static file generator for which the documents will be created. ' +
+          'Currently supports jekyll, docsify, plain markdown, and OpenAPI v3.1.0.',
+      },
+      indexOnly: {
+        type: 'boolean',
+        default: false,
+        describe: 'Defines whether only the index file should be generated.',
+      },
+      defaultGroupName: {
+        type: 'string',
+        default: 'Miscellaneous',
+        describe: 'Defines the @group name to be used when a file does not specify it.',
+      },
+      sanitizeHtml: {
+        type: 'boolean',
+        default: true,
+        deprecated: 'This option is no longer needed as the sanitization is always on.',
+        describe:
+          'When on, any special character within your ApexDocs is converted into its HTML code representation. ' +
+          'This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" ' +
+          'because otherwise the content within < and > would be treated as HTML tags and not shown in the output. ' +
+          'Content in @example blocks are never sanitized.',
+      },
+      openApiTitle: {
+        type: 'string',
+        default: 'Apex REST Api',
+        describe: 'If using "openapi" as the target generator, this allows you to specify the OpenApi title value.',
+      },
+      title: {
+        type: 'string',
+        describe: "Allows you to specify the title of the generated documentation's home file.",
+        default: 'Classes',
+      },
+      namespace: {
+        type: 'string',
+        describe:
+          'The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. ' +
+          "If generating an OpenApi definition, it will be added to the file's Server Url.",
+      },
+      openApiFileName: {
+        type: 'string',
+        describe: 'If using "openapi" as the target generator, this allows you to specify the name of the output file.',
+        default: 'openapi',
+      },
+      sortMembersAlphabetically: {
+        type: 'boolean',
+        describe: 'Whether to sort members alphabetically.',
+        default: false,
+      },
+      includeMetadata: {
+        type: 'boolean',
+        describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
+        default: false,
+      },
+      documentationRootDir: {
+        type: 'string',
+        describe:
+          'Allows you to specify the root documentation directory where the files are being generated. This can be helpful when embedding the generated docs into an existing site so that the links are generated correctly.',
+      },
+    })
+    .parseSync();
+}
+
+/**
+ * Combines the extracted configuration and arguments.
+ */
+export async function extractArgs(): Promise<AllConfigurableOptions> {
+  const config = await _extractConfig();
+  const cliArgs = _extractYargs(config);
+  return { ...config?.config, ...cliArgs };
+}